Context Navigation

source: wxmtxy/trunk/pydoc/wxmtxy.html @ 183

Last change on this file since 183 was 183, checked in by jemian, 15 years ago
move pydoc files to subdirectory
File size: 37.7 KB

Line
1
2	<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3	<html><head><title>Python: module wxmtxy</title>
4	</head><body bgcolor="#f0f0f8">
5
6	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7	<tr bgcolor="#7799ee">
8	<td valign=bottom> <br>
9	<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>wxmtxy</strong></big></big></font></td
10	><td align=right valign=bottom
11	><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/oxygen18/JEMIAN/Documents/eclipse/usaxs/wxmtxy/trunk/wxmtxy.py">/home/oxygen18/JEMIAN/Documents/eclipse/usaxs/wxmtxy/trunk/wxmtxy.py</a></font></td></tr></table>
12	<p><tt>start the wxmtxy GUI<br>
13	<br>
14	@version: <br>
15	########### SVN repository information ###################<br>
16	# $Date: 2010-06-02 18:14:09 -0500 (Wed, 02 Jun 2010) $<br>
17	# $Author: jemian $<br>
18	# $Revision: 178 $<br>
19	# $URL: https://subversion.xor.aps.anl.gov/bcdaext/wxmtxy/trunk/wxmtxy.py $<br>
20	# $Id: wxmtxy.py 178 2010-06-02 23:14:09Z jemian $<br>
21	########### SVN repository information ###################<br>
22	<br>
23	README<br>
24	<br>
25	wxmtxy (an EPICS GUI tool) provides support for an X,Y positioner <br>
26	(motor) pair by allowing users to define a table of known positions <br>
27	and providing a one-button click to drive a chosen X,Y pair to a specific<br>
28	table setting.  Also can record current position into a setting.<br>
29	<br>
30	Several sets of X,Y positioners can be configured.  (Each set is <br>
31	separate.)  In fact, the positioners do not have to be motors,<br>
32	but can be any type of EPICS PV that will accept a numeric value.<br>
33	<br>
34	<br>
35	wxmtxy is based on wxPython and relies on CaChannel to communicate <br>
36	with EPICS. <br>
37	<br>
38	In the Graphical User Interface (GUI), tooltips are provided for <br>
39	most items.  Moving and pausing the mouse over a widget (GUI <br>
40	component such as a button or a label) will cause a terse description <br>
41	of that widget to be displayed. Moving the mouse away will cause that <br>
42	tooltip to disappear. <br>
43	<br>
44	For more help, explanations are provided in the HTML pages.<br>
45	<br>
46	TRAC wiki<br>
47	@see: https://subversion.xor.aps.anl.gov/trac/bcdaext/wiki/wxmtxy<br>
48	<br>
49	@note: subversion checkout:  svn co https://subversion.xor.aps.anl.gov/bcdaext/wxmtxy/<br>
50	<br>
51	----<br>
52	@note: wxPython does not provide standard tear-off windows<br>
53	@see: <a href="http://wiki.python.org/moin/Distutils/Tutorial">http://wiki.python.org/moin/Distutils/Tutorial</a><br>
54	@see: <a href="http://www.py2exe.org/index.cgi/Tutorial">http://www.py2exe.org/index.cgi/Tutorial</a><br>
55	@note: for an undo example, see: <a href="http://wiki.wxpython.org/AnotherTutorial">http://wiki.wxpython.org/AnotherTutorial</a></tt></p>
56	<p>
57	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
58	<tr bgcolor="#aa55cc">
59	<td colspan=3 valign=bottom> <br>
60	<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
61
62	<tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td>
63	<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="pvConnect.html">pvConnect</a><br>
64	</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
65	</td><td width="25%" valign=top><a href="wx.html">wx</a><br>
66	</td><td width="25%" valign=top><a href="wxmtxy_root.html">wxmtxy_root</a><br>
67	</td></tr></table></td></tr></table><p>
68	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
69	<tr bgcolor="#ee77aa">
70	<td colspan=3 valign=bottom> <br>
71	<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
72
73	<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>
74	<td width="100%"><dl>
75	<dt><font face="helvetica, arial"><a href="wx._core.html#App">wx._core.App</a>(<a href="wx._core.html#PyApp">wx._core.PyApp</a>)
76	</font></dt><dd>
77	<dl>
78	<dt><font face="helvetica, arial"><a href="wxmtxy.html#BoaApp">BoaApp</a>
79	</font></dt></dl>
80	</dd>
81	</dl>
82	<p>
83	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
84	<tr bgcolor="#ffc8d8">
85	<td colspan=3 valign=bottom> <br>
86	<font color="#000000" face="helvetica, arial"><a name="BoaApp">class <strong>BoaApp</strong></a>(<a href="wx._core.html#App">wx._core.App</a>)</font></td></tr>
87
88	<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>
89	<td colspan=2><tt>Built using Boa-constructor (as a subclass of wx.<a href="wx._core.html#App">App</a>)<br> </tt></td></tr>
90	<tr><td> </td>
91	<td width="100%"><dl><dt>Method resolution order:</dt>
92	<dd><a href="wxmtxy.html#BoaApp">BoaApp</a></dd>
93	<dd><a href="wx._core.html#App">wx._core.App</a></dd>
94	<dd><a href="wx._core.html#PyApp">wx._core.PyApp</a></dd>
95	<dd><a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a></dd>
96	<dd><a href="wx._core.html#Object">wx._core.Object</a></dd>
97	<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
98	</dl>
99	<hr>
100	Methods defined here:<br>
101	<dl><dt><a name="BoaApp-OnInit"><strong>OnInit</strong></a>(self)</dt><dd><tt>demonstrate the use of this tool</tt></dd></dl>
102
103	<hr>
104	Methods inherited from <a href="wx._core.html#App">wx._core.App</a>:<br>
105	<dl><dt><a name="BoaApp-Destroy"><strong>Destroy</strong></a>(self)</dt></dl>
106
107	<dl><dt><a name="BoaApp-MainLoop"><strong>MainLoop</strong></a>(self)</dt><dd><tt>Execute the main GUI event loop</tt></dd></dl>
108
109	<dl><dt><a name="BoaApp-OnPreInit"><strong>OnPreInit</strong></a>(self)</dt><dd><tt>Things that must be done after _BootstrapApp has done its<br>
110	thing, but would be nice if they were already done by the time<br>
111	that OnInit is called.</tt></dd></dl>
112
113	<dl><dt><a name="BoaApp-RedirectStdio"><strong>RedirectStdio</strong></a>(self, filename<font color="#909090">=None</font>)</dt><dd><tt>Redirect sys.stdout and sys.stderr to a file or a popup window.</tt></dd></dl>
114
115	<dl><dt><a name="BoaApp-RestoreStdio"><strong>RestoreStdio</strong></a>(self)</dt></dl>
116
117	<dl><dt><a name="BoaApp-SetOutputWindowAttributes"><strong>SetOutputWindowAttributes</strong></a>(self, title<font color="#909090">=None</font>, pos<font color="#909090">=None</font>, size<font color="#909090">=None</font>)</dt><dd><tt>Set the title, position and/or size of the output window if<br>
118	the stdio has been redirected.  This should be called before<br>
119	any output would cause the output window to be created.</tt></dd></dl>
120
121	<dl><dt><a name="BoaApp-SetTopWindow"><strong>SetTopWindow</strong></a>(self, frame)</dt><dd><tt>Set the "main" top level window</tt></dd></dl>
122
123	<dl><dt><a name="BoaApp-__del__"><strong>__del__</strong></a>(self, destroy<font color="#909090">=<unbound method PyApp.<lambda>></font>)</dt></dl>
124
125	<dl><dt><a name="BoaApp-__init__"><strong>__init__</strong></a>(self, redirect<font color="#909090">=False</font>, filename<font color="#909090">=None</font>, useBestVisual<font color="#909090">=False</font>, clearSigInt<font color="#909090">=True</font>)</dt><dd><tt>Construct a ``wx.<a href="wx._core.html#App">App</a>`` object.  <br>
126	<br>
127	:param redirect: Should ``sys.stdout`` and ``sys.stderr`` be<br>
128	redirected?  Defaults to True on Windows and Mac, False<br>
129	otherwise.  If `filename` is None then output will be<br>
130	redirected to a window that pops up as needed.  (You can<br>
131	control what kind of window is created for the output by<br>
132	resetting the class variable ``outputWindowClass`` to a<br>
133	class of your choosing.)<br>
134	<br>
135	:param filename: The name of a file to redirect output to, if<br>
136	redirect is True.<br>
137	<br>
138	:param useBestVisual: Should the app try to use the best<br>
139	available visual provided by the system (only relevant on<br>
140	systems that have more than one visual.)  This parameter<br>
141	must be used instead of calling `SetUseBestVisual` later<br>
142	on because it must be set before the underlying GUI<br>
143	toolkit is initialized.<br>
144	<br>
145	:param clearSigInt: Should SIGINT be cleared?  This allows the<br>
146	app to terminate upon a Ctrl-C in the console like other<br>
147	GUI apps will.<br>
148	<br>
149	:note: You should override OnInit to do applicaition<br>
150	initialization to ensure that the system, toolkit and<br>
151	wxWidgets are fully initialized.</tt></dd></dl>
152
153	<hr>
154	Data and other attributes inherited from <a href="wx._core.html#App">wx._core.App</a>:<br>
155	<dl><dt><strong>outputWindowClass</strong> = <class wx._core.PyOnDemandOutputWindow at 0xf7bb4b3c><dd><tt>A class that can be used for redirecting Python's stdout and<br>
156	stderr streams.  It will do nothing until something is wrriten to<br>
157	the stream at which point it will create a Frame with a text area<br>
158	and write the text there.</tt></dl>
159
160	<hr>
161	Methods inherited from <a href="wx._core.html#PyApp">wx._core.PyApp</a>:<br>
162	<dl><dt><a name="BoaApp-Dispatch"><strong>Dispatch</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-Dispatch">Dispatch</a>(self) -> bool<br>
163	<br>
164	Process the first event in the event queue (blocks until an event<br>
165	appears if there are none currently)</tt></dd></dl>
166
167	<dl><dt><a name="BoaApp-Exit"><strong>Exit</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-Exit">Exit</a>(self)<br>
168	<br>
169	Exit the main loop thus terminating the application.<br>
170	:see: `wx.Exit`</tt></dd></dl>
171
172	<dl><dt><a name="BoaApp-ExitMainLoop"><strong>ExitMainLoop</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-ExitMainLoop">ExitMainLoop</a>(self)<br>
173	<br>
174	Exit the main GUI loop during the next iteration of the main<br>
175	loop, (i.e. it does not stop the program immediately!)</tt></dd></dl>
176
177	<dl><dt><a name="BoaApp-GetAppName"><strong>GetAppName</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetAppName">GetAppName</a>(self) -> String<br>
178	<br>
179	Get the application name.</tt></dd></dl>
180
181	<dl><dt><a name="BoaApp-GetAssertMode"><strong>GetAssertMode</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetAssertMode">GetAssertMode</a>(self) -> int<br>
182	<br>
183	Get the current OnAssert behaviour setting.</tt></dd></dl>
184
185	<dl><dt><a name="BoaApp-GetClassName"><strong>GetClassName</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetClassName">GetClassName</a>(self) -> String<br>
186	<br>
187	Get the application's class name.</tt></dd></dl>
188
189	<dl><dt><a name="BoaApp-GetExitOnFrameDelete"><strong>GetExitOnFrameDelete</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetExitOnFrameDelete">GetExitOnFrameDelete</a>(self) -> bool<br>
190	<br>
191	Get the current exit behaviour setting.</tt></dd></dl>
192
193	<dl><dt><a name="BoaApp-GetLayoutDirection"><strong>GetLayoutDirection</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetLayoutDirection">GetLayoutDirection</a>(self) -> int<br>
194	<br>
195	Return the layout direction for the current locale.</tt></dd></dl>
196
197	<dl><dt><a name="BoaApp-GetPrintMode"><strong>GetPrintMode</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetPrintMode">GetPrintMode</a>(self) -> int</tt></dd></dl>
198
199	<dl><dt><a name="BoaApp-GetTopWindow"><strong>GetTopWindow</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetTopWindow">GetTopWindow</a>(self) -> Window<br>
200	<br>
201	Return the main top level window (if it hadn't been set previously<br>
202	with <a href="#BoaApp-SetTopWindow">SetTopWindow</a>(), will return just some top level window and, if<br>
203	there not any, will return None)</tt></dd></dl>
204
205	<dl><dt><a name="BoaApp-GetTraits"><strong>GetTraits</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetTraits">GetTraits</a>(self) -> wxAppTraits<br>
206	<br>
207	Return (and create if necessary) the app traits object to which we<br>
208	delegate for everything which either should be configurable by the<br>
209	user (then he can change the default behaviour simply by overriding<br>
210	CreateTraits() and returning his own traits object) or which is<br>
211	GUI/console dependent as then wx.AppTraits allows us to abstract the<br>
212	differences behind the common facade.<br>
213	<br>
214	:todo: Add support for overriding CreateAppTraits in wxPython.</tt></dd></dl>
215
216	<dl><dt><a name="BoaApp-GetUseBestVisual"><strong>GetUseBestVisual</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetUseBestVisual">GetUseBestVisual</a>(self) -> bool<br>
217	<br>
218	Get current UseBestVisual setting.</tt></dd></dl>
219
220	<dl><dt><a name="BoaApp-GetVendorName"><strong>GetVendorName</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetVendorName">GetVendorName</a>(self) -> String<br>
221	<br>
222	Get the application's vendor name.</tt></dd></dl>
223
224	<dl><dt><a name="BoaApp-IsActive"><strong>IsActive</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-IsActive">IsActive</a>(self) -> bool<br>
225	<br>
226	Return True if our app has focus.</tt></dd></dl>
227
228	<dl><dt><a name="BoaApp-Pending"><strong>Pending</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-Pending">Pending</a>(self) -> bool<br>
229	<br>
230	Returns True if there are unprocessed events in the event queue.</tt></dd></dl>
231
232	<dl><dt><a name="BoaApp-ProcessIdle"><strong>ProcessIdle</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-ProcessIdle">ProcessIdle</a>(self) -> bool<br>
233	<br>
234	Called from the MainLoop when the application becomes idle (there are<br>
235	no pending events) and sends a `wx.IdleEvent` to all interested<br>
236	parties.  Returns True if more idle events are needed, False if not.</tt></dd></dl>
237
238	<dl><dt><a name="BoaApp-ProcessPendingEvents"><strong>ProcessPendingEvents</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-ProcessPendingEvents">ProcessPendingEvents</a>(self)<br>
239	<br>
240	Process all events in the Pending Events list -- it is necessary to<br>
241	call this function to process posted events. This normally happens<br>
242	during each event loop iteration.</tt></dd></dl>
243
244	<dl><dt><a name="BoaApp-SendIdleEvents"><strong>SendIdleEvents</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SendIdleEvents">SendIdleEvents</a>(self, Window win, IdleEvent event) -> bool<br>
245	<br>
246	Send idle event to window and all subwindows.  Returns True if more<br>
247	idle time is requested.</tt></dd></dl>
248
249	<dl><dt><a name="BoaApp-SetAppName"><strong>SetAppName</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetAppName">SetAppName</a>(self, String name)<br>
250	<br>
251	Set the application name. This value may be used automatically by<br>
252	`wx.Config` and such.</tt></dd></dl>
253
254	<dl><dt><a name="BoaApp-SetAssertMode"><strong>SetAssertMode</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetAssertMode">SetAssertMode</a>(self, int mode)<br>
255	<br>
256	Set the OnAssert behaviour for debug and hybrid builds.</tt></dd></dl>
257
258	<dl><dt><a name="BoaApp-SetClassName"><strong>SetClassName</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetClassName">SetClassName</a>(self, String name)<br>
259	<br>
260	Set the application's class name. This value may be used for<br>
261	X-resources if applicable for the platform</tt></dd></dl>
262
263	<dl><dt><a name="BoaApp-SetExitOnFrameDelete"><strong>SetExitOnFrameDelete</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetExitOnFrameDelete">SetExitOnFrameDelete</a>(self, bool flag)<br>
264	<br>
265	Control the exit behaviour: by default, the program will exit the main<br>
266	loop (and so, usually, terminate) when the last top-level program<br>
267	window is deleted.  Beware that if you disable this behaviour (with<br>
268	<a href="#BoaApp-SetExitOnFrameDelete">SetExitOnFrameDelete</a>(False)), you'll have to call <a href="#BoaApp-ExitMainLoop">ExitMainLoop</a>()<br>
269	explicitly from somewhere.</tt></dd></dl>
270
271	<dl><dt><a name="BoaApp-SetPrintMode"><strong>SetPrintMode</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetPrintMode">SetPrintMode</a>(self, int mode)</tt></dd></dl>
272
273	<dl><dt><a name="BoaApp-SetUseBestVisual"><strong>SetUseBestVisual</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetUseBestVisual">SetUseBestVisual</a>(self, bool flag, bool forceTrueColour=False)<br>
274	<br>
275	Set whether the app should try to use the best available visual on<br>
276	systems where more than one is available, (Sun, SGI, XFree86 4, etc.)</tt></dd></dl>
277
278	<dl><dt><a name="BoaApp-SetVendorName"><strong>SetVendorName</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetVendorName">SetVendorName</a>(self, String name)<br>
279	<br>
280	Set the application's vendor name. This value may be used<br>
281	automatically by `wx.Config` and such.</tt></dd></dl>
282
283	<dl><dt><a name="BoaApp-WakeUpIdle"><strong>WakeUpIdle</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-WakeUpIdle">WakeUpIdle</a>(self)<br>
284	<br>
285	Make sure that idle events are sent again.<br>
286	:see: `wx.WakeUpIdle`</tt></dd></dl>
287
288	<dl><dt><a name="BoaApp-Yield"><strong>Yield</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-Yield">Yield</a>(self, bool onlyIfNeeded=False) -> bool<br>
289	<br>
290	Process all currently pending events right now, instead of waiting<br>
291	until return to the event loop.  It is an error to call ``Yield``<br>
292	recursively unless the value of ``onlyIfNeeded`` is True.<br>
293	<br>
294	:warning: This function is dangerous as it can lead to unexpected<br>
295	reentrancies (i.e. when called from an event handler it may<br>
296	result in calling the same event handler again), use with<br>
297	extreme care or, better, don't use at all!<br>
298	<br>
299	:see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`</tt></dd></dl>
300
301	<dl><dt><a name="BoaApp-__repr__"><strong>__repr__</strong></a> = _swig_repr(self)</dt></dl>
302
303	<hr>
304	Static methods inherited from <a href="wx._core.html#PyApp">wx._core.PyApp</a>:<br>
305	<dl><dt><a name="BoaApp-GetComCtl32Version"><strong>GetComCtl32Version</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetComCtl32Version">GetComCtl32Version</a>() -> int<br>
306	<br>
307	Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if<br>
308	it wasn't found at all.  Raises an exception on non-Windows platforms.</tt></dd></dl>
309
310	<dl><dt><a name="BoaApp-GetMacAboutMenuItemId"><strong>GetMacAboutMenuItemId</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetMacAboutMenuItemId">GetMacAboutMenuItemId</a>() -> long</tt></dd></dl>
311
312	<dl><dt><a name="BoaApp-GetMacExitMenuItemId"><strong>GetMacExitMenuItemId</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetMacExitMenuItemId">GetMacExitMenuItemId</a>() -> long</tt></dd></dl>
313
314	<dl><dt><a name="BoaApp-GetMacHelpMenuTitleName"><strong>GetMacHelpMenuTitleName</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetMacHelpMenuTitleName">GetMacHelpMenuTitleName</a>() -> String</tt></dd></dl>
315
316	<dl><dt><a name="BoaApp-GetMacPreferencesMenuItemId"><strong>GetMacPreferencesMenuItemId</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetMacPreferencesMenuItemId">GetMacPreferencesMenuItemId</a>() -> long</tt></dd></dl>
317
318	<dl><dt><a name="BoaApp-GetMacSupportPCMenuShortcuts"><strong>GetMacSupportPCMenuShortcuts</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetMacSupportPCMenuShortcuts">GetMacSupportPCMenuShortcuts</a>() -> bool</tt></dd></dl>
319
320	<dl><dt><a name="BoaApp-IsDisplayAvailable"><strong>IsDisplayAvailable</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-IsDisplayAvailable">IsDisplayAvailable</a>() -> bool<br>
321	<br>
322	Tests if it is possible to create a GUI in the current environment.<br>
323	This will mean different things on the different platforms.<br>
324	<br>
325	* On X Windows systems this function will return ``False`` if it is<br>
326	not able to open a connection to the X display, which can happen<br>
327	if $DISPLAY is not set, or is not set correctly.<br>
328	<br>
329	* On Mac OS X a ``False`` return value will mean that wx is not<br>
330	able to access the window manager, which can happen if logged in<br>
331	remotely or if running from the normal version of python instead<br>
332	of the framework version, (i.e., pythonw.)<br>
333	<br>
334	* On MS Windows...</tt></dd></dl>
335
336	<dl><dt><a name="BoaApp-IsMainLoopRunning"><strong>IsMainLoopRunning</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-IsMainLoopRunning">IsMainLoopRunning</a>() -> bool<br>
337	<br>
338	Returns True if we're running the main loop, i.e. if the events can<br>
339	currently be dispatched.</tt></dd></dl>
340
341	<dl><dt><a name="BoaApp-SetMacAboutMenuItemId"><strong>SetMacAboutMenuItemId</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetMacAboutMenuItemId">SetMacAboutMenuItemId</a>(long val)</tt></dd></dl>
342
343	<dl><dt><a name="BoaApp-SetMacExitMenuItemId"><strong>SetMacExitMenuItemId</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetMacExitMenuItemId">SetMacExitMenuItemId</a>(long val)</tt></dd></dl>
344
345	<dl><dt><a name="BoaApp-SetMacHelpMenuTitleName"><strong>SetMacHelpMenuTitleName</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetMacHelpMenuTitleName">SetMacHelpMenuTitleName</a>(String val)</tt></dd></dl>
346
347	<dl><dt><a name="BoaApp-SetMacPreferencesMenuItemId"><strong>SetMacPreferencesMenuItemId</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetMacPreferencesMenuItemId">SetMacPreferencesMenuItemId</a>(long val)</tt></dd></dl>
348
349	<dl><dt><a name="BoaApp-SetMacSupportPCMenuShortcuts"><strong>SetMacSupportPCMenuShortcuts</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetMacSupportPCMenuShortcuts">SetMacSupportPCMenuShortcuts</a>(bool val)</tt></dd></dl>
350
351	<hr>
352	Data descriptors inherited from <a href="wx._core.html#PyApp">wx._core.PyApp</a>:<br>
353	<dl><dt><strong>Active</strong></dt>
354	<dd><tt>IsActive(self) -> bool<br>
355	<br>
356	Return True if our app has focus.</tt></dd>
357	</dl>
358	<dl><dt><strong>AppName</strong></dt>
359	<dd><tt>See `GetAppName` and `SetAppName`</tt></dd>
360	</dl>
361	<dl><dt><strong>AssertMode</strong></dt>
362	<dd><tt>See `GetAssertMode` and `SetAssertMode`</tt></dd>
363	</dl>
364	<dl><dt><strong>ClassName</strong></dt>
365	<dd><tt>See `GetClassName` and `SetClassName`</tt></dd>
366	</dl>
367	<dl><dt><strong>ExitOnFrameDelete</strong></dt>
368	<dd><tt>See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`</tt></dd>
369	</dl>
370	<dl><dt><strong>LayoutDirection</strong></dt>
371	<dd><tt>See `GetLayoutDirection`</tt></dd>
372	</dl>
373	<dl><dt><strong>PrintMode</strong></dt>
374	<dd><tt>See `GetPrintMode` and `SetPrintMode`</tt></dd>
375	</dl>
376	<dl><dt><strong>TopWindow</strong></dt>
377	<dd><tt>See `GetTopWindow` and `SetTopWindow`</tt></dd>
378	</dl>
379	<dl><dt><strong>Traits</strong></dt>
380	<dd><tt>See `GetTraits`</tt></dd>
381	</dl>
382	<dl><dt><strong>UseBestVisual</strong></dt>
383	<dd><tt>See `GetUseBestVisual` and `SetUseBestVisual`</tt></dd>
384	</dl>
385	<dl><dt><strong>VendorName</strong></dt>
386	<dd><tt>See `GetVendorName` and `SetVendorName`</tt></dd>
387	</dl>
388	<dl><dt><strong>thisown</strong></dt>
389	<dd><tt>The membership flag</tt></dd>
390	</dl>
391	<hr>
392	Data and other attributes inherited from <a href="wx._core.html#PyApp">wx._core.PyApp</a>:<br>
393	<dl><dt><strong>__swig_destroy__</strong> = <built-in function delete_PyApp></dl>
394
395	<hr>
396	Methods inherited from <a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a>:<br>
397	<dl><dt><a name="BoaApp-AddPendingEvent"><strong>AddPendingEvent</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-AddPendingEvent">AddPendingEvent</a>(self, Event event)</tt></dd></dl>
398
399	<dl><dt><a name="BoaApp-Bind"><strong>Bind</strong></a>(self, event, handler, source<font color="#909090">=None</font>, id<font color="#909090">=-1</font>, id2<font color="#909090">=-1</font>)</dt><dd><tt>Bind an event to an event handler.<br>
400	<br>
401	:param event: One of the EVT_* objects that specifies the<br>
402	type of event to bind,<br>
403	<br>
404	:param handler: A callable object to be invoked when the<br>
405	event is delivered to self.  Pass None to<br>
406	disconnect an event handler.<br>
407	<br>
408	:param source: Sometimes the event originates from a<br>
409	different window than self, but you still<br>
410	want to catch it in self.  (For example, a<br>
411	button event delivered to a frame.)  By<br>
412	passing the source of the event, the event<br>
413	handling system is able to differentiate<br>
414	between the same event type from different<br>
415	controls.<br>
416	<br>
417	:param id: Used to spcify the event source by ID instead<br>
418	of instance.<br>
419	<br>
420	:param id2: Used when it is desirable to bind a handler<br>
421	to a range of IDs, such as with EVT_MENU_RANGE.</tt></dd></dl>
422
423	<dl><dt><a name="BoaApp-Connect"><strong>Connect</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-Connect">Connect</a>(self, int id, int lastId, int eventType, PyObject func)</tt></dd></dl>
424
425	<dl><dt><a name="BoaApp-Disconnect"><strong>Disconnect</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-Disconnect">Disconnect</a>(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool</tt></dd></dl>
426
427	<dl><dt><a name="BoaApp-GetEvtHandlerEnabled"><strong>GetEvtHandlerEnabled</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetEvtHandlerEnabled">GetEvtHandlerEnabled</a>(self) -> bool</tt></dd></dl>
428
429	<dl><dt><a name="BoaApp-GetNextHandler"><strong>GetNextHandler</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetNextHandler">GetNextHandler</a>(self) -> EvtHandler</tt></dd></dl>
430
431	<dl><dt><a name="BoaApp-GetPreviousHandler"><strong>GetPreviousHandler</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-GetPreviousHandler">GetPreviousHandler</a>(self) -> EvtHandler</tt></dd></dl>
432
433	<dl><dt><a name="BoaApp-ProcessEvent"><strong>ProcessEvent</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-ProcessEvent">ProcessEvent</a>(self, Event event) -> bool</tt></dd></dl>
434
435	<dl><dt><a name="BoaApp-SetEvtHandlerEnabled"><strong>SetEvtHandlerEnabled</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetEvtHandlerEnabled">SetEvtHandlerEnabled</a>(self, bool enabled)</tt></dd></dl>
436
437	<dl><dt><a name="BoaApp-SetNextHandler"><strong>SetNextHandler</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetNextHandler">SetNextHandler</a>(self, EvtHandler handler)</tt></dd></dl>
438
439	<dl><dt><a name="BoaApp-SetPreviousHandler"><strong>SetPreviousHandler</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-SetPreviousHandler">SetPreviousHandler</a>(self, EvtHandler handler)</tt></dd></dl>
440
441	<dl><dt><a name="BoaApp-Unbind"><strong>Unbind</strong></a>(self, event, source<font color="#909090">=None</font>, id<font color="#909090">=-1</font>, id2<font color="#909090">=-1</font>)</dt><dd><tt>Disconencts the event handler binding for event from self.<br>
442	Returns True if successful.</tt></dd></dl>
443
444	<hr>
445	Data descriptors inherited from <a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a>:<br>
446	<dl><dt><strong>EvtHandlerEnabled</strong></dt>
447	<dd><tt>See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`</tt></dd>
448	</dl>
449	<dl><dt><strong>NextHandler</strong></dt>
450	<dd><tt>See `GetNextHandler` and `SetNextHandler`</tt></dd>
451	</dl>
452	<dl><dt><strong>PreviousHandler</strong></dt>
453	<dd><tt>See `GetPreviousHandler` and `SetPreviousHandler`</tt></dd>
454	</dl>
455	<hr>
456	Methods inherited from <a href="wx._core.html#Object">wx._core.Object</a>:<br>
457	<dl><dt><a name="BoaApp-IsSameAs"><strong>IsSameAs</strong></a>(args, *kwargs)</dt><dd><tt><a href="#BoaApp-IsSameAs">IsSameAs</a>(self, Object p) -> bool<br>
458	<br>
459	For wx.Objects that use C++ reference counting internally, this method<br>
460	can be used to determine if two objects are referencing the same data<br>
461	object.</tt></dd></dl>
462
463	<hr>
464	Data descriptors inherited from <a href="wx._core.html#Object">wx._core.Object</a>:<br>
465	<dl><dt><strong>__dict__</strong></dt>
466	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
467	</dl>
468	<dl><dt><strong>__weakref__</strong></dt>
469	<dd><tt>list of weak references to the object (if defined)</tt></dd>
470	</dl>
471	</td></tr></table></td></tr></table><p>
472	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
473	<tr bgcolor="#eeaa77">
474	<td colspan=3 valign=bottom> <br>
475	<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
476
477	<tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td>
478	<td width="100%"><dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>operate the tool</tt></dd></dl>
479	<dl><dt><a name="-on_exit"><strong>on_exit</strong></a>(timer, epics_db)</dt><dd><tt>Exit handler to stop the ca.poll()<br>
480	@param timer: CaPollWx object<br>
481	@param epics_db: Python list of pvConnect.EpicsPv objects to be released</tt></dd></dl>
482	</td></tr></table><p>
483	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
484	<tr bgcolor="#55aa55">
485	<td colspan=3 valign=bottom> <br>
486	<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
487
488	<tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td>
489	<td width="100%"><strong>modules</strong> = {u'wxmtxy_htmlview': [0, 'HtmlView to view HTML-formatted help files', u'wxmtxy_htmlview.py'], u'wxmtxy_pair': [0, 'configuration for X,Y pair of EPICS positioners', u'wxmtxy_pair.py'], u'wxmtxy_pvsetup': [0, 'configure EPICS for X,Y pair', u'wxmtxy_pvsetup.py'], u'wxmtxy_root': [1, 'Main frame of Application', u'wxmtxy_root.py'], u'wxmtxy_row': [0, 'one row of settings', u'wxmtxy_row.py'], u'wxmtxy_tab': [0, 'set of rows with positioner settings', u'wxmtxy_tab.py']}</td></tr></table>
490	</body></html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: