source: sasview/sansguiframe/docs/sphinx/html/api/utils.html @ bce8148

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since bce8148 was bce8148, checked in by Gervaise Alina <gervyh@…>, 13 years ago

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