[96cbb53] | 1 | |
---|
| 2 | |
---|
| 3 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
| 4 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
| 5 | |
---|
| 6 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 7 | <head> |
---|
| 8 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 9 | |
---|
| 10 | <title>utils — guiframe v0.1.0 documentation</title> |
---|
| 11 | <link rel="stylesheet" href="../_static/default.css" type="text/css" /> |
---|
| 12 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
---|
| 13 | <script type="text/javascript"> |
---|
| 14 | var DOCUMENTATION_OPTIONS = { |
---|
| 15 | URL_ROOT: '../', |
---|
| 16 | VERSION: '0.1.0', |
---|
| 17 | COLLAPSE_INDEX: false, |
---|
| 18 | FILE_SUFFIX: '.html', |
---|
| 19 | HAS_SOURCE: true |
---|
| 20 | }; |
---|
| 21 | </script> |
---|
| 22 | <script type="text/javascript" src="../_static/jquery.js"></script> |
---|
| 23 | <script type="text/javascript" src="../_static/underscore.js"></script> |
---|
| 24 | <script type="text/javascript" src="../_static/doctools.js"></script> |
---|
| 25 | <link rel="top" title="guiframe v0.1.0 documentation" href="../index.html" /> |
---|
| 26 | <link rel="up" title="Reference" href="index.html" /> |
---|
| 27 | <link rel="next" title="version" href="version.html" /> |
---|
| 28 | <link rel="prev" title="state_reader" href="state_reader.html" /> |
---|
| 29 | </head> |
---|
| 30 | <body> |
---|
| 31 | <div class="related"> |
---|
| 32 | <h3>Navigation</h3> |
---|
| 33 | <ul> |
---|
| 34 | <li class="right" style="margin-right: 10px"> |
---|
| 35 | <a href="../genindex.html" title="General Index" |
---|
| 36 | accesskey="I">index</a></li> |
---|
| 37 | <li class="right" > |
---|
| 38 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 39 | >modules</a> |</li> |
---|
| 40 | <li class="right" > |
---|
| 41 | <a href="version.html" title="version" |
---|
| 42 | accesskey="N">next</a> |</li> |
---|
| 43 | <li class="right" > |
---|
| 44 | <a href="state_reader.html" title="state_reader" |
---|
| 45 | accesskey="P">previous</a> |</li> |
---|
| 46 | <li><a href="../index.html">guiframe v0.1.0 documentation</a> »</li> |
---|
| 47 | <li><a href="index.html" accesskey="U">Reference</a> »</li> |
---|
| 48 | </ul> |
---|
| 49 | </div> |
---|
| 50 | |
---|
| 51 | <div class="document"> |
---|
| 52 | <div class="documentwrapper"> |
---|
| 53 | <div class="bodywrapper"> |
---|
| 54 | <div class="body"> |
---|
| 55 | |
---|
| 56 | <div class="section" id="utils"> |
---|
| 57 | <h1>utils<a class="headerlink" href="#utils" title="Permalink to this headline">¶</a></h1> |
---|
| 58 | <div class="section" id="module-sans.guiframe.utils"> |
---|
| 59 | <span id="sans-guiframe-utils"></span><h2><a class="reference internal" href="#module-sans.guiframe.utils" title="sans.guiframe.utils"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.utils</span></tt></a><a class="headerlink" href="#module-sans.guiframe.utils" title="Permalink to this headline">¶</a></h2> |
---|
| 60 | <p>Contains common classes and functions</p> |
---|
| 61 | <dl class="class"> |
---|
| 62 | <dt id="sans.guiframe.utils.PanelMenu"> |
---|
| 63 | <em class="property">class </em><tt class="descclassname">sans.guiframe.utils.</tt><tt class="descname">PanelMenu</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu" title="Permalink to this definition">¶</a></dt> |
---|
| 64 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.Menu</span></tt></p> |
---|
| 65 | <dl class="method"> |
---|
| 66 | <dt id="sans.guiframe.utils.PanelMenu.AddPendingEvent"> |
---|
| 67 | <tt class="descname">AddPendingEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.AddPendingEvent" title="Permalink to this definition">¶</a></dt> |
---|
| 68 | <dd><p>AddPendingEvent(self, Event event)</p> |
---|
| 69 | </dd></dl> |
---|
| 70 | |
---|
| 71 | <dl class="method"> |
---|
| 72 | <dt id="sans.guiframe.utils.PanelMenu.Append"> |
---|
| 73 | <tt class="descname">Append</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Append" title="Permalink to this definition">¶</a></dt> |
---|
| 74 | <dd><dl class="docutils"> |
---|
| 75 | <dt>Append(self, int id, String text=EmptyString, String help=EmptyString, </dt> |
---|
| 76 | <dd>int kind=ITEM_NORMAL) -> MenuItem</dd> |
---|
| 77 | </dl> |
---|
| 78 | </dd></dl> |
---|
| 79 | |
---|
| 80 | <dl class="method"> |
---|
| 81 | <dt id="sans.guiframe.utils.PanelMenu.AppendCheckItem"> |
---|
| 82 | <tt class="descname">AppendCheckItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.AppendCheckItem" title="Permalink to this definition">¶</a></dt> |
---|
| 83 | <dd><p>AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem</p> |
---|
| 84 | </dd></dl> |
---|
| 85 | |
---|
| 86 | <dl class="method"> |
---|
| 87 | <dt id="sans.guiframe.utils.PanelMenu.AppendItem"> |
---|
| 88 | <tt class="descname">AppendItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.AppendItem" title="Permalink to this definition">¶</a></dt> |
---|
| 89 | <dd><p>AppendItem(self, MenuItem item) -> MenuItem</p> |
---|
| 90 | </dd></dl> |
---|
| 91 | |
---|
| 92 | <dl class="method"> |
---|
| 93 | <dt id="sans.guiframe.utils.PanelMenu.AppendMenu"> |
---|
| 94 | <tt class="descname">AppendMenu</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.AppendMenu" title="Permalink to this definition">¶</a></dt> |
---|
| 95 | <dd><p>AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</p> |
---|
| 96 | </dd></dl> |
---|
| 97 | |
---|
| 98 | <dl class="method"> |
---|
| 99 | <dt id="sans.guiframe.utils.PanelMenu.AppendRadioItem"> |
---|
| 100 | <tt class="descname">AppendRadioItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.AppendRadioItem" title="Permalink to this definition">¶</a></dt> |
---|
| 101 | <dd><p>AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem</p> |
---|
| 102 | </dd></dl> |
---|
| 103 | |
---|
| 104 | <dl class="method"> |
---|
| 105 | <dt id="sans.guiframe.utils.PanelMenu.AppendSeparator"> |
---|
| 106 | <tt class="descname">AppendSeparator</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.AppendSeparator" title="Permalink to this definition">¶</a></dt> |
---|
| 107 | <dd><p>AppendSeparator(self) -> MenuItem</p> |
---|
| 108 | </dd></dl> |
---|
| 109 | |
---|
| 110 | <dl class="method"> |
---|
| 111 | <dt id="sans.guiframe.utils.PanelMenu.AppendSubMenu"> |
---|
| 112 | <tt class="descname">AppendSubMenu</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.AppendSubMenu" title="Permalink to this definition">¶</a></dt> |
---|
| 113 | <dd><p>AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem</p> |
---|
| 114 | </dd></dl> |
---|
| 115 | |
---|
| 116 | <dl class="method"> |
---|
| 117 | <dt id="sans.guiframe.utils.PanelMenu.Attach"> |
---|
| 118 | <tt class="descname">Attach</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Attach" title="Permalink to this definition">¶</a></dt> |
---|
| 119 | <dd><p>Attach(self, wxMenuBarBase menubar)</p> |
---|
| 120 | </dd></dl> |
---|
| 121 | |
---|
| 122 | <dl class="method"> |
---|
| 123 | <dt id="sans.guiframe.utils.PanelMenu.Bind"> |
---|
| 124 | <tt class="descname">Bind</tt><big>(</big><em>event</em>, <em>handler</em>, <em>source=None</em>, <em>id=-1</em>, <em>id2=-1</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Bind" title="Permalink to this definition">¶</a></dt> |
---|
| 125 | <dd><p>Bind an event to an event handler.</p> |
---|
| 126 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 127 | <col class="field-name" /> |
---|
| 128 | <col class="field-body" /> |
---|
| 129 | <tbody valign="top"> |
---|
| 130 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 131 | <li><strong>event</strong> – One of the EVT_* objects that specifies the |
---|
| 132 | type of event to bind,</li> |
---|
| 133 | <li><strong>handler</strong> – A callable object to be invoked when the |
---|
| 134 | event is delivered to self. Pass None to |
---|
| 135 | disconnect an event handler.</li> |
---|
| 136 | <li><strong>source</strong> – Sometimes the event originates from a |
---|
| 137 | different window than self, but you still |
---|
| 138 | want to catch it in self. (For example, a |
---|
| 139 | button event delivered to a frame.) By |
---|
| 140 | passing the source of the event, the event |
---|
| 141 | handling system is able to differentiate |
---|
| 142 | between the same event type from different |
---|
| 143 | controls.</li> |
---|
| 144 | <li><strong>id</strong> – Used to spcify the event source by ID instead |
---|
| 145 | of instance.</li> |
---|
| 146 | <li><strong>id2</strong> – Used when it is desirable to bind a handler |
---|
| 147 | to a range of IDs, such as with EVT_MENU_RANGE.</li> |
---|
| 148 | </ul> |
---|
| 149 | </td> |
---|
| 150 | </tr> |
---|
| 151 | </tbody> |
---|
| 152 | </table> |
---|
| 153 | </dd></dl> |
---|
| 154 | |
---|
| 155 | <dl class="method"> |
---|
| 156 | <dt id="sans.guiframe.utils.PanelMenu.Break"> |
---|
| 157 | <tt class="descname">Break</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Break" title="Permalink to this definition">¶</a></dt> |
---|
| 158 | <dd><p>Break(self)</p> |
---|
| 159 | </dd></dl> |
---|
| 160 | |
---|
| 161 | <dl class="method"> |
---|
| 162 | <dt id="sans.guiframe.utils.PanelMenu.Check"> |
---|
| 163 | <tt class="descname">Check</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Check" title="Permalink to this definition">¶</a></dt> |
---|
| 164 | <dd><p>Check(self, int id, bool check)</p> |
---|
| 165 | </dd></dl> |
---|
| 166 | |
---|
| 167 | <dl class="attribute"> |
---|
| 168 | <dt id="sans.guiframe.utils.PanelMenu.ClassName"> |
---|
| 169 | <tt class="descname">ClassName</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.ClassName" title="Permalink to this definition">¶</a></dt> |
---|
| 170 | <dd><p>See <cite>GetClassName</cite></p> |
---|
| 171 | </dd></dl> |
---|
| 172 | |
---|
| 173 | <dl class="method"> |
---|
| 174 | <dt id="sans.guiframe.utils.PanelMenu.Connect"> |
---|
| 175 | <tt class="descname">Connect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Connect" title="Permalink to this definition">¶</a></dt> |
---|
| 176 | <dd><p>Connect(self, int id, int lastId, int eventType, PyObject func)</p> |
---|
| 177 | </dd></dl> |
---|
| 178 | |
---|
| 179 | <dl class="method"> |
---|
| 180 | <dt id="sans.guiframe.utils.PanelMenu.Delete"> |
---|
| 181 | <tt class="descname">Delete</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Delete" title="Permalink to this definition">¶</a></dt> |
---|
| 182 | <dd><p>Delete(self, int id) -> bool</p> |
---|
| 183 | </dd></dl> |
---|
| 184 | |
---|
| 185 | <dl class="method"> |
---|
| 186 | <dt id="sans.guiframe.utils.PanelMenu.DeleteItem"> |
---|
| 187 | <tt class="descname">DeleteItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.DeleteItem" title="Permalink to this definition">¶</a></dt> |
---|
| 188 | <dd><p>DeleteItem(self, MenuItem item) -> bool</p> |
---|
| 189 | </dd></dl> |
---|
| 190 | |
---|
| 191 | <dl class="method"> |
---|
| 192 | <dt id="sans.guiframe.utils.PanelMenu.Destroy"> |
---|
| 193 | <tt class="descname">Destroy</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Destroy" title="Permalink to this definition">¶</a></dt> |
---|
| 194 | <dd><p>Destroy(self)</p> |
---|
| 195 | <p>Deletes the C++ object this Python object is a proxy for.</p> |
---|
| 196 | </dd></dl> |
---|
| 197 | |
---|
| 198 | <dl class="method"> |
---|
| 199 | <dt id="sans.guiframe.utils.PanelMenu.DestroyId"> |
---|
| 200 | <tt class="descname">DestroyId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.DestroyId" title="Permalink to this definition">¶</a></dt> |
---|
| 201 | <dd><p>DestroyId(self, int id) -> bool</p> |
---|
| 202 | </dd></dl> |
---|
| 203 | |
---|
| 204 | <dl class="method"> |
---|
| 205 | <dt id="sans.guiframe.utils.PanelMenu.DestroyItem"> |
---|
| 206 | <tt class="descname">DestroyItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.DestroyItem" title="Permalink to this definition">¶</a></dt> |
---|
| 207 | <dd><p>DestroyItem(self, MenuItem item) -> bool</p> |
---|
| 208 | </dd></dl> |
---|
| 209 | |
---|
| 210 | <dl class="method"> |
---|
| 211 | <dt id="sans.guiframe.utils.PanelMenu.Detach"> |
---|
| 212 | <tt class="descname">Detach</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Detach" title="Permalink to this definition">¶</a></dt> |
---|
| 213 | <dd><p>Detach(self)</p> |
---|
| 214 | </dd></dl> |
---|
| 215 | |
---|
| 216 | <dl class="method"> |
---|
| 217 | <dt id="sans.guiframe.utils.PanelMenu.Disconnect"> |
---|
| 218 | <tt class="descname">Disconnect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Disconnect" title="Permalink to this definition">¶</a></dt> |
---|
| 219 | <dd><dl class="docutils"> |
---|
| 220 | <dt>Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, </dt> |
---|
| 221 | <dd>PyObject func=None) -> bool</dd> |
---|
| 222 | </dl> |
---|
| 223 | </dd></dl> |
---|
| 224 | |
---|
| 225 | <dl class="method"> |
---|
| 226 | <dt id="sans.guiframe.utils.PanelMenu.Enable"> |
---|
| 227 | <tt class="descname">Enable</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Enable" title="Permalink to this definition">¶</a></dt> |
---|
| 228 | <dd><p>Enable(self, int id, bool enable)</p> |
---|
| 229 | </dd></dl> |
---|
| 230 | |
---|
| 231 | <dl class="attribute"> |
---|
| 232 | <dt id="sans.guiframe.utils.PanelMenu.EventHandler"> |
---|
| 233 | <tt class="descname">EventHandler</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.EventHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 234 | <dd><p>See <cite>GetEventHandler</cite> and <cite>SetEventHandler</cite></p> |
---|
| 235 | </dd></dl> |
---|
| 236 | |
---|
| 237 | <dl class="attribute"> |
---|
| 238 | <dt id="sans.guiframe.utils.PanelMenu.EvtHandlerEnabled"> |
---|
| 239 | <tt class="descname">EvtHandlerEnabled</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.EvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> |
---|
| 240 | <dd><p>See <cite>GetEvtHandlerEnabled</cite> and <cite>SetEvtHandlerEnabled</cite></p> |
---|
| 241 | </dd></dl> |
---|
| 242 | |
---|
| 243 | <dl class="method"> |
---|
| 244 | <dt id="sans.guiframe.utils.PanelMenu.FindItem"> |
---|
| 245 | <tt class="descname">FindItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.FindItem" title="Permalink to this definition">¶</a></dt> |
---|
| 246 | <dd><p>FindItem(self, String item) -> int</p> |
---|
| 247 | </dd></dl> |
---|
| 248 | |
---|
| 249 | <dl class="method"> |
---|
| 250 | <dt id="sans.guiframe.utils.PanelMenu.FindItemById"> |
---|
| 251 | <tt class="descname">FindItemById</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.FindItemById" title="Permalink to this definition">¶</a></dt> |
---|
| 252 | <dd><p>FindItemById(self, int id) -> MenuItem</p> |
---|
| 253 | </dd></dl> |
---|
| 254 | |
---|
| 255 | <dl class="method"> |
---|
| 256 | <dt id="sans.guiframe.utils.PanelMenu.FindItemByPosition"> |
---|
| 257 | <tt class="descname">FindItemByPosition</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.FindItemByPosition" title="Permalink to this definition">¶</a></dt> |
---|
| 258 | <dd><p>FindItemByPosition(self, size_t position) -> MenuItem</p> |
---|
| 259 | </dd></dl> |
---|
| 260 | |
---|
| 261 | <dl class="method"> |
---|
| 262 | <dt id="sans.guiframe.utils.PanelMenu.GetClassName"> |
---|
| 263 | <tt class="descname">GetClassName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetClassName" title="Permalink to this definition">¶</a></dt> |
---|
| 264 | <dd><p>GetClassName(self) -> String</p> |
---|
| 265 | <p>Returns the class name of the C++ class using wxRTTI.</p> |
---|
| 266 | </dd></dl> |
---|
| 267 | |
---|
| 268 | <dl class="method"> |
---|
| 269 | <dt id="sans.guiframe.utils.PanelMenu.GetEventHandler"> |
---|
| 270 | <tt class="descname">GetEventHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetEventHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 271 | <dd><p>GetEventHandler(self) -> EvtHandler</p> |
---|
| 272 | </dd></dl> |
---|
| 273 | |
---|
| 274 | <dl class="method"> |
---|
| 275 | <dt id="sans.guiframe.utils.PanelMenu.GetEvtHandlerEnabled"> |
---|
| 276 | <tt class="descname">GetEvtHandlerEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> |
---|
| 277 | <dd><p>GetEvtHandlerEnabled(self) -> bool</p> |
---|
| 278 | </dd></dl> |
---|
| 279 | |
---|
| 280 | <dl class="method"> |
---|
| 281 | <dt id="sans.guiframe.utils.PanelMenu.GetHelpString"> |
---|
| 282 | <tt class="descname">GetHelpString</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetHelpString" title="Permalink to this definition">¶</a></dt> |
---|
| 283 | <dd><p>GetHelpString(self, int id) -> String</p> |
---|
| 284 | </dd></dl> |
---|
| 285 | |
---|
| 286 | <dl class="method"> |
---|
| 287 | <dt id="sans.guiframe.utils.PanelMenu.GetInvokingWindow"> |
---|
| 288 | <tt class="descname">GetInvokingWindow</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetInvokingWindow" title="Permalink to this definition">¶</a></dt> |
---|
| 289 | <dd><p>GetInvokingWindow(self) -> Window</p> |
---|
| 290 | </dd></dl> |
---|
| 291 | |
---|
| 292 | <dl class="method"> |
---|
| 293 | <dt id="sans.guiframe.utils.PanelMenu.GetLabel"> |
---|
| 294 | <tt class="descname">GetLabel</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetLabel" title="Permalink to this definition">¶</a></dt> |
---|
| 295 | <dd><p>GetLabel(self, int id) -> String</p> |
---|
| 296 | </dd></dl> |
---|
| 297 | |
---|
| 298 | <dl class="method"> |
---|
| 299 | <dt id="sans.guiframe.utils.PanelMenu.GetLabelText"> |
---|
| 300 | <tt class="descname">GetLabelText</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetLabelText" title="Permalink to this definition">¶</a></dt> |
---|
| 301 | <dd><p>GetLabelText(self, int itemid) -> String</p> |
---|
| 302 | </dd></dl> |
---|
| 303 | |
---|
| 304 | <dl class="method"> |
---|
| 305 | <dt id="sans.guiframe.utils.PanelMenu.GetMenuBar"> |
---|
| 306 | <tt class="descname">GetMenuBar</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetMenuBar" title="Permalink to this definition">¶</a></dt> |
---|
| 307 | <dd><p>GetMenuBar(self) -> MenuBar</p> |
---|
| 308 | </dd></dl> |
---|
| 309 | |
---|
| 310 | <dl class="method"> |
---|
| 311 | <dt id="sans.guiframe.utils.PanelMenu.GetMenuItemCount"> |
---|
| 312 | <tt class="descname">GetMenuItemCount</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetMenuItemCount" title="Permalink to this definition">¶</a></dt> |
---|
| 313 | <dd><p>GetMenuItemCount(self) -> size_t</p> |
---|
| 314 | </dd></dl> |
---|
| 315 | |
---|
| 316 | <dl class="method"> |
---|
| 317 | <dt id="sans.guiframe.utils.PanelMenu.GetMenuItems"> |
---|
| 318 | <tt class="descname">GetMenuItems</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetMenuItems" title="Permalink to this definition">¶</a></dt> |
---|
| 319 | <dd><p>GetMenuItems(self) -> MenuItemList</p> |
---|
| 320 | </dd></dl> |
---|
| 321 | |
---|
| 322 | <dl class="method"> |
---|
| 323 | <dt id="sans.guiframe.utils.PanelMenu.GetNextHandler"> |
---|
| 324 | <tt class="descname">GetNextHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetNextHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 325 | <dd><p>GetNextHandler(self) -> EvtHandler</p> |
---|
| 326 | </dd></dl> |
---|
| 327 | |
---|
| 328 | <dl class="method"> |
---|
| 329 | <dt id="sans.guiframe.utils.PanelMenu.GetParent"> |
---|
| 330 | <tt class="descname">GetParent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetParent" title="Permalink to this definition">¶</a></dt> |
---|
| 331 | <dd><p>GetParent(self) -> Menu</p> |
---|
| 332 | </dd></dl> |
---|
| 333 | |
---|
| 334 | <dl class="method"> |
---|
| 335 | <dt id="sans.guiframe.utils.PanelMenu.GetPreviousHandler"> |
---|
| 336 | <tt class="descname">GetPreviousHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetPreviousHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 337 | <dd><p>GetPreviousHandler(self) -> EvtHandler</p> |
---|
| 338 | </dd></dl> |
---|
| 339 | |
---|
| 340 | <dl class="method"> |
---|
| 341 | <dt id="sans.guiframe.utils.PanelMenu.GetStyle"> |
---|
| 342 | <tt class="descname">GetStyle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetStyle" title="Permalink to this definition">¶</a></dt> |
---|
| 343 | <dd><p>GetStyle(self) -> long</p> |
---|
| 344 | </dd></dl> |
---|
| 345 | |
---|
| 346 | <dl class="method"> |
---|
| 347 | <dt id="sans.guiframe.utils.PanelMenu.GetTitle"> |
---|
| 348 | <tt class="descname">GetTitle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.GetTitle" title="Permalink to this definition">¶</a></dt> |
---|
| 349 | <dd><p>GetTitle(self) -> String</p> |
---|
| 350 | </dd></dl> |
---|
| 351 | |
---|
| 352 | <dl class="attribute"> |
---|
| 353 | <dt id="sans.guiframe.utils.PanelMenu.HelpString"> |
---|
| 354 | <tt class="descname">HelpString</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.HelpString" title="Permalink to this definition">¶</a></dt> |
---|
| 355 | <dd><p>See <cite>GetHelpString</cite> and <cite>SetHelpString</cite></p> |
---|
| 356 | </dd></dl> |
---|
| 357 | |
---|
| 358 | <dl class="method"> |
---|
| 359 | <dt id="sans.guiframe.utils.PanelMenu.Insert"> |
---|
| 360 | <tt class="descname">Insert</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Insert" title="Permalink to this definition">¶</a></dt> |
---|
| 361 | <dd><dl class="docutils"> |
---|
| 362 | <dt>Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString, </dt> |
---|
| 363 | <dd>int kind=ITEM_NORMAL) -> MenuItem</dd> |
---|
| 364 | </dl> |
---|
| 365 | </dd></dl> |
---|
| 366 | |
---|
| 367 | <dl class="method"> |
---|
| 368 | <dt id="sans.guiframe.utils.PanelMenu.InsertCheckItem"> |
---|
| 369 | <tt class="descname">InsertCheckItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.InsertCheckItem" title="Permalink to this definition">¶</a></dt> |
---|
| 370 | <dd><p>InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem</p> |
---|
| 371 | </dd></dl> |
---|
| 372 | |
---|
| 373 | <dl class="method"> |
---|
| 374 | <dt id="sans.guiframe.utils.PanelMenu.InsertItem"> |
---|
| 375 | <tt class="descname">InsertItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.InsertItem" title="Permalink to this definition">¶</a></dt> |
---|
| 376 | <dd><p>InsertItem(self, size_t pos, MenuItem item) -> MenuItem</p> |
---|
| 377 | </dd></dl> |
---|
| 378 | |
---|
| 379 | <dl class="method"> |
---|
| 380 | <dt id="sans.guiframe.utils.PanelMenu.InsertMenu"> |
---|
| 381 | <tt class="descname">InsertMenu</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.InsertMenu" title="Permalink to this definition">¶</a></dt> |
---|
| 382 | <dd><p>InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</p> |
---|
| 383 | </dd></dl> |
---|
| 384 | |
---|
| 385 | <dl class="method"> |
---|
| 386 | <dt id="sans.guiframe.utils.PanelMenu.InsertRadioItem"> |
---|
| 387 | <tt class="descname">InsertRadioItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.InsertRadioItem" title="Permalink to this definition">¶</a></dt> |
---|
| 388 | <dd><p>InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem</p> |
---|
| 389 | </dd></dl> |
---|
| 390 | |
---|
| 391 | <dl class="method"> |
---|
| 392 | <dt id="sans.guiframe.utils.PanelMenu.InsertSeparator"> |
---|
| 393 | <tt class="descname">InsertSeparator</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.InsertSeparator" title="Permalink to this definition">¶</a></dt> |
---|
| 394 | <dd><p>InsertSeparator(self, size_t pos) -> MenuItem</p> |
---|
| 395 | </dd></dl> |
---|
| 396 | |
---|
| 397 | <dl class="attribute"> |
---|
| 398 | <dt id="sans.guiframe.utils.PanelMenu.InvokingWindow"> |
---|
| 399 | <tt class="descname">InvokingWindow</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.InvokingWindow" title="Permalink to this definition">¶</a></dt> |
---|
| 400 | <dd><p>See <cite>GetInvokingWindow</cite> and <cite>SetInvokingWindow</cite></p> |
---|
| 401 | </dd></dl> |
---|
| 402 | |
---|
| 403 | <dl class="method"> |
---|
| 404 | <dt id="sans.guiframe.utils.PanelMenu.IsAttached"> |
---|
| 405 | <tt class="descname">IsAttached</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.IsAttached" title="Permalink to this definition">¶</a></dt> |
---|
| 406 | <dd><p>IsAttached(self) -> bool</p> |
---|
| 407 | </dd></dl> |
---|
| 408 | |
---|
| 409 | <dl class="method"> |
---|
| 410 | <dt id="sans.guiframe.utils.PanelMenu.IsChecked"> |
---|
| 411 | <tt class="descname">IsChecked</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.IsChecked" title="Permalink to this definition">¶</a></dt> |
---|
| 412 | <dd><p>IsChecked(self, int id) -> bool</p> |
---|
| 413 | </dd></dl> |
---|
| 414 | |
---|
| 415 | <dl class="method"> |
---|
| 416 | <dt id="sans.guiframe.utils.PanelMenu.IsEnabled"> |
---|
| 417 | <tt class="descname">IsEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.IsEnabled" title="Permalink to this definition">¶</a></dt> |
---|
| 418 | <dd><p>IsEnabled(self, int id) -> bool</p> |
---|
| 419 | </dd></dl> |
---|
| 420 | |
---|
| 421 | <dl class="method"> |
---|
| 422 | <dt id="sans.guiframe.utils.PanelMenu.IsSameAs"> |
---|
| 423 | <tt class="descname">IsSameAs</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.IsSameAs" title="Permalink to this definition">¶</a></dt> |
---|
| 424 | <dd><p>IsSameAs(self, Object p) -> bool</p> |
---|
| 425 | <p>For wx.Objects that use C++ reference counting internally, this method |
---|
| 426 | can be used to determine if two objects are referencing the same data |
---|
| 427 | object.</p> |
---|
| 428 | </dd></dl> |
---|
| 429 | |
---|
| 430 | <dl class="attribute"> |
---|
| 431 | <dt id="sans.guiframe.utils.PanelMenu.MenuBar"> |
---|
| 432 | <tt class="descname">MenuBar</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.MenuBar" title="Permalink to this definition">¶</a></dt> |
---|
| 433 | <dd><p>See <cite>GetMenuBar</cite></p> |
---|
| 434 | </dd></dl> |
---|
| 435 | |
---|
| 436 | <dl class="attribute"> |
---|
| 437 | <dt id="sans.guiframe.utils.PanelMenu.MenuItemCount"> |
---|
| 438 | <tt class="descname">MenuItemCount</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.MenuItemCount" title="Permalink to this definition">¶</a></dt> |
---|
| 439 | <dd><p>See <cite>GetMenuItemCount</cite></p> |
---|
| 440 | </dd></dl> |
---|
| 441 | |
---|
| 442 | <dl class="attribute"> |
---|
| 443 | <dt id="sans.guiframe.utils.PanelMenu.MenuItems"> |
---|
| 444 | <tt class="descname">MenuItems</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.MenuItems" title="Permalink to this definition">¶</a></dt> |
---|
| 445 | <dd><p>See <cite>GetMenuItems</cite></p> |
---|
| 446 | </dd></dl> |
---|
| 447 | |
---|
| 448 | <dl class="attribute"> |
---|
| 449 | <dt id="sans.guiframe.utils.PanelMenu.NextHandler"> |
---|
| 450 | <tt class="descname">NextHandler</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.NextHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 451 | <dd><p>See <cite>GetNextHandler</cite> and <cite>SetNextHandler</cite></p> |
---|
| 452 | </dd></dl> |
---|
| 453 | |
---|
| 454 | <dl class="attribute"> |
---|
| 455 | <dt id="sans.guiframe.utils.PanelMenu.Parent"> |
---|
| 456 | <tt class="descname">Parent</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Parent" title="Permalink to this definition">¶</a></dt> |
---|
| 457 | <dd><p>See <cite>GetParent</cite> and <cite>SetParent</cite></p> |
---|
| 458 | </dd></dl> |
---|
| 459 | |
---|
| 460 | <dl class="method"> |
---|
| 461 | <dt id="sans.guiframe.utils.PanelMenu.Prepend"> |
---|
| 462 | <tt class="descname">Prepend</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Prepend" title="Permalink to this definition">¶</a></dt> |
---|
| 463 | <dd><dl class="docutils"> |
---|
| 464 | <dt>Prepend(self, int id, String text=EmptyString, String help=EmptyString, </dt> |
---|
| 465 | <dd>int kind=ITEM_NORMAL) -> MenuItem</dd> |
---|
| 466 | </dl> |
---|
| 467 | </dd></dl> |
---|
| 468 | |
---|
| 469 | <dl class="method"> |
---|
| 470 | <dt id="sans.guiframe.utils.PanelMenu.PrependCheckItem"> |
---|
| 471 | <tt class="descname">PrependCheckItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.PrependCheckItem" title="Permalink to this definition">¶</a></dt> |
---|
| 472 | <dd><p>PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem</p> |
---|
| 473 | </dd></dl> |
---|
| 474 | |
---|
| 475 | <dl class="method"> |
---|
| 476 | <dt id="sans.guiframe.utils.PanelMenu.PrependItem"> |
---|
| 477 | <tt class="descname">PrependItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.PrependItem" title="Permalink to this definition">¶</a></dt> |
---|
| 478 | <dd><p>PrependItem(self, MenuItem item) -> MenuItem</p> |
---|
| 479 | </dd></dl> |
---|
| 480 | |
---|
| 481 | <dl class="method"> |
---|
| 482 | <dt id="sans.guiframe.utils.PanelMenu.PrependMenu"> |
---|
| 483 | <tt class="descname">PrependMenu</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.PrependMenu" title="Permalink to this definition">¶</a></dt> |
---|
| 484 | <dd><p>PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</p> |
---|
| 485 | </dd></dl> |
---|
| 486 | |
---|
| 487 | <dl class="method"> |
---|
| 488 | <dt id="sans.guiframe.utils.PanelMenu.PrependRadioItem"> |
---|
| 489 | <tt class="descname">PrependRadioItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.PrependRadioItem" title="Permalink to this definition">¶</a></dt> |
---|
| 490 | <dd><p>PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem</p> |
---|
| 491 | </dd></dl> |
---|
| 492 | |
---|
| 493 | <dl class="method"> |
---|
| 494 | <dt id="sans.guiframe.utils.PanelMenu.PrependSeparator"> |
---|
| 495 | <tt class="descname">PrependSeparator</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.PrependSeparator" title="Permalink to this definition">¶</a></dt> |
---|
| 496 | <dd><p>PrependSeparator(self) -> MenuItem</p> |
---|
| 497 | </dd></dl> |
---|
| 498 | |
---|
| 499 | <dl class="attribute"> |
---|
| 500 | <dt id="sans.guiframe.utils.PanelMenu.PreviousHandler"> |
---|
| 501 | <tt class="descname">PreviousHandler</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.PreviousHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 502 | <dd><p>See <cite>GetPreviousHandler</cite> and <cite>SetPreviousHandler</cite></p> |
---|
| 503 | </dd></dl> |
---|
| 504 | |
---|
| 505 | <dl class="method"> |
---|
| 506 | <dt id="sans.guiframe.utils.PanelMenu.ProcessEvent"> |
---|
| 507 | <tt class="descname">ProcessEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.ProcessEvent" title="Permalink to this definition">¶</a></dt> |
---|
| 508 | <dd><p>ProcessEvent(self, Event event) -> bool</p> |
---|
| 509 | </dd></dl> |
---|
| 510 | |
---|
| 511 | <dl class="method"> |
---|
| 512 | <dt id="sans.guiframe.utils.PanelMenu.ProcessPendingEvents"> |
---|
| 513 | <tt class="descname">ProcessPendingEvents</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.ProcessPendingEvents" title="Permalink to this definition">¶</a></dt> |
---|
| 514 | <dd><p>ProcessPendingEvents(self)</p> |
---|
| 515 | </dd></dl> |
---|
| 516 | |
---|
| 517 | <dl class="method"> |
---|
| 518 | <dt id="sans.guiframe.utils.PanelMenu.Remove"> |
---|
| 519 | <tt class="descname">Remove</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Remove" title="Permalink to this definition">¶</a></dt> |
---|
| 520 | <dd><p>Remove(self, int id) -> MenuItem</p> |
---|
| 521 | </dd></dl> |
---|
| 522 | |
---|
| 523 | <dl class="method"> |
---|
| 524 | <dt id="sans.guiframe.utils.PanelMenu.RemoveItem"> |
---|
| 525 | <tt class="descname">RemoveItem</tt><big>(</big><em>item</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.RemoveItem" title="Permalink to this definition">¶</a></dt> |
---|
| 526 | <dd><p>RemoveItem(self, MenuItem item) -> MenuItem</p> |
---|
| 527 | </dd></dl> |
---|
| 528 | |
---|
| 529 | <dl class="method"> |
---|
| 530 | <dt id="sans.guiframe.utils.PanelMenu.SetEventHandler"> |
---|
| 531 | <tt class="descname">SetEventHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetEventHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 532 | <dd><p>SetEventHandler(self, EvtHandler handler)</p> |
---|
| 533 | </dd></dl> |
---|
| 534 | |
---|
| 535 | <dl class="method"> |
---|
| 536 | <dt id="sans.guiframe.utils.PanelMenu.SetEvtHandlerEnabled"> |
---|
| 537 | <tt class="descname">SetEvtHandlerEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> |
---|
| 538 | <dd><p>SetEvtHandlerEnabled(self, bool enabled)</p> |
---|
| 539 | </dd></dl> |
---|
| 540 | |
---|
| 541 | <dl class="method"> |
---|
| 542 | <dt id="sans.guiframe.utils.PanelMenu.SetHelpString"> |
---|
| 543 | <tt class="descname">SetHelpString</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetHelpString" title="Permalink to this definition">¶</a></dt> |
---|
| 544 | <dd><p>SetHelpString(self, int id, String helpString)</p> |
---|
| 545 | </dd></dl> |
---|
| 546 | |
---|
| 547 | <dl class="method"> |
---|
| 548 | <dt id="sans.guiframe.utils.PanelMenu.SetInvokingWindow"> |
---|
| 549 | <tt class="descname">SetInvokingWindow</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetInvokingWindow" title="Permalink to this definition">¶</a></dt> |
---|
| 550 | <dd><p>SetInvokingWindow(self, Window win)</p> |
---|
| 551 | </dd></dl> |
---|
| 552 | |
---|
| 553 | <dl class="method"> |
---|
| 554 | <dt id="sans.guiframe.utils.PanelMenu.SetLabel"> |
---|
| 555 | <tt class="descname">SetLabel</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetLabel" title="Permalink to this definition">¶</a></dt> |
---|
| 556 | <dd><p>SetLabel(self, int id, String label)</p> |
---|
| 557 | </dd></dl> |
---|
| 558 | |
---|
| 559 | <dl class="method"> |
---|
| 560 | <dt id="sans.guiframe.utils.PanelMenu.SetNextHandler"> |
---|
| 561 | <tt class="descname">SetNextHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetNextHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 562 | <dd><p>SetNextHandler(self, EvtHandler handler)</p> |
---|
| 563 | </dd></dl> |
---|
| 564 | |
---|
| 565 | <dl class="method"> |
---|
| 566 | <dt id="sans.guiframe.utils.PanelMenu.SetParent"> |
---|
| 567 | <tt class="descname">SetParent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetParent" title="Permalink to this definition">¶</a></dt> |
---|
| 568 | <dd><p>SetParent(self, Menu parent)</p> |
---|
| 569 | </dd></dl> |
---|
| 570 | |
---|
| 571 | <dl class="method"> |
---|
| 572 | <dt id="sans.guiframe.utils.PanelMenu.SetPreviousHandler"> |
---|
| 573 | <tt class="descname">SetPreviousHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetPreviousHandler" title="Permalink to this definition">¶</a></dt> |
---|
| 574 | <dd><p>SetPreviousHandler(self, EvtHandler handler)</p> |
---|
| 575 | </dd></dl> |
---|
| 576 | |
---|
| 577 | <dl class="method"> |
---|
| 578 | <dt id="sans.guiframe.utils.PanelMenu.SetTitle"> |
---|
| 579 | <tt class="descname">SetTitle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.SetTitle" title="Permalink to this definition">¶</a></dt> |
---|
| 580 | <dd><p>SetTitle(self, String title)</p> |
---|
| 581 | </dd></dl> |
---|
| 582 | |
---|
| 583 | <dl class="attribute"> |
---|
| 584 | <dt id="sans.guiframe.utils.PanelMenu.Style"> |
---|
| 585 | <tt class="descname">Style</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Style" title="Permalink to this definition">¶</a></dt> |
---|
| 586 | <dd><p>See <cite>GetStyle</cite></p> |
---|
| 587 | </dd></dl> |
---|
| 588 | |
---|
| 589 | <dl class="attribute"> |
---|
| 590 | <dt id="sans.guiframe.utils.PanelMenu.Title"> |
---|
| 591 | <tt class="descname">Title</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Title" title="Permalink to this definition">¶</a></dt> |
---|
| 592 | <dd><p>See <cite>GetTitle</cite> and <cite>SetTitle</cite></p> |
---|
| 593 | </dd></dl> |
---|
| 594 | |
---|
| 595 | <dl class="method"> |
---|
| 596 | <dt id="sans.guiframe.utils.PanelMenu.Unbind"> |
---|
| 597 | <tt class="descname">Unbind</tt><big>(</big><em>event</em>, <em>source=None</em>, <em>id=-1</em>, <em>id2=-1</em>, <em>handler=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.Unbind" title="Permalink to this definition">¶</a></dt> |
---|
| 598 | <dd><p>Disconnects the event handler binding for event from self. |
---|
| 599 | Returns True if successful.</p> |
---|
| 600 | </dd></dl> |
---|
| 601 | |
---|
| 602 | <dl class="method"> |
---|
| 603 | <dt id="sans.guiframe.utils.PanelMenu.UpdateUI"> |
---|
| 604 | <tt class="descname">UpdateUI</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.UpdateUI" title="Permalink to this definition">¶</a></dt> |
---|
| 605 | <dd><p>UpdateUI(self, EvtHandler source=None)</p> |
---|
| 606 | </dd></dl> |
---|
| 607 | |
---|
| 608 | <dl class="method"> |
---|
| 609 | <dt id="sans.guiframe.utils.PanelMenu.set_graph"> |
---|
| 610 | <tt class="descname">set_graph</tt><big>(</big><em>graph</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.set_graph" title="Permalink to this definition">¶</a></dt> |
---|
| 611 | <dd></dd></dl> |
---|
| 612 | |
---|
| 613 | <dl class="method"> |
---|
| 614 | <dt id="sans.guiframe.utils.PanelMenu.set_plots"> |
---|
| 615 | <tt class="descname">set_plots</tt><big>(</big><em>plots</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.set_plots" title="Permalink to this definition">¶</a></dt> |
---|
| 616 | <dd></dd></dl> |
---|
| 617 | |
---|
| 618 | <dl class="attribute"> |
---|
| 619 | <dt id="sans.guiframe.utils.PanelMenu.thisown"> |
---|
| 620 | <tt class="descname">thisown</tt><a class="headerlink" href="#sans.guiframe.utils.PanelMenu.thisown" title="Permalink to this definition">¶</a></dt> |
---|
| 621 | <dd><p>The membership flag</p> |
---|
| 622 | </dd></dl> |
---|
| 623 | |
---|
| 624 | </dd></dl> |
---|
| 625 | |
---|
| 626 | <dl class="function"> |
---|
| 627 | <dt id="sans.guiframe.utils.check_float"> |
---|
| 628 | <tt class="descclassname">sans.guiframe.utils.</tt><tt class="descname">check_float</tt><big>(</big><em>item</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.check_float" title="Permalink to this definition">¶</a></dt> |
---|
| 629 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 630 | <col class="field-name" /> |
---|
| 631 | <col class="field-body" /> |
---|
| 632 | <tbody valign="top"> |
---|
| 633 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> – txtcrtl containing a value</td> |
---|
| 634 | </tr> |
---|
| 635 | </tbody> |
---|
| 636 | </table> |
---|
| 637 | </dd></dl> |
---|
| 638 | |
---|
| 639 | <dl class="function"> |
---|
| 640 | <dt id="sans.guiframe.utils.format_number"> |
---|
| 641 | <tt class="descclassname">sans.guiframe.utils.</tt><tt class="descname">format_number</tt><big>(</big><em>value</em>, <em>high=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.format_number" title="Permalink to this definition">¶</a></dt> |
---|
| 642 | <dd><p>Return a float in a standardized, human-readable formatted string</p> |
---|
| 643 | </dd></dl> |
---|
| 644 | |
---|
| 645 | <dl class="function"> |
---|
| 646 | <dt id="sans.guiframe.utils.look_for_tag"> |
---|
| 647 | <tt class="descclassname">sans.guiframe.utils.</tt><tt class="descname">look_for_tag</tt><big>(</big><em>string1</em>, <em>begin</em>, <em>end=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.look_for_tag" title="Permalink to this definition">¶</a></dt> |
---|
| 648 | <dd><p>this method remove the begin and end tags given by the user |
---|
| 649 | from the string .</p> |
---|
| 650 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 651 | <col class="field-name" /> |
---|
| 652 | <col class="field-body" /> |
---|
| 653 | <tbody valign="top"> |
---|
| 654 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 655 | <li><strong>begin</strong> – the initial tag</li> |
---|
| 656 | <li><strong>end</strong> – the final tag</li> |
---|
| 657 | <li><strong>string</strong> – the string to check</li> |
---|
| 658 | </ul> |
---|
| 659 | </td> |
---|
| 660 | </tr> |
---|
| 661 | <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">begin_flag==True if begin was found, |
---|
| 662 | end_flag==if end was found else return false, false</p> |
---|
| 663 | </td> |
---|
| 664 | </tr> |
---|
| 665 | </tbody> |
---|
| 666 | </table> |
---|
| 667 | </dd></dl> |
---|
| 668 | |
---|
| 669 | <dl class="function"> |
---|
| 670 | <dt id="sans.guiframe.utils.parse_name"> |
---|
| 671 | <tt class="descclassname">sans.guiframe.utils.</tt><tt class="descname">parse_name</tt><big>(</big><em>name</em>, <em>expression</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.parse_name" title="Permalink to this definition">¶</a></dt> |
---|
| 672 | <dd><p>remove “_” in front of a name</p> |
---|
| 673 | </dd></dl> |
---|
| 674 | |
---|
| 675 | <dl class="function"> |
---|
| 676 | <dt id="sans.guiframe.utils.split_list"> |
---|
| 677 | <tt class="descclassname">sans.guiframe.utils.</tt><tt class="descname">split_list</tt><big>(</big><em>separator</em>, <em>mylist</em>, <em>n=0</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.split_list" title="Permalink to this definition">¶</a></dt> |
---|
| 678 | <dd><p>returns a list of string without white space of separator</p> |
---|
| 679 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 680 | <col class="field-name" /> |
---|
| 681 | <col class="field-body" /> |
---|
| 682 | <tbody valign="top"> |
---|
| 683 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>separator</strong> – the string to remove</td> |
---|
| 684 | </tr> |
---|
| 685 | </tbody> |
---|
| 686 | </table> |
---|
| 687 | </dd></dl> |
---|
| 688 | |
---|
| 689 | <dl class="function"> |
---|
| 690 | <dt id="sans.guiframe.utils.split_text"> |
---|
| 691 | <tt class="descclassname">sans.guiframe.utils.</tt><tt class="descname">split_text</tt><big>(</big><em>separator</em>, <em>string1</em>, <em>n=0</em><big>)</big><a class="headerlink" href="#sans.guiframe.utils.split_text" title="Permalink to this definition">¶</a></dt> |
---|
| 692 | <dd><p>return a list of string without white space of separator</p> |
---|
| 693 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 694 | <col class="field-name" /> |
---|
| 695 | <col class="field-body" /> |
---|
| 696 | <tbody valign="top"> |
---|
| 697 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>separator</strong> – the string to remove</td> |
---|
| 698 | </tr> |
---|
| 699 | </tbody> |
---|
| 700 | </table> |
---|
| 701 | </dd></dl> |
---|
| 702 | |
---|
| 703 | </div> |
---|
| 704 | </div> |
---|
| 705 | |
---|
| 706 | |
---|
| 707 | </div> |
---|
| 708 | </div> |
---|
| 709 | </div> |
---|
| 710 | <div class="sphinxsidebar"> |
---|
| 711 | <div class="sphinxsidebarwrapper"> |
---|
| 712 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
| 713 | <ul> |
---|
| 714 | <li><a class="reference internal" href="#">utils</a><ul> |
---|
| 715 | <li><a class="reference internal" href="#module-sans.guiframe.utils"><tt class="docutils literal"><span class="pre">sans.guiframe.utils</span></tt></a></li> |
---|
| 716 | </ul> |
---|
| 717 | </li> |
---|
| 718 | </ul> |
---|
| 719 | |
---|
| 720 | <h4>Previous topic</h4> |
---|
| 721 | <p class="topless"><a href="state_reader.html" |
---|
| 722 | title="previous chapter">state_reader</a></p> |
---|
| 723 | <h4>Next topic</h4> |
---|
| 724 | <p class="topless"><a href="version.html" |
---|
| 725 | title="next chapter">version</a></p> |
---|
| 726 | <h3>This Page</h3> |
---|
| 727 | <ul class="this-page-menu"> |
---|
| 728 | <li><a href="../_sources/api/utils.txt" |
---|
| 729 | rel="nofollow">Show Source</a></li> |
---|
| 730 | </ul> |
---|
| 731 | <div id="searchbox" style="display: none"> |
---|
| 732 | <h3>Quick search</h3> |
---|
| 733 | <form class="search" action="../search.html" method="get"> |
---|
| 734 | <input type="text" name="q" size="18" /> |
---|
| 735 | <input type="submit" value="Go" /> |
---|
| 736 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 737 | <input type="hidden" name="area" value="default" /> |
---|
| 738 | </form> |
---|
| 739 | <p class="searchtip" style="font-size: 90%"> |
---|
| 740 | Enter search terms or a module, class or function name. |
---|
| 741 | </p> |
---|
| 742 | </div> |
---|
| 743 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 744 | </div> |
---|
| 745 | </div> |
---|
| 746 | <div class="clearer"></div> |
---|
| 747 | </div> |
---|
| 748 | <div class="related"> |
---|
| 749 | <h3>Navigation</h3> |
---|
| 750 | <ul> |
---|
| 751 | <li class="right" style="margin-right: 10px"> |
---|
| 752 | <a href="../genindex.html" title="General Index" |
---|
| 753 | >index</a></li> |
---|
| 754 | <li class="right" > |
---|
| 755 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 756 | >modules</a> |</li> |
---|
| 757 | <li class="right" > |
---|
| 758 | <a href="version.html" title="version" |
---|
| 759 | >next</a> |</li> |
---|
| 760 | <li class="right" > |
---|
| 761 | <a href="state_reader.html" title="state_reader" |
---|
| 762 | >previous</a> |</li> |
---|
| 763 | <li><a href="../index.html">guiframe v0.1.0 documentation</a> »</li> |
---|
| 764 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 765 | </ul> |
---|
| 766 | </div> |
---|
| 767 | <div class="footer"> |
---|
| 768 | © Copyright 2010, sans group. |
---|
| 769 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. |
---|
| 770 | </div> |
---|
| 771 | </body> |
---|
| 772 | </html> |
---|