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 | |
---|
7 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
8 | <head> |
---|
9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
10 | |
---|
11 | <title>dummyapp — guiframe 0.1.0 documentation</title> |
---|
12 | |
---|
13 | <link rel="stylesheet" href="../_static/default.css" type="text/css" /> |
---|
14 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
---|
15 | |
---|
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> |
---|
28 | <link rel="top" title="guiframe 0.1.0 documentation" href="../index.html" /> |
---|
29 | <link rel="up" title="Reference" href="index.html" /> |
---|
30 | <link rel="next" title="events" href="events.html" /> |
---|
31 | <link rel="prev" title="data_state" href="data_state.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="events.html" title="events" |
---|
45 | accesskey="N">next</a> |</li> |
---|
46 | <li class="right" > |
---|
47 | <a href="data_state.html" title="data_state" |
---|
48 | accesskey="P">previous</a> |</li> |
---|
49 | <li><a href="../index.html">guiframe 0.1.0 documentation</a> »</li> |
---|
50 | <li><a href="index.html" accesskey="U">Reference</a> »</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="dummyapp"> |
---|
60 | <h1>dummyapp<a class="headerlink" href="#dummyapp" title="Permalink to this headline">¶</a></h1> |
---|
61 | <div class="section" id="sans-guiframe-dummyapp"> |
---|
62 | <h2><a class="reference internal" href="#module-sans.guiframe.dummyapp" title="sans.guiframe.dummyapp"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.dummyapp</span></tt></a><a class="headerlink" href="#sans-guiframe-dummyapp" title="Permalink to this headline">¶</a></h2> |
---|
63 | <span class="target" id="module-sans.guiframe.dummyapp"></span><p>Dummy application. |
---|
64 | Allows the user to set an external data manager</p> |
---|
65 | <dl class="class"> |
---|
66 | <dt id="sans.guiframe.dummyapp.DummyView"> |
---|
67 | <em class="property">class </em><tt class="descclassname">sans.guiframe.dummyapp.</tt><tt class="descname">DummyView</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView" title="Permalink to this definition">¶</a></dt> |
---|
68 | <dd><p>Bases: <a class="reference internal" href="gui_manager.html#sans.guiframe.gui_manager.ViewApp" title="sans.guiframe.gui_manager.ViewApp"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.gui_manager.ViewApp</span></tt></a></p> |
---|
69 | <dl class="attribute"> |
---|
70 | <dt id="sans.guiframe.dummyapp.DummyView.Active"> |
---|
71 | <tt class="descname">Active</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Active" title="Permalink to this definition">¶</a></dt> |
---|
72 | <dd><p>IsActive(self) -> bool</p> |
---|
73 | <p>Return True if our app has focus.</p> |
---|
74 | </dd></dl> |
---|
75 | |
---|
76 | <dl class="method"> |
---|
77 | <dt id="sans.guiframe.dummyapp.DummyView.AddPendingEvent"> |
---|
78 | <tt class="descname">AddPendingEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.AddPendingEvent" title="Permalink to this definition">¶</a></dt> |
---|
79 | <dd></dd></dl> |
---|
80 | |
---|
81 | <dl class="attribute"> |
---|
82 | <dt id="sans.guiframe.dummyapp.DummyView.AppName"> |
---|
83 | <tt class="descname">AppName</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.AppName" title="Permalink to this definition">¶</a></dt> |
---|
84 | <dd><p>See <cite>GetAppName</cite> and <cite>SetAppName</cite></p> |
---|
85 | </dd></dl> |
---|
86 | |
---|
87 | <dl class="attribute"> |
---|
88 | <dt id="sans.guiframe.dummyapp.DummyView.AssertMode"> |
---|
89 | <tt class="descname">AssertMode</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.AssertMode" title="Permalink to this definition">¶</a></dt> |
---|
90 | <dd><p>See <cite>GetAssertMode</cite> and <cite>SetAssertMode</cite></p> |
---|
91 | </dd></dl> |
---|
92 | |
---|
93 | <dl class="method"> |
---|
94 | <dt id="sans.guiframe.dummyapp.DummyView.Bind"> |
---|
95 | <tt class="descname">Bind</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Bind" title="Permalink to this definition">¶</a></dt> |
---|
96 | <dd><p>Bind an event to an event handler.</p> |
---|
97 | <table class="docutils field-list" frame="void" rules="none"> |
---|
98 | <col class="field-name" /> |
---|
99 | <col class="field-body" /> |
---|
100 | <tbody valign="top"> |
---|
101 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
102 | <li><strong>event</strong> – One of the EVT_* objects that specifies the |
---|
103 | type of event to bind,</li> |
---|
104 | <li><strong>handler</strong> – A callable object to be invoked when the |
---|
105 | event is delivered to self. Pass None to |
---|
106 | disconnect an event handler.</li> |
---|
107 | <li><strong>source</strong> – Sometimes the event originates from a |
---|
108 | different window than self, but you still |
---|
109 | want to catch it in self. (For example, a |
---|
110 | button event delivered to a frame.) By |
---|
111 | passing the source of the event, the event |
---|
112 | handling system is able to differentiate |
---|
113 | between the same event type from different |
---|
114 | controls.</li> |
---|
115 | <li><strong>id</strong> – Used to spcify the event source by ID instead |
---|
116 | of instance.</li> |
---|
117 | <li><strong>id2</strong> – Used when it is desirable to bind a handler |
---|
118 | to a range of IDs, such as with EVT_MENU_RANGE.</li> |
---|
119 | </ul> |
---|
120 | </td> |
---|
121 | </tr> |
---|
122 | </tbody> |
---|
123 | </table> |
---|
124 | </dd></dl> |
---|
125 | |
---|
126 | <dl class="attribute"> |
---|
127 | <dt id="sans.guiframe.dummyapp.DummyView.ClassName"> |
---|
128 | <tt class="descname">ClassName</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.ClassName" title="Permalink to this definition">¶</a></dt> |
---|
129 | <dd><p>See <cite>GetClassName</cite> and <cite>SetClassName</cite></p> |
---|
130 | </dd></dl> |
---|
131 | |
---|
132 | <dl class="method"> |
---|
133 | <dt id="sans.guiframe.dummyapp.DummyView.Connect"> |
---|
134 | <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.dummyapp.DummyView.Connect" title="Permalink to this definition">¶</a></dt> |
---|
135 | <dd></dd></dl> |
---|
136 | |
---|
137 | <dl class="method"> |
---|
138 | <dt id="sans.guiframe.dummyapp.DummyView.Destroy"> |
---|
139 | <tt class="descname">Destroy</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Destroy" title="Permalink to this definition">¶</a></dt> |
---|
140 | <dd></dd></dl> |
---|
141 | |
---|
142 | <dl class="method"> |
---|
143 | <dt id="sans.guiframe.dummyapp.DummyView.Disconnect"> |
---|
144 | <tt class="descname">Disconnect</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Disconnect" title="Permalink to this definition">¶</a></dt> |
---|
145 | <dd><p>Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, |
---|
146 | PyObject func=None) -> bool</p> |
---|
147 | </dd></dl> |
---|
148 | |
---|
149 | <dl class="method"> |
---|
150 | <dt id="sans.guiframe.dummyapp.DummyView.Dispatch"> |
---|
151 | <tt class="descname">Dispatch</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Dispatch" title="Permalink to this definition">¶</a></dt> |
---|
152 | <dd><p>Process the first event in the event queue (blocks until an event |
---|
153 | appears if there are none currently)</p> |
---|
154 | </dd></dl> |
---|
155 | |
---|
156 | <dl class="attribute"> |
---|
157 | <dt id="sans.guiframe.dummyapp.DummyView.EvtHandlerEnabled"> |
---|
158 | <tt class="descname">EvtHandlerEnabled</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.EvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> |
---|
159 | <dd><p>See <cite>GetEvtHandlerEnabled</cite> and <cite>SetEvtHandlerEnabled</cite></p> |
---|
160 | </dd></dl> |
---|
161 | |
---|
162 | <dl class="method"> |
---|
163 | <dt id="sans.guiframe.dummyapp.DummyView.Exit"> |
---|
164 | <tt class="descname">Exit</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Exit" title="Permalink to this definition">¶</a></dt> |
---|
165 | <dd><p>Exit the main loop thus terminating the application. |
---|
166 | :see: <cite>wx.Exit</cite></p> |
---|
167 | </dd></dl> |
---|
168 | |
---|
169 | <dl class="method"> |
---|
170 | <dt id="sans.guiframe.dummyapp.DummyView.ExitMainLoop"> |
---|
171 | <tt class="descname">ExitMainLoop</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.ExitMainLoop" title="Permalink to this definition">¶</a></dt> |
---|
172 | <dd><p>Exit the main GUI loop during the next iteration of the main |
---|
173 | loop, (i.e. it does not stop the program immediately!)</p> |
---|
174 | </dd></dl> |
---|
175 | |
---|
176 | <dl class="attribute"> |
---|
177 | <dt id="sans.guiframe.dummyapp.DummyView.ExitOnFrameDelete"> |
---|
178 | <tt class="descname">ExitOnFrameDelete</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.ExitOnFrameDelete" title="Permalink to this definition">¶</a></dt> |
---|
179 | <dd><p>See <cite>GetExitOnFrameDelete</cite> and <cite>SetExitOnFrameDelete</cite></p> |
---|
180 | </dd></dl> |
---|
181 | |
---|
182 | <dl class="method"> |
---|
183 | <dt id="sans.guiframe.dummyapp.DummyView.FilterEvent"> |
---|
184 | <tt class="descname">FilterEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.FilterEvent" title="Permalink to this definition">¶</a></dt> |
---|
185 | <dd><p>Filters all events. <cite>SetCallFilterEvent</cite> controls whether or not your |
---|
186 | override is called.</p> |
---|
187 | </dd></dl> |
---|
188 | |
---|
189 | <dl class="method"> |
---|
190 | <dt id="sans.guiframe.dummyapp.DummyView.GetAppName"> |
---|
191 | <tt class="descname">GetAppName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetAppName" title="Permalink to this definition">¶</a></dt> |
---|
192 | <dd><p>Get the application name.</p> |
---|
193 | </dd></dl> |
---|
194 | |
---|
195 | <dl class="method"> |
---|
196 | <dt id="sans.guiframe.dummyapp.DummyView.GetAssertMode"> |
---|
197 | <tt class="descname">GetAssertMode</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetAssertMode" title="Permalink to this definition">¶</a></dt> |
---|
198 | <dd><p>Get the current OnAssert behaviour setting.</p> |
---|
199 | </dd></dl> |
---|
200 | |
---|
201 | <dl class="method"> |
---|
202 | <dt id="sans.guiframe.dummyapp.DummyView.GetCallFilterEvent"> |
---|
203 | <tt class="descname">GetCallFilterEvent</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetCallFilterEvent" title="Permalink to this definition">¶</a></dt> |
---|
204 | <dd><p>Returns the state of the Call FilterEvent flag.</p> |
---|
205 | </dd></dl> |
---|
206 | |
---|
207 | <dl class="method"> |
---|
208 | <dt id="sans.guiframe.dummyapp.DummyView.GetClassName"> |
---|
209 | <tt class="descname">GetClassName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetClassName" title="Permalink to this definition">¶</a></dt> |
---|
210 | <dd><p>Get the application’s class name.</p> |
---|
211 | </dd></dl> |
---|
212 | |
---|
213 | <dl class="staticmethod"> |
---|
214 | <dt id="sans.guiframe.dummyapp.DummyView.GetComCtl32Version"> |
---|
215 | <em class="property">static </em><tt class="descname">GetComCtl32Version</tt><big>(</big><big>)</big> → int<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetComCtl32Version" title="Permalink to this definition">¶</a></dt> |
---|
216 | <dd><p>Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if |
---|
217 | it wasn’t found at all. Raises an exception on non-Windows platforms.</p> |
---|
218 | </dd></dl> |
---|
219 | |
---|
220 | <dl class="method"> |
---|
221 | <dt id="sans.guiframe.dummyapp.DummyView.GetEvtHandlerEnabled"> |
---|
222 | <tt class="descname">GetEvtHandlerEnabled</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> |
---|
223 | <dd></dd></dl> |
---|
224 | |
---|
225 | <dl class="method"> |
---|
226 | <dt id="sans.guiframe.dummyapp.DummyView.GetExitOnFrameDelete"> |
---|
227 | <tt class="descname">GetExitOnFrameDelete</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetExitOnFrameDelete" title="Permalink to this definition">¶</a></dt> |
---|
228 | <dd><p>Get the current exit behaviour setting.</p> |
---|
229 | </dd></dl> |
---|
230 | |
---|
231 | <dl class="method"> |
---|
232 | <dt id="sans.guiframe.dummyapp.DummyView.GetLayoutDirection"> |
---|
233 | <tt class="descname">GetLayoutDirection</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetLayoutDirection" title="Permalink to this definition">¶</a></dt> |
---|
234 | <dd><p>Return the layout direction for the current locale.</p> |
---|
235 | </dd></dl> |
---|
236 | |
---|
237 | <dl class="staticmethod"> |
---|
238 | <dt id="sans.guiframe.dummyapp.DummyView.GetMacAboutMenuItemId"> |
---|
239 | <em class="property">static </em><tt class="descname">GetMacAboutMenuItemId</tt><big>(</big><big>)</big> → long<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetMacAboutMenuItemId" title="Permalink to this definition">¶</a></dt> |
---|
240 | <dd></dd></dl> |
---|
241 | |
---|
242 | <dl class="staticmethod"> |
---|
243 | <dt id="sans.guiframe.dummyapp.DummyView.GetMacExitMenuItemId"> |
---|
244 | <em class="property">static </em><tt class="descname">GetMacExitMenuItemId</tt><big>(</big><big>)</big> → long<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetMacExitMenuItemId" title="Permalink to this definition">¶</a></dt> |
---|
245 | <dd></dd></dl> |
---|
246 | |
---|
247 | <dl class="staticmethod"> |
---|
248 | <dt id="sans.guiframe.dummyapp.DummyView.GetMacHelpMenuTitleName"> |
---|
249 | <em class="property">static </em><tt class="descname">GetMacHelpMenuTitleName</tt><big>(</big><big>)</big> → String<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetMacHelpMenuTitleName" title="Permalink to this definition">¶</a></dt> |
---|
250 | <dd></dd></dl> |
---|
251 | |
---|
252 | <dl class="staticmethod"> |
---|
253 | <dt id="sans.guiframe.dummyapp.DummyView.GetMacPreferencesMenuItemId"> |
---|
254 | <em class="property">static </em><tt class="descname">GetMacPreferencesMenuItemId</tt><big>(</big><big>)</big> → long<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetMacPreferencesMenuItemId" title="Permalink to this definition">¶</a></dt> |
---|
255 | <dd></dd></dl> |
---|
256 | |
---|
257 | <dl class="staticmethod"> |
---|
258 | <dt id="sans.guiframe.dummyapp.DummyView.GetMacSupportPCMenuShortcuts"> |
---|
259 | <em class="property">static </em><tt class="descname">GetMacSupportPCMenuShortcuts</tt><big>(</big><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetMacSupportPCMenuShortcuts" title="Permalink to this definition">¶</a></dt> |
---|
260 | <dd></dd></dl> |
---|
261 | |
---|
262 | <dl class="method"> |
---|
263 | <dt id="sans.guiframe.dummyapp.DummyView.GetNextHandler"> |
---|
264 | <tt class="descname">GetNextHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetNextHandler" title="Permalink to this definition">¶</a></dt> |
---|
265 | <dd></dd></dl> |
---|
266 | |
---|
267 | <dl class="method"> |
---|
268 | <dt id="sans.guiframe.dummyapp.DummyView.GetPreviousHandler"> |
---|
269 | <tt class="descname">GetPreviousHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetPreviousHandler" title="Permalink to this definition">¶</a></dt> |
---|
270 | <dd></dd></dl> |
---|
271 | |
---|
272 | <dl class="method"> |
---|
273 | <dt id="sans.guiframe.dummyapp.DummyView.GetPrintMode"> |
---|
274 | <tt class="descname">GetPrintMode</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetPrintMode" title="Permalink to this definition">¶</a></dt> |
---|
275 | <dd></dd></dl> |
---|
276 | |
---|
277 | <dl class="method"> |
---|
278 | <dt id="sans.guiframe.dummyapp.DummyView.GetTopWindow"> |
---|
279 | <tt class="descname">GetTopWindow</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetTopWindow" title="Permalink to this definition">¶</a></dt> |
---|
280 | <dd><p>Return the <em>main</em> top level window (if it hadn’t been set previously |
---|
281 | with SetTopWindow(), will return just some top level window and, if |
---|
282 | there not any, will return None)</p> |
---|
283 | </dd></dl> |
---|
284 | |
---|
285 | <dl class="method"> |
---|
286 | <dt id="sans.guiframe.dummyapp.DummyView.GetTraits"> |
---|
287 | <tt class="descname">GetTraits</tt><big>(</big><em>self</em><big>)</big> → wxAppTraits<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetTraits" title="Permalink to this definition">¶</a></dt> |
---|
288 | <dd><p>Return (and create if necessary) the app traits object to which we |
---|
289 | delegate for everything which either should be configurable by the |
---|
290 | user (then he can change the default behaviour simply by overriding |
---|
291 | CreateTraits() and returning his own traits object) or which is |
---|
292 | GUI/console dependent as then wx.AppTraits allows us to abstract the |
---|
293 | differences behind the common facade.</p> |
---|
294 | <table class="docutils field-list" frame="void" rules="none"> |
---|
295 | <col class="field-name" /> |
---|
296 | <col class="field-body" /> |
---|
297 | <tbody valign="top"> |
---|
298 | <tr class="field-odd field"><th class="field-name">Todo :</th><td class="field-body">Add support for overriding CreateAppTraits in wxPython.</td> |
---|
299 | </tr> |
---|
300 | </tbody> |
---|
301 | </table> |
---|
302 | </dd></dl> |
---|
303 | |
---|
304 | <dl class="method"> |
---|
305 | <dt id="sans.guiframe.dummyapp.DummyView.GetUseBestVisual"> |
---|
306 | <tt class="descname">GetUseBestVisual</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetUseBestVisual" title="Permalink to this definition">¶</a></dt> |
---|
307 | <dd><p>Get current UseBestVisual setting.</p> |
---|
308 | </dd></dl> |
---|
309 | |
---|
310 | <dl class="method"> |
---|
311 | <dt id="sans.guiframe.dummyapp.DummyView.GetVendorName"> |
---|
312 | <tt class="descname">GetVendorName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.GetVendorName" title="Permalink to this definition">¶</a></dt> |
---|
313 | <dd><p>Get the application’s vendor name.</p> |
---|
314 | </dd></dl> |
---|
315 | |
---|
316 | <dl class="method"> |
---|
317 | <dt id="sans.guiframe.dummyapp.DummyView.IsActive"> |
---|
318 | <tt class="descname">IsActive</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.IsActive" title="Permalink to this definition">¶</a></dt> |
---|
319 | <dd><p>Return True if our app has focus.</p> |
---|
320 | </dd></dl> |
---|
321 | |
---|
322 | <dl class="staticmethod"> |
---|
323 | <dt id="sans.guiframe.dummyapp.DummyView.IsDisplayAvailable"> |
---|
324 | <em class="property">static </em><tt class="descname">IsDisplayAvailable</tt><big>(</big><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.IsDisplayAvailable" title="Permalink to this definition">¶</a></dt> |
---|
325 | <dd><p>Tests if it is possible to create a GUI in the current environment. |
---|
326 | This will mean different things on the different platforms.</p> |
---|
327 | <blockquote> |
---|
328 | <div><ul class="simple"> |
---|
329 | <li>On X Windows systems this function will return <tt class="docutils literal"><span class="pre">False</span></tt> if it is |
---|
330 | not able to open a connection to the X display, which can happen |
---|
331 | if $DISPLAY is not set, or is not set correctly.</li> |
---|
332 | <li>On Mac OS X a <tt class="docutils literal"><span class="pre">False</span></tt> return value will mean that wx is not |
---|
333 | able to access the window manager, which can happen if logged in |
---|
334 | remotely or if running from the normal version of python instead |
---|
335 | of the framework version, (i.e., pythonw.)</li> |
---|
336 | <li>On MS Windows...</li> |
---|
337 | </ul> |
---|
338 | </div></blockquote> |
---|
339 | </dd></dl> |
---|
340 | |
---|
341 | <dl class="staticmethod"> |
---|
342 | <dt id="sans.guiframe.dummyapp.DummyView.IsMainLoopRunning"> |
---|
343 | <em class="property">static </em><tt class="descname">IsMainLoopRunning</tt><big>(</big><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.IsMainLoopRunning" title="Permalink to this definition">¶</a></dt> |
---|
344 | <dd><p>Returns True if we’re running the main loop, i.e. if the events can |
---|
345 | currently be dispatched.</p> |
---|
346 | </dd></dl> |
---|
347 | |
---|
348 | <dl class="method"> |
---|
349 | <dt id="sans.guiframe.dummyapp.DummyView.IsSameAs"> |
---|
350 | <tt class="descname">IsSameAs</tt><big>(</big><em>self</em>, <em>Object p</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.IsSameAs" title="Permalink to this definition">¶</a></dt> |
---|
351 | <dd><p>For wx.Objects that use C++ reference counting internally, this method |
---|
352 | can be used to determine if two objects are referencing the same data |
---|
353 | object.</p> |
---|
354 | </dd></dl> |
---|
355 | |
---|
356 | <dl class="attribute"> |
---|
357 | <dt id="sans.guiframe.dummyapp.DummyView.LayoutDirection"> |
---|
358 | <tt class="descname">LayoutDirection</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.LayoutDirection" title="Permalink to this definition">¶</a></dt> |
---|
359 | <dd><p>See <cite>GetLayoutDirection</cite></p> |
---|
360 | </dd></dl> |
---|
361 | |
---|
362 | <dl class="method"> |
---|
363 | <dt id="sans.guiframe.dummyapp.DummyView.MacHideApp"> |
---|
364 | <tt class="descname">MacHideApp</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.MacHideApp" title="Permalink to this definition">¶</a></dt> |
---|
365 | <dd><p>Hide all application windows just as the user can do with the system |
---|
366 | Hide command. Mac only.</p> |
---|
367 | </dd></dl> |
---|
368 | |
---|
369 | <dl class="method"> |
---|
370 | <dt id="sans.guiframe.dummyapp.DummyView.MacRequestUserAttention"> |
---|
371 | <tt class="descname">MacRequestUserAttention</tt><big>(</big><em>self</em>, <em>int ?</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.MacRequestUserAttention" title="Permalink to this definition">¶</a></dt> |
---|
372 | <dd></dd></dl> |
---|
373 | |
---|
374 | <dl class="method"> |
---|
375 | <dt id="sans.guiframe.dummyapp.DummyView.MainLoop"> |
---|
376 | <tt class="descname">MainLoop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.MainLoop" title="Permalink to this definition">¶</a></dt> |
---|
377 | <dd><p>Execute the main GUI event loop</p> |
---|
378 | </dd></dl> |
---|
379 | |
---|
380 | <dl class="attribute"> |
---|
381 | <dt id="sans.guiframe.dummyapp.DummyView.NextHandler"> |
---|
382 | <tt class="descname">NextHandler</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.NextHandler" title="Permalink to this definition">¶</a></dt> |
---|
383 | <dd><p>See <cite>GetNextHandler</cite> and <cite>SetNextHandler</cite></p> |
---|
384 | </dd></dl> |
---|
385 | |
---|
386 | <dl class="method"> |
---|
387 | <dt id="sans.guiframe.dummyapp.DummyView.OnInit"> |
---|
388 | <tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.OnInit" title="Permalink to this definition">¶</a></dt> |
---|
389 | <dd></dd></dl> |
---|
390 | |
---|
391 | <dl class="method"> |
---|
392 | <dt id="sans.guiframe.dummyapp.DummyView.OnPreInit"> |
---|
393 | <tt class="descname">OnPreInit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.OnPreInit" title="Permalink to this definition">¶</a></dt> |
---|
394 | <dd><p>Things that must be done after _BootstrapApp has done its |
---|
395 | thing, but would be nice if they were already done by the time |
---|
396 | that OnInit is called.</p> |
---|
397 | </dd></dl> |
---|
398 | |
---|
399 | <dl class="method"> |
---|
400 | <dt id="sans.guiframe.dummyapp.DummyView.Pending"> |
---|
401 | <tt class="descname">Pending</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Pending" title="Permalink to this definition">¶</a></dt> |
---|
402 | <dd><p>Returns True if there are unprocessed events in the event queue.</p> |
---|
403 | </dd></dl> |
---|
404 | |
---|
405 | <dl class="attribute"> |
---|
406 | <dt id="sans.guiframe.dummyapp.DummyView.PreviousHandler"> |
---|
407 | <tt class="descname">PreviousHandler</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.PreviousHandler" title="Permalink to this definition">¶</a></dt> |
---|
408 | <dd><p>See <cite>GetPreviousHandler</cite> and <cite>SetPreviousHandler</cite></p> |
---|
409 | </dd></dl> |
---|
410 | |
---|
411 | <dl class="attribute"> |
---|
412 | <dt id="sans.guiframe.dummyapp.DummyView.PrintMode"> |
---|
413 | <tt class="descname">PrintMode</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.PrintMode" title="Permalink to this definition">¶</a></dt> |
---|
414 | <dd><p>See <cite>GetPrintMode</cite> and <cite>SetPrintMode</cite></p> |
---|
415 | </dd></dl> |
---|
416 | |
---|
417 | <dl class="method"> |
---|
418 | <dt id="sans.guiframe.dummyapp.DummyView.ProcessEvent"> |
---|
419 | <tt class="descname">ProcessEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.ProcessEvent" title="Permalink to this definition">¶</a></dt> |
---|
420 | <dd></dd></dl> |
---|
421 | |
---|
422 | <dl class="method"> |
---|
423 | <dt id="sans.guiframe.dummyapp.DummyView.ProcessIdle"> |
---|
424 | <tt class="descname">ProcessIdle</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.ProcessIdle" title="Permalink to this definition">¶</a></dt> |
---|
425 | <dd><p>Called from the MainLoop when the application becomes idle (there are |
---|
426 | no pending events) and sends a <cite>wx.IdleEvent</cite> to all interested |
---|
427 | parties. Returns True if more idle events are needed, False if not.</p> |
---|
428 | </dd></dl> |
---|
429 | |
---|
430 | <dl class="method"> |
---|
431 | <dt id="sans.guiframe.dummyapp.DummyView.ProcessPendingEvents"> |
---|
432 | <tt class="descname">ProcessPendingEvents</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.ProcessPendingEvents" title="Permalink to this definition">¶</a></dt> |
---|
433 | <dd><p>Process all events in the Pending Events list – it is necessary to |
---|
434 | call this function to process posted events. This normally happens |
---|
435 | during each event loop iteration.</p> |
---|
436 | </dd></dl> |
---|
437 | |
---|
438 | <dl class="method"> |
---|
439 | <dt id="sans.guiframe.dummyapp.DummyView.RedirectStdio"> |
---|
440 | <tt class="descname">RedirectStdio</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.RedirectStdio" title="Permalink to this definition">¶</a></dt> |
---|
441 | <dd><p>Redirect sys.stdout and sys.stderr to a file or a popup window.</p> |
---|
442 | </dd></dl> |
---|
443 | |
---|
444 | <dl class="method"> |
---|
445 | <dt id="sans.guiframe.dummyapp.DummyView.RestoreStdio"> |
---|
446 | <tt class="descname">RestoreStdio</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.RestoreStdio" title="Permalink to this definition">¶</a></dt> |
---|
447 | <dd></dd></dl> |
---|
448 | |
---|
449 | <dl class="method"> |
---|
450 | <dt id="sans.guiframe.dummyapp.DummyView.SendIdleEvents"> |
---|
451 | <tt class="descname">SendIdleEvents</tt><big>(</big><em>self</em>, <em>Window win</em>, <em>IdleEvent event</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SendIdleEvents" title="Permalink to this definition">¶</a></dt> |
---|
452 | <dd><p>Send idle event to window and all subwindows. Returns True if more |
---|
453 | idle time is requested.</p> |
---|
454 | </dd></dl> |
---|
455 | |
---|
456 | <dl class="method"> |
---|
457 | <dt id="sans.guiframe.dummyapp.DummyView.SetAppName"> |
---|
458 | <tt class="descname">SetAppName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetAppName" title="Permalink to this definition">¶</a></dt> |
---|
459 | <dd><p>Set the application name. This value may be used automatically by |
---|
460 | <cite>wx.Config</cite> and such.</p> |
---|
461 | </dd></dl> |
---|
462 | |
---|
463 | <dl class="method"> |
---|
464 | <dt id="sans.guiframe.dummyapp.DummyView.SetAssertMode"> |
---|
465 | <tt class="descname">SetAssertMode</tt><big>(</big><em>self</em>, <em>int mode</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetAssertMode" title="Permalink to this definition">¶</a></dt> |
---|
466 | <dd><p>Set the OnAssert behaviour for debug and hybrid builds.</p> |
---|
467 | </dd></dl> |
---|
468 | |
---|
469 | <dl class="method"> |
---|
470 | <dt id="sans.guiframe.dummyapp.DummyView.SetCallFilterEvent"> |
---|
471 | <tt class="descname">SetCallFilterEvent</tt><big>(</big><em>self</em>, <em>bool callFilterEvent=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetCallFilterEvent" title="Permalink to this definition">¶</a></dt> |
---|
472 | <dd><p>Set the Call FilterEvent flag. When set your override of FilterEvent |
---|
473 | will be called. SetCallFilterEvent’s purpose is to avoid any |
---|
474 | performance penalty when you have overriden FilterEvent, but don’t |
---|
475 | want it to be called, and also to reduce the runtime overhead when it |
---|
476 | is not overridden.</p> |
---|
477 | </dd></dl> |
---|
478 | |
---|
479 | <dl class="method"> |
---|
480 | <dt id="sans.guiframe.dummyapp.DummyView.SetClassName"> |
---|
481 | <tt class="descname">SetClassName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetClassName" title="Permalink to this definition">¶</a></dt> |
---|
482 | <dd><p>Set the application’s class name. This value may be used for |
---|
483 | X-resources if applicable for the platform</p> |
---|
484 | </dd></dl> |
---|
485 | |
---|
486 | <dl class="method"> |
---|
487 | <dt id="sans.guiframe.dummyapp.DummyView.SetEvtHandlerEnabled"> |
---|
488 | <tt class="descname">SetEvtHandlerEnabled</tt><big>(</big><em>self</em>, <em>bool enabled</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> |
---|
489 | <dd></dd></dl> |
---|
490 | |
---|
491 | <dl class="method"> |
---|
492 | <dt id="sans.guiframe.dummyapp.DummyView.SetExitOnFrameDelete"> |
---|
493 | <tt class="descname">SetExitOnFrameDelete</tt><big>(</big><em>self</em>, <em>bool flag</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetExitOnFrameDelete" title="Permalink to this definition">¶</a></dt> |
---|
494 | <dd><p>Control the exit behaviour: by default, the program will exit the main |
---|
495 | loop (and so, usually, terminate) when the last top-level program |
---|
496 | window is deleted. Beware that if you disable this behaviour (with |
---|
497 | SetExitOnFrameDelete(False)), you’ll have to call ExitMainLoop() |
---|
498 | explicitly from somewhere.</p> |
---|
499 | </dd></dl> |
---|
500 | |
---|
501 | <dl class="staticmethod"> |
---|
502 | <dt id="sans.guiframe.dummyapp.DummyView.SetMacAboutMenuItemId"> |
---|
503 | <em class="property">static </em><tt class="descname">SetMacAboutMenuItemId</tt><big>(</big><em>long val</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetMacAboutMenuItemId" title="Permalink to this definition">¶</a></dt> |
---|
504 | <dd></dd></dl> |
---|
505 | |
---|
506 | <dl class="staticmethod"> |
---|
507 | <dt id="sans.guiframe.dummyapp.DummyView.SetMacExitMenuItemId"> |
---|
508 | <em class="property">static </em><tt class="descname">SetMacExitMenuItemId</tt><big>(</big><em>long val</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetMacExitMenuItemId" title="Permalink to this definition">¶</a></dt> |
---|
509 | <dd></dd></dl> |
---|
510 | |
---|
511 | <dl class="staticmethod"> |
---|
512 | <dt id="sans.guiframe.dummyapp.DummyView.SetMacHelpMenuTitleName"> |
---|
513 | <em class="property">static </em><tt class="descname">SetMacHelpMenuTitleName</tt><big>(</big><em>String val</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetMacHelpMenuTitleName" title="Permalink to this definition">¶</a></dt> |
---|
514 | <dd></dd></dl> |
---|
515 | |
---|
516 | <dl class="staticmethod"> |
---|
517 | <dt id="sans.guiframe.dummyapp.DummyView.SetMacPreferencesMenuItemId"> |
---|
518 | <em class="property">static </em><tt class="descname">SetMacPreferencesMenuItemId</tt><big>(</big><em>long val</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetMacPreferencesMenuItemId" title="Permalink to this definition">¶</a></dt> |
---|
519 | <dd></dd></dl> |
---|
520 | |
---|
521 | <dl class="staticmethod"> |
---|
522 | <dt id="sans.guiframe.dummyapp.DummyView.SetMacSupportPCMenuShortcuts"> |
---|
523 | <em class="property">static </em><tt class="descname">SetMacSupportPCMenuShortcuts</tt><big>(</big><em>bool val</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetMacSupportPCMenuShortcuts" title="Permalink to this definition">¶</a></dt> |
---|
524 | <dd></dd></dl> |
---|
525 | |
---|
526 | <dl class="method"> |
---|
527 | <dt id="sans.guiframe.dummyapp.DummyView.SetNextHandler"> |
---|
528 | <tt class="descname">SetNextHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetNextHandler" title="Permalink to this definition">¶</a></dt> |
---|
529 | <dd></dd></dl> |
---|
530 | |
---|
531 | <dl class="method"> |
---|
532 | <dt id="sans.guiframe.dummyapp.DummyView.SetOutputWindowAttributes"> |
---|
533 | <tt class="descname">SetOutputWindowAttributes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetOutputWindowAttributes" title="Permalink to this definition">¶</a></dt> |
---|
534 | <dd><p>Set the title, position and/or size of the output window if |
---|
535 | the stdio has been redirected. This should be called before |
---|
536 | any output would cause the output window to be created.</p> |
---|
537 | </dd></dl> |
---|
538 | |
---|
539 | <dl class="method"> |
---|
540 | <dt id="sans.guiframe.dummyapp.DummyView.SetPreviousHandler"> |
---|
541 | <tt class="descname">SetPreviousHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetPreviousHandler" title="Permalink to this definition">¶</a></dt> |
---|
542 | <dd></dd></dl> |
---|
543 | |
---|
544 | <dl class="method"> |
---|
545 | <dt id="sans.guiframe.dummyapp.DummyView.SetPrintMode"> |
---|
546 | <tt class="descname">SetPrintMode</tt><big>(</big><em>self</em>, <em>int mode</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetPrintMode" title="Permalink to this definition">¶</a></dt> |
---|
547 | <dd></dd></dl> |
---|
548 | |
---|
549 | <dl class="method"> |
---|
550 | <dt id="sans.guiframe.dummyapp.DummyView.SetTopWindow"> |
---|
551 | <tt class="descname">SetTopWindow</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetTopWindow" title="Permalink to this definition">¶</a></dt> |
---|
552 | <dd><p>Set the “main” top level window</p> |
---|
553 | </dd></dl> |
---|
554 | |
---|
555 | <dl class="method"> |
---|
556 | <dt id="sans.guiframe.dummyapp.DummyView.SetUseBestVisual"> |
---|
557 | <tt class="descname">SetUseBestVisual</tt><big>(</big><em>self</em>, <em>bool flag</em>, <em>bool forceTrueColour=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetUseBestVisual" title="Permalink to this definition">¶</a></dt> |
---|
558 | <dd><p>Set whether the app should try to use the best available visual on |
---|
559 | systems where more than one is available, (Sun, SGI, XFree86 4, etc.)</p> |
---|
560 | </dd></dl> |
---|
561 | |
---|
562 | <dl class="method"> |
---|
563 | <dt id="sans.guiframe.dummyapp.DummyView.SetVendorName"> |
---|
564 | <tt class="descname">SetVendorName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.SetVendorName" title="Permalink to this definition">¶</a></dt> |
---|
565 | <dd><p>Set the application’s vendor name. This value may be used |
---|
566 | automatically by <cite>wx.Config</cite> and such.</p> |
---|
567 | </dd></dl> |
---|
568 | |
---|
569 | <dl class="attribute"> |
---|
570 | <dt id="sans.guiframe.dummyapp.DummyView.TopWindow"> |
---|
571 | <tt class="descname">TopWindow</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.TopWindow" title="Permalink to this definition">¶</a></dt> |
---|
572 | <dd><p>See <cite>GetTopWindow</cite> and <cite>SetTopWindow</cite></p> |
---|
573 | </dd></dl> |
---|
574 | |
---|
575 | <dl class="attribute"> |
---|
576 | <dt id="sans.guiframe.dummyapp.DummyView.Traits"> |
---|
577 | <tt class="descname">Traits</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Traits" title="Permalink to this definition">¶</a></dt> |
---|
578 | <dd><p>See <cite>GetTraits</cite></p> |
---|
579 | </dd></dl> |
---|
580 | |
---|
581 | <dl class="method"> |
---|
582 | <dt id="sans.guiframe.dummyapp.DummyView.Unbind"> |
---|
583 | <tt class="descname">Unbind</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Unbind" title="Permalink to this definition">¶</a></dt> |
---|
584 | <dd><p>Disconnects the event handler binding for event from self. |
---|
585 | Returns True if successful.</p> |
---|
586 | </dd></dl> |
---|
587 | |
---|
588 | <dl class="attribute"> |
---|
589 | <dt id="sans.guiframe.dummyapp.DummyView.UseBestVisual"> |
---|
590 | <tt class="descname">UseBestVisual</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.UseBestVisual" title="Permalink to this definition">¶</a></dt> |
---|
591 | <dd><p>See <cite>GetUseBestVisual</cite> and <cite>SetUseBestVisual</cite></p> |
---|
592 | </dd></dl> |
---|
593 | |
---|
594 | <dl class="attribute"> |
---|
595 | <dt id="sans.guiframe.dummyapp.DummyView.VendorName"> |
---|
596 | <tt class="descname">VendorName</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.VendorName" title="Permalink to this definition">¶</a></dt> |
---|
597 | <dd><p>See <cite>GetVendorName</cite> and <cite>SetVendorName</cite></p> |
---|
598 | </dd></dl> |
---|
599 | |
---|
600 | <dl class="method"> |
---|
601 | <dt id="sans.guiframe.dummyapp.DummyView.WakeUpIdle"> |
---|
602 | <tt class="descname">WakeUpIdle</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.WakeUpIdle" title="Permalink to this definition">¶</a></dt> |
---|
603 | <dd><p>Make sure that idle events are sent again. |
---|
604 | :see: <cite>wx.WakeUpIdle</cite></p> |
---|
605 | </dd></dl> |
---|
606 | |
---|
607 | <dl class="method"> |
---|
608 | <dt id="sans.guiframe.dummyapp.DummyView.Yield"> |
---|
609 | <tt class="descname">Yield</tt><big>(</big><em>self</em>, <em>bool onlyIfNeeded=False</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.Yield" title="Permalink to this definition">¶</a></dt> |
---|
610 | <dd><p>Process all currently pending events right now, instead of waiting |
---|
611 | until return to the event loop. It is an error to call <tt class="docutils literal"><span class="pre">Yield</span></tt> |
---|
612 | recursively unless the value of <tt class="docutils literal"><span class="pre">onlyIfNeeded</span></tt> is True.</p> |
---|
613 | <table class="docutils field-list" frame="void" rules="none"> |
---|
614 | <col class="field-name" /> |
---|
615 | <col class="field-body" /> |
---|
616 | <tbody valign="top"> |
---|
617 | <tr class="field-odd field"><th class="field-name">Warning :</th><td class="field-body">This function is dangerous as it can lead to unexpected |
---|
618 | reentrancies (i.e. when called from an event handler it may |
---|
619 | result in calling the same event handler again), use with |
---|
620 | extreme care or, better, don’t use at all!</td> |
---|
621 | </tr> |
---|
622 | <tr class="field-even field"><th class="field-name">See :</th><td class="field-body"><cite>wx.Yield</cite>, <cite>wx.YieldIfNeeded</cite>, <cite>wx.SafeYield</cite></td> |
---|
623 | </tr> |
---|
624 | </tbody> |
---|
625 | </table> |
---|
626 | </dd></dl> |
---|
627 | |
---|
628 | <dl class="method"> |
---|
629 | <dt id="sans.guiframe.dummyapp.DummyView._BootstrapApp"> |
---|
630 | <tt class="descname">_BootstrapApp</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView._BootstrapApp" title="Permalink to this definition">¶</a></dt> |
---|
631 | <dd><p>For internal use only</p> |
---|
632 | </dd></dl> |
---|
633 | |
---|
634 | <dl class="attribute"> |
---|
635 | <dt id="sans.guiframe.dummyapp.DummyView.__class__"> |
---|
636 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__class__" title="Permalink to this definition">¶</a></dt> |
---|
637 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> |
---|
638 | </dd></dl> |
---|
639 | |
---|
640 | <dl class="method"> |
---|
641 | <dt id="sans.guiframe.dummyapp.DummyView.__del__"> |
---|
642 | <tt class="descname">__del__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__del__" title="Permalink to this definition">¶</a></dt> |
---|
643 | <dd></dd></dl> |
---|
644 | |
---|
645 | <dl class="attribute"> |
---|
646 | <dt id="sans.guiframe.dummyapp.DummyView.__delattr__"> |
---|
647 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
648 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
649 | </dd></dl> |
---|
650 | |
---|
651 | <dl class="attribute"> |
---|
652 | <dt id="sans.guiframe.dummyapp.DummyView.__dict__"> |
---|
653 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x03DF2BB0></em><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
654 | <dd></dd></dl> |
---|
655 | |
---|
656 | <dl class="attribute"> |
---|
657 | <dt id="sans.guiframe.dummyapp.DummyView.__getattribute__"> |
---|
658 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
659 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
660 | </dd></dl> |
---|
661 | |
---|
662 | <dl class="attribute"> |
---|
663 | <dt id="sans.guiframe.dummyapp.DummyView.__hash__"> |
---|
664 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
665 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
666 | </dd></dl> |
---|
667 | |
---|
668 | <dl class="method"> |
---|
669 | <dt id="sans.guiframe.dummyapp.DummyView.__init__"> |
---|
670 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__init__" title="Permalink to this definition">¶</a></dt> |
---|
671 | <dd><p>Construct a <tt class="docutils literal"><span class="pre">wx.App</span></tt> object.</p> |
---|
672 | <table class="docutils field-list" frame="void" rules="none"> |
---|
673 | <col class="field-name" /> |
---|
674 | <col class="field-body" /> |
---|
675 | <tbody valign="top"> |
---|
676 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
677 | <li><strong>redirect</strong> – Should <tt class="docutils literal"><span class="pre">sys.stdout</span></tt> and <tt class="docutils literal"><span class="pre">sys.stderr</span></tt> be |
---|
678 | redirected? Defaults to True on Windows and Mac, False |
---|
679 | otherwise. If <cite>filename</cite> is None then output will be |
---|
680 | redirected to a window that pops up as needed. (You can |
---|
681 | control what kind of window is created for the output by |
---|
682 | resetting the class variable <tt class="docutils literal"><span class="pre">outputWindowClass</span></tt> to a |
---|
683 | class of your choosing.)</li> |
---|
684 | <li><strong>filename</strong> – The name of a file to redirect output to, if |
---|
685 | redirect is True.</li> |
---|
686 | <li><strong>useBestVisual</strong> – Should the app try to use the best |
---|
687 | available visual provided by the system (only relevant on |
---|
688 | systems that have more than one visual.) This parameter |
---|
689 | must be used instead of calling <cite>SetUseBestVisual</cite> later |
---|
690 | on because it must be set before the underlying GUI |
---|
691 | toolkit is initialized.</li> |
---|
692 | <li><strong>clearSigInt</strong> – Should SIGINT be cleared? This allows the |
---|
693 | app to terminate upon a Ctrl-C in the console like other |
---|
694 | GUI apps will.</li> |
---|
695 | </ul> |
---|
696 | </td> |
---|
697 | </tr> |
---|
698 | <tr class="field-even field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">You should override OnInit to do applicaition |
---|
699 | initialization to ensure that the system, toolkit and |
---|
700 | wxWidgets are fully initialized.</p> |
---|
701 | </td> |
---|
702 | </tr> |
---|
703 | </tbody> |
---|
704 | </table> |
---|
705 | </dd></dl> |
---|
706 | |
---|
707 | <dl class="attribute"> |
---|
708 | <dt id="sans.guiframe.dummyapp.DummyView.__module__"> |
---|
709 | <tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.dummyapp'</em><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__module__" title="Permalink to this definition">¶</a></dt> |
---|
710 | <dd></dd></dl> |
---|
711 | |
---|
712 | <dl class="staticmethod"> |
---|
713 | <dt id="sans.guiframe.dummyapp.DummyView.__new__"> |
---|
714 | <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__new__" title="Permalink to this definition">¶</a></dt> |
---|
715 | <dd></dd></dl> |
---|
716 | |
---|
717 | <dl class="method"> |
---|
718 | <dt id="sans.guiframe.dummyapp.DummyView.__reduce__"> |
---|
719 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
720 | <dd><p>helper for pickle</p> |
---|
721 | </dd></dl> |
---|
722 | |
---|
723 | <dl class="method"> |
---|
724 | <dt id="sans.guiframe.dummyapp.DummyView.__reduce_ex__"> |
---|
725 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
726 | <dd><p>helper for pickle</p> |
---|
727 | </dd></dl> |
---|
728 | |
---|
729 | <dl class="method"> |
---|
730 | <dt id="sans.guiframe.dummyapp.DummyView.__repr__"> |
---|
731 | <tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
732 | <dd></dd></dl> |
---|
733 | |
---|
734 | <dl class="attribute"> |
---|
735 | <dt id="sans.guiframe.dummyapp.DummyView.__setattr__"> |
---|
736 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
737 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
738 | </dd></dl> |
---|
739 | |
---|
740 | <dl class="attribute"> |
---|
741 | <dt id="sans.guiframe.dummyapp.DummyView.__str__"> |
---|
742 | <tt class="descname">__str__</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__str__" title="Permalink to this definition">¶</a></dt> |
---|
743 | <dd><p>x.__str__() <==> str(x)</p> |
---|
744 | </dd></dl> |
---|
745 | |
---|
746 | <dl class="method"> |
---|
747 | <dt id="sans.guiframe.dummyapp.DummyView.__swig_destroy__"> |
---|
748 | <tt class="descname">__swig_destroy__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__swig_destroy__" title="Permalink to this definition">¶</a></dt> |
---|
749 | <dd></dd></dl> |
---|
750 | |
---|
751 | <dl class="attribute"> |
---|
752 | <dt id="sans.guiframe.dummyapp.DummyView.__weakref__"> |
---|
753 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
754 | <dd><p>list of weak references to the object (if defined)</p> |
---|
755 | </dd></dl> |
---|
756 | |
---|
757 | <dl class="method"> |
---|
758 | <dt id="sans.guiframe.dummyapp.DummyView._setCallbackInfo"> |
---|
759 | <tt class="descname">_setCallbackInfo</tt><big>(</big><em>self</em>, <em>PyObject self</em>, <em>PyObject _class</em>, <em>bool incref=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView._setCallbackInfo" title="Permalink to this definition">¶</a></dt> |
---|
760 | <dd></dd></dl> |
---|
761 | |
---|
762 | <dl class="method"> |
---|
763 | <dt id="sans.guiframe.dummyapp.DummyView._setOORInfo"> |
---|
764 | <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.dummyapp.DummyView._setOORInfo" title="Permalink to this definition">¶</a></dt> |
---|
765 | <dd></dd></dl> |
---|
766 | |
---|
767 | <dl class="method"> |
---|
768 | <dt id="sans.guiframe.dummyapp.DummyView.add_perspective"> |
---|
769 | <tt class="descname">add_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.add_perspective" title="Permalink to this definition">¶</a></dt> |
---|
770 | <dd><p>Manually add a perspective to the application GUI</p> |
---|
771 | </dd></dl> |
---|
772 | |
---|
773 | <dl class="method"> |
---|
774 | <dt id="sans.guiframe.dummyapp.DummyView.build_gui"> |
---|
775 | <tt class="descname">build_gui</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.build_gui" title="Permalink to this definition">¶</a></dt> |
---|
776 | <dd><p>Build the GUI</p> |
---|
777 | </dd></dl> |
---|
778 | |
---|
779 | <dl class="method"> |
---|
780 | <dt id="sans.guiframe.dummyapp.DummyView.display_splash_screen"> |
---|
781 | <tt class="descname">display_splash_screen</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.display_splash_screen" title="Permalink to this definition">¶</a></dt> |
---|
782 | <dd><p>Displays the splash screen. It will exactly cover the main frame.</p> |
---|
783 | </dd></dl> |
---|
784 | |
---|
785 | <dl class="method"> |
---|
786 | <dt id="sans.guiframe.dummyapp.DummyView.on_close_splash_screen"> |
---|
787 | <tt class="descname">on_close_splash_screen</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.on_close_splash_screen" title="Permalink to this definition">¶</a></dt> |
---|
788 | <dd></dd></dl> |
---|
789 | |
---|
790 | <dl class="method"> |
---|
791 | <dt id="sans.guiframe.dummyapp.DummyView.open_file"> |
---|
792 | <tt class="descname">open_file</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.open_file" title="Permalink to this definition">¶</a></dt> |
---|
793 | <dd><p>open a state file at the start of the application</p> |
---|
794 | </dd></dl> |
---|
795 | |
---|
796 | <dl class="attribute"> |
---|
797 | <dt id="sans.guiframe.dummyapp.DummyView.outputWindowClass"> |
---|
798 | <tt class="descname">outputWindowClass</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.outputWindowClass" title="Permalink to this definition">¶</a></dt> |
---|
799 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">PyOnDemandOutputWindow</span></tt></p> |
---|
800 | </dd></dl> |
---|
801 | |
---|
802 | <dl class="method"> |
---|
803 | <dt id="sans.guiframe.dummyapp.DummyView.set_manager"> |
---|
804 | <tt class="descname">set_manager</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.set_manager" title="Permalink to this definition">¶</a></dt> |
---|
805 | <dd><p>Sets a reference to the application manager |
---|
806 | of the GUI manager (Frame)</p> |
---|
807 | </dd></dl> |
---|
808 | |
---|
809 | <dl class="method"> |
---|
810 | <dt id="sans.guiframe.dummyapp.DummyView.set_welcome_panel"> |
---|
811 | <tt class="descname">set_welcome_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.set_welcome_panel" title="Permalink to this definition">¶</a></dt> |
---|
812 | <dd><p>Set the welcome panel</p> |
---|
813 | <table class="docutils field-list" frame="void" rules="none"> |
---|
814 | <col class="field-name" /> |
---|
815 | <col class="field-body" /> |
---|
816 | <tbody valign="top"> |
---|
817 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>panel_class</strong> – class of the welcome panel to be instantiated</td> |
---|
818 | </tr> |
---|
819 | </tbody> |
---|
820 | </table> |
---|
821 | </dd></dl> |
---|
822 | |
---|
823 | <dl class="attribute"> |
---|
824 | <dt id="sans.guiframe.dummyapp.DummyView.thisown"> |
---|
825 | <tt class="descname">thisown</tt><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.thisown" title="Permalink to this definition">¶</a></dt> |
---|
826 | <dd><p>The membership flag</p> |
---|
827 | </dd></dl> |
---|
828 | |
---|
829 | <dl class="method"> |
---|
830 | <dt id="sans.guiframe.dummyapp.DummyView.window_placement"> |
---|
831 | <tt class="descname">window_placement</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.DummyView.window_placement" title="Permalink to this definition">¶</a></dt> |
---|
832 | <dd><p>Determines the position and size of the application frame such that it |
---|
833 | fits on the user’s screen without obstructing (or being obstructed by) |
---|
834 | the Windows task bar. The maximum initial size in pixels is bounded by |
---|
835 | WIDTH x HEIGHT. For most monitors, the application |
---|
836 | will be centered on the screen; for very large monitors it will be |
---|
837 | placed on the left side of the screen.</p> |
---|
838 | </dd></dl> |
---|
839 | |
---|
840 | </dd></dl> |
---|
841 | |
---|
842 | <dl class="class"> |
---|
843 | <dt id="sans.guiframe.dummyapp.SansView"> |
---|
844 | <em class="property">class </em><tt class="descclassname">sans.guiframe.dummyapp.</tt><tt class="descname">SansView</tt><a class="headerlink" href="#sans.guiframe.dummyapp.SansView" title="Permalink to this definition">¶</a></dt> |
---|
845 | <dd><dl class="method"> |
---|
846 | <dt id="sans.guiframe.dummyapp.SansView.__init__"> |
---|
847 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.SansView.__init__" title="Permalink to this definition">¶</a></dt> |
---|
848 | <dd><p>Initialization</p> |
---|
849 | </dd></dl> |
---|
850 | |
---|
851 | <dl class="attribute"> |
---|
852 | <dt id="sans.guiframe.dummyapp.SansView.__module__"> |
---|
853 | <tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.dummyapp'</em><a class="headerlink" href="#sans.guiframe.dummyapp.SansView.__module__" title="Permalink to this definition">¶</a></dt> |
---|
854 | <dd></dd></dl> |
---|
855 | |
---|
856 | </dd></dl> |
---|
857 | |
---|
858 | <dl class="class"> |
---|
859 | <dt id="sans.guiframe.dummyapp.TestPlugin"> |
---|
860 | <em class="property">class </em><tt class="descclassname">sans.guiframe.dummyapp.</tt><tt class="descname">TestPlugin</tt><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin" title="Permalink to this definition">¶</a></dt> |
---|
861 | <dd><p>Bases: <a class="reference internal" href="plugin_base.html#sans.guiframe.plugin_base.PluginBase" title="sans.guiframe.plugin_base.PluginBase"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.plugin_base.PluginBase</span></tt></a></p> |
---|
862 | <dl class="method"> |
---|
863 | <dt id="sans.guiframe.dummyapp.TestPlugin.__init__"> |
---|
864 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.__init__" title="Permalink to this definition">¶</a></dt> |
---|
865 | <dd><p>Abstract class for gui_manager Plugins.</p> |
---|
866 | </dd></dl> |
---|
867 | |
---|
868 | <dl class="attribute"> |
---|
869 | <dt id="sans.guiframe.dummyapp.TestPlugin.__module__"> |
---|
870 | <tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.dummyapp'</em><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.__module__" title="Permalink to this definition">¶</a></dt> |
---|
871 | <dd></dd></dl> |
---|
872 | |
---|
873 | <dl class="method"> |
---|
874 | <dt id="sans.guiframe.dummyapp.TestPlugin.add_color"> |
---|
875 | <tt class="descname">add_color</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.add_color" title="Permalink to this definition">¶</a></dt> |
---|
876 | <dd><p>Adds color to a plugin</p> |
---|
877 | </dd></dl> |
---|
878 | |
---|
879 | <dl class="method"> |
---|
880 | <dt id="sans.guiframe.dummyapp.TestPlugin.can_load_data"> |
---|
881 | <tt class="descname">can_load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.can_load_data" title="Permalink to this definition">¶</a></dt> |
---|
882 | <dd><p>if return True, then call handler to laod data</p> |
---|
883 | </dd></dl> |
---|
884 | |
---|
885 | <dl class="method"> |
---|
886 | <dt id="sans.guiframe.dummyapp.TestPlugin.clear_panel"> |
---|
887 | <tt class="descname">clear_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.clear_panel" title="Permalink to this definition">¶</a></dt> |
---|
888 | <dd><p>clear all related panels</p> |
---|
889 | </dd></dl> |
---|
890 | |
---|
891 | <dl class="method"> |
---|
892 | <dt id="sans.guiframe.dummyapp.TestPlugin.delete_data"> |
---|
893 | <tt class="descname">delete_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.delete_data" title="Permalink to this definition">¶</a></dt> |
---|
894 | <dd><p>Delete all references of data which id are in data_list.</p> |
---|
895 | </dd></dl> |
---|
896 | |
---|
897 | <dl class="method"> |
---|
898 | <dt id="sans.guiframe.dummyapp.TestPlugin.get_batch_capable"> |
---|
899 | <tt class="descname">get_batch_capable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_batch_capable" title="Permalink to this definition">¶</a></dt> |
---|
900 | <dd><p>Check if the plugin has a batch capability</p> |
---|
901 | </dd></dl> |
---|
902 | |
---|
903 | <dl class="method"> |
---|
904 | <dt id="sans.guiframe.dummyapp.TestPlugin.get_context_menu"> |
---|
905 | <tt class="descname">get_context_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_context_menu" title="Permalink to this definition">¶</a></dt> |
---|
906 | <dd><p>This method is optional.</p> |
---|
907 | <p>When the context menu of a plot is rendered, the |
---|
908 | get_context_menu method will be called to give you a |
---|
909 | chance to add a menu item to the context menu.</p> |
---|
910 | <p>A ref to a Graph object is passed so that you can |
---|
911 | investigate the plot content and decide whether you |
---|
912 | need to add items to the context menu.</p> |
---|
913 | <p>This method returns a list of menu items. |
---|
914 | Each item is itself a list defining the text to |
---|
915 | appear in the menu, a tool-tip help text, and a |
---|
916 | call-back method.</p> |
---|
917 | <table class="docutils field-list" frame="void" rules="none"> |
---|
918 | <col class="field-name" /> |
---|
919 | <col class="field-body" /> |
---|
920 | <tbody valign="top"> |
---|
921 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>graph</strong> – the Graph object to which we attach the context menu</td> |
---|
922 | </tr> |
---|
923 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of menu items with call-back function</td> |
---|
924 | </tr> |
---|
925 | </tbody> |
---|
926 | </table> |
---|
927 | </dd></dl> |
---|
928 | |
---|
929 | <dl class="method"> |
---|
930 | <dt id="sans.guiframe.dummyapp.TestPlugin.get_extensions"> |
---|
931 | <tt class="descname">get_extensions</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_extensions" title="Permalink to this definition">¶</a></dt> |
---|
932 | <dd><p>return state reader and its extensions</p> |
---|
933 | </dd></dl> |
---|
934 | |
---|
935 | <dl class="method"> |
---|
936 | <dt id="sans.guiframe.dummyapp.TestPlugin.get_panels"> |
---|
937 | <tt class="descname">get_panels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_panels" title="Permalink to this definition">¶</a></dt> |
---|
938 | <dd><p>Create and return the list of wx.Panels for your plug-in. |
---|
939 | Define the plug-in perspective.</p> |
---|
940 | <p>Panels should inherit from DefaultPanel defined below, |
---|
941 | or should present the same interface. They must define |
---|
942 | “window_caption” and “window_name”.</p> |
---|
943 | <table class="docutils field-list" frame="void" rules="none"> |
---|
944 | <col class="field-name" /> |
---|
945 | <col class="field-body" /> |
---|
946 | <tbody valign="top"> |
---|
947 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – parent window</td> |
---|
948 | </tr> |
---|
949 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of panels</td> |
---|
950 | </tr> |
---|
951 | </tbody> |
---|
952 | </table> |
---|
953 | </dd></dl> |
---|
954 | |
---|
955 | <dl class="method"> |
---|
956 | <dt id="sans.guiframe.dummyapp.TestPlugin.get_perspective"> |
---|
957 | <tt class="descname">get_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_perspective" title="Permalink to this definition">¶</a></dt> |
---|
958 | <dd><p>Get the list of panel names for this perspective</p> |
---|
959 | </dd></dl> |
---|
960 | |
---|
961 | <dl class="method"> |
---|
962 | <dt id="sans.guiframe.dummyapp.TestPlugin.get_tools"> |
---|
963 | <tt class="descname">get_tools</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.get_tools" title="Permalink to this definition">¶</a></dt> |
---|
964 | <dd><p>Returns a set of menu entries for tools</p> |
---|
965 | </dd></dl> |
---|
966 | |
---|
967 | <dl class="method"> |
---|
968 | <dt id="sans.guiframe.dummyapp.TestPlugin.is_always_active"> |
---|
969 | <tt class="descname">is_always_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.is_always_active" title="Permalink to this definition">¶</a></dt> |
---|
970 | <dd><p>return True is this plugin is always active and it is local to guiframe |
---|
971 | even if the user is switching between perspectives</p> |
---|
972 | </dd></dl> |
---|
973 | |
---|
974 | <dl class="method"> |
---|
975 | <dt id="sans.guiframe.dummyapp.TestPlugin.is_in_use"> |
---|
976 | <tt class="descname">is_in_use</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.is_in_use" title="Permalink to this definition">¶</a></dt> |
---|
977 | <dd><dl class="docutils"> |
---|
978 | <dt>get a data id a list of data name if data data is</dt> |
---|
979 | <dd>currently used by the plugin and the name of the plugin</dd> |
---|
980 | </dl> |
---|
981 | <p>data_name = ‘None’ |
---|
982 | in_use = False |
---|
983 | example [(data_name, self.sub_menu)]</p> |
---|
984 | </dd></dl> |
---|
985 | |
---|
986 | <dl class="method"> |
---|
987 | <dt id="sans.guiframe.dummyapp.TestPlugin.load_data"> |
---|
988 | <tt class="descname">load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.load_data" title="Permalink to this definition">¶</a></dt> |
---|
989 | <dd><p>Load data</p> |
---|
990 | </dd></dl> |
---|
991 | |
---|
992 | <dl class="method"> |
---|
993 | <dt id="sans.guiframe.dummyapp.TestPlugin.load_folder"> |
---|
994 | <tt class="descname">load_folder</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.load_folder" title="Permalink to this definition">¶</a></dt> |
---|
995 | <dd><p>Load entire folder</p> |
---|
996 | </dd></dl> |
---|
997 | |
---|
998 | <dl class="method"> |
---|
999 | <dt id="sans.guiframe.dummyapp.TestPlugin.on_batch_selection"> |
---|
1000 | <tt class="descname">on_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.on_batch_selection" title="Permalink to this definition">¶</a></dt> |
---|
1001 | <dd><p>need to be overwritten by the derivated class</p> |
---|
1002 | </dd></dl> |
---|
1003 | |
---|
1004 | <dl class="method"> |
---|
1005 | <dt id="sans.guiframe.dummyapp.TestPlugin.on_perspective"> |
---|
1006 | <tt class="descname">on_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.on_perspective" title="Permalink to this definition">¶</a></dt> |
---|
1007 | <dd><p>Call back function for the perspective menu item. |
---|
1008 | We notify the parent window that the perspective |
---|
1009 | has changed.</p> |
---|
1010 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1011 | <col class="field-name" /> |
---|
1012 | <col class="field-body" /> |
---|
1013 | <tbody valign="top"> |
---|
1014 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – menu event</td> |
---|
1015 | </tr> |
---|
1016 | </tbody> |
---|
1017 | </table> |
---|
1018 | </dd></dl> |
---|
1019 | |
---|
1020 | <dl class="method"> |
---|
1021 | <dt id="sans.guiframe.dummyapp.TestPlugin.on_set_state_helper"> |
---|
1022 | <tt class="descname">on_set_state_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.on_set_state_helper" title="Permalink to this definition">¶</a></dt> |
---|
1023 | <dd><p>update state</p> |
---|
1024 | </dd></dl> |
---|
1025 | |
---|
1026 | <dl class="method"> |
---|
1027 | <dt id="sans.guiframe.dummyapp.TestPlugin.populate_file_menu"> |
---|
1028 | <tt class="descname">populate_file_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.populate_file_menu" title="Permalink to this definition">¶</a></dt> |
---|
1029 | <dd><p>Append menu item under file menu item of the frame</p> |
---|
1030 | </dd></dl> |
---|
1031 | |
---|
1032 | <dl class="method"> |
---|
1033 | <dt id="sans.guiframe.dummyapp.TestPlugin.populate_menu"> |
---|
1034 | <tt class="descname">populate_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.populate_menu" title="Permalink to this definition">¶</a></dt> |
---|
1035 | <dd><p>Create and return the list of application menu |
---|
1036 | items for the plug-in. |
---|
1037 | :param parent: parent window</p> |
---|
1038 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1039 | <col class="field-name" /> |
---|
1040 | <col class="field-body" /> |
---|
1041 | <tbody valign="top"> |
---|
1042 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">plug-in menu</td> |
---|
1043 | </tr> |
---|
1044 | </tbody> |
---|
1045 | </table> |
---|
1046 | </dd></dl> |
---|
1047 | |
---|
1048 | <dl class="method"> |
---|
1049 | <dt id="sans.guiframe.dummyapp.TestPlugin.post_init"> |
---|
1050 | <tt class="descname">post_init</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.post_init" title="Permalink to this definition">¶</a></dt> |
---|
1051 | <dd><p>Post initialization call back to close the loose ends</p> |
---|
1052 | </dd></dl> |
---|
1053 | |
---|
1054 | <dl class="method"> |
---|
1055 | <dt id="sans.guiframe.dummyapp.TestPlugin.set_batch_selection"> |
---|
1056 | <tt class="descname">set_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.set_batch_selection" title="Permalink to this definition">¶</a></dt> |
---|
1057 | <dd><p>the plugin to its batch state if flag is True</p> |
---|
1058 | </dd></dl> |
---|
1059 | |
---|
1060 | <dl class="method"> |
---|
1061 | <dt id="sans.guiframe.dummyapp.TestPlugin.set_data"> |
---|
1062 | <tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.set_data" title="Permalink to this definition">¶</a></dt> |
---|
1063 | <dd><p>receive a list of data and use it in the current perspective</p> |
---|
1064 | </dd></dl> |
---|
1065 | |
---|
1066 | <dl class="method"> |
---|
1067 | <dt id="sans.guiframe.dummyapp.TestPlugin.set_default_perspective"> |
---|
1068 | <tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.set_default_perspective" title="Permalink to this definition">¶</a></dt> |
---|
1069 | <dd><p>Call back method that True to notify the parent that the current plug-in |
---|
1070 | can be set as default perspective. |
---|
1071 | when returning False, the plug-in is not candidate for an automatic |
---|
1072 | default perspective setting</p> |
---|
1073 | </dd></dl> |
---|
1074 | |
---|
1075 | <dl class="method"> |
---|
1076 | <dt id="sans.guiframe.dummyapp.TestPlugin.set_is_active"> |
---|
1077 | <tt class="descname">set_is_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.set_is_active" title="Permalink to this definition">¶</a></dt> |
---|
1078 | <dd></dd></dl> |
---|
1079 | |
---|
1080 | <dl class="method"> |
---|
1081 | <dt id="sans.guiframe.dummyapp.TestPlugin.set_state"> |
---|
1082 | <tt class="descname">set_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.set_state" title="Permalink to this definition">¶</a></dt> |
---|
1083 | <dd><p>update state</p> |
---|
1084 | </dd></dl> |
---|
1085 | |
---|
1086 | <dl class="method"> |
---|
1087 | <dt id="sans.guiframe.dummyapp.TestPlugin.set_theory"> |
---|
1088 | <tt class="descname">set_theory</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.set_theory" title="Permalink to this definition">¶</a></dt> |
---|
1089 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
1090 | <col class="field-name" /> |
---|
1091 | <col class="field-body" /> |
---|
1092 | <tbody valign="top"> |
---|
1093 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>theory_list</strong> – list of information</td> |
---|
1094 | </tr> |
---|
1095 | </tbody> |
---|
1096 | </table> |
---|
1097 | <p>related to available theory state</p> |
---|
1098 | </dd></dl> |
---|
1099 | |
---|
1100 | <dl class="method"> |
---|
1101 | <dt id="sans.guiframe.dummyapp.TestPlugin.use_data"> |
---|
1102 | <tt class="descname">use_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dummyapp.TestPlugin.use_data" title="Permalink to this definition">¶</a></dt> |
---|
1103 | <dd><p>return True if these plugin use data</p> |
---|
1104 | </dd></dl> |
---|
1105 | |
---|
1106 | </dd></dl> |
---|
1107 | |
---|
1108 | </div> |
---|
1109 | </div> |
---|
1110 | |
---|
1111 | |
---|
1112 | </div> |
---|
1113 | </div> |
---|
1114 | </div> |
---|
1115 | <div class="sphinxsidebar"> |
---|
1116 | <div class="sphinxsidebarwrapper"> |
---|
1117 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
1118 | <ul> |
---|
1119 | <li><a class="reference internal" href="#">dummyapp</a><ul> |
---|
1120 | <li><a class="reference internal" href="#sans-guiframe-dummyapp"><tt class="docutils literal"><span class="pre">sans.guiframe.dummyapp</span></tt></a></li> |
---|
1121 | </ul> |
---|
1122 | </li> |
---|
1123 | </ul> |
---|
1124 | |
---|
1125 | <h4>Previous topic</h4> |
---|
1126 | <p class="topless"><a href="data_state.html" |
---|
1127 | title="previous chapter">data_state</a></p> |
---|
1128 | <h4>Next topic</h4> |
---|
1129 | <p class="topless"><a href="events.html" |
---|
1130 | title="next chapter">events</a></p> |
---|
1131 | <h3>This Page</h3> |
---|
1132 | <ul class="this-page-menu"> |
---|
1133 | <li><a href="../_sources/api/dummyapp.txt" |
---|
1134 | rel="nofollow">Show Source</a></li> |
---|
1135 | </ul> |
---|
1136 | <div id="searchbox" style="display: none"> |
---|
1137 | <h3>Quick search</h3> |
---|
1138 | <form class="search" action="../search.html" method="get"> |
---|
1139 | <input type="text" name="q" /> |
---|
1140 | <input type="submit" value="Go" /> |
---|
1141 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
1142 | <input type="hidden" name="area" value="default" /> |
---|
1143 | </form> |
---|
1144 | <p class="searchtip" style="font-size: 90%"> |
---|
1145 | Enter search terms or a module, class or function name. |
---|
1146 | </p> |
---|
1147 | </div> |
---|
1148 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
1149 | </div> |
---|
1150 | </div> |
---|
1151 | <div class="clearer"></div> |
---|
1152 | </div> |
---|
1153 | <div class="related"> |
---|
1154 | <h3>Navigation</h3> |
---|
1155 | <ul> |
---|
1156 | <li class="right" style="margin-right: 10px"> |
---|
1157 | <a href="../genindex.html" title="General Index" |
---|
1158 | >index</a></li> |
---|
1159 | <li class="right" > |
---|
1160 | <a href="../py-modindex.html" title="Python Module Index" |
---|
1161 | >modules</a> |</li> |
---|
1162 | <li class="right" > |
---|
1163 | <a href="events.html" title="events" |
---|
1164 | >next</a> |</li> |
---|
1165 | <li class="right" > |
---|
1166 | <a href="data_state.html" title="data_state" |
---|
1167 | >previous</a> |</li> |
---|
1168 | <li><a href="../index.html">guiframe 0.1.0 documentation</a> »</li> |
---|
1169 | <li><a href="index.html" >Reference</a> »</li> |
---|
1170 | </ul> |
---|
1171 | </div> |
---|
1172 | <div class="footer"> |
---|
1173 | © Copyright 2010, sans group. |
---|
1174 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
1175 | </div> |
---|
1176 | </body> |
---|
1177 | </html> |
---|