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