1 | |
---|
2 | <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
---|
3 | <html><head><title>Python: module wxmtxy_pair</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_pair</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_pair.py">/home/oxygen18/JEMIAN/Documents/eclipse/usaxs/wxmtxy/trunk/wxmtxy_pair.py</a></font></td></tr></table> |
---|
12 | <p><tt>Define the GUI elements and interface for one X,Y pair<br> |
---|
13 | <br> |
---|
14 | @version: <br> |
---|
15 | ########### SVN repository information ###################<br> |
---|
16 | # $Date: 2010-06-03 16:04:15 -0500 (Thu, 03 Jun 2010) $<br> |
---|
17 | # $Author: jemian $<br> |
---|
18 | # $Revision: 184 $<br> |
---|
19 | # $URL: https://subversion.xor.aps.anl.gov/bcdaext/wxmtxy/trunk/wxmtxy_pair.py $<br> |
---|
20 | # $Id: wxmtxy_pair.py 184 2010-06-03 21:04:15Z jemian $<br> |
---|
21 | ########### SVN repository information ###################</tt></p> |
---|
22 | <p> |
---|
23 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
---|
24 | <tr bgcolor="#aa55cc"> |
---|
25 | <td colspan=3 valign=bottom> <br> |
---|
26 | <font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
---|
27 | |
---|
28 | <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
---|
29 | <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="copy.html">copy</a><br> |
---|
30 | <a href="pprint.html">pprint</a><br> |
---|
31 | </td><td width="25%" valign=top><a href="wx.html">wx</a><br> |
---|
32 | <a href="wxmtxy_axis.html">wxmtxy_axis</a><br> |
---|
33 | </td><td width="25%" valign=top><a href="wxmtxy_row.html">wxmtxy_row</a><br> |
---|
34 | <a href="wxmtxy_tab.html">wxmtxy_tab</a><br> |
---|
35 | </td><td width="25%" valign=top></td></tr></table></td></tr></table><p> |
---|
36 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
---|
37 | <tr bgcolor="#ee77aa"> |
---|
38 | <td colspan=3 valign=bottom> <br> |
---|
39 | <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
---|
40 | |
---|
41 | <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
---|
42 | <td width="100%"><dl> |
---|
43 | <dt><font face="helvetica, arial"><a href="wx._windows.html#Panel">wx._windows.Panel</a>(<a href="wx._core.html#Window">wx._core.Window</a>) |
---|
44 | </font></dt><dd> |
---|
45 | <dl> |
---|
46 | <dt><font face="helvetica, arial"><a href="wxmtxy_pair.html#XYpair">XYpair</a> |
---|
47 | </font></dt></dl> |
---|
48 | </dd> |
---|
49 | </dl> |
---|
50 | <p> |
---|
51 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
---|
52 | <tr bgcolor="#ffc8d8"> |
---|
53 | <td colspan=3 valign=bottom> <br> |
---|
54 | <font color="#000000" face="helvetica, arial"><a name="XYpair">class <strong>XYpair</strong></a>(<a href="wx._windows.html#Panel">wx._windows.Panel</a>)</font></td></tr> |
---|
55 | |
---|
56 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
---|
57 | <td colspan=2><tt>Table of settings for a specified X,Y pair of EPICS motors<br> </tt></td></tr> |
---|
58 | <tr><td> </td> |
---|
59 | <td width="100%"><dl><dt>Method resolution order:</dt> |
---|
60 | <dd><a href="wxmtxy_pair.html#XYpair">XYpair</a></dd> |
---|
61 | <dd><a href="wx._windows.html#Panel">wx._windows.Panel</a></dd> |
---|
62 | <dd><a href="wx._core.html#Window">wx._core.Window</a></dd> |
---|
63 | <dd><a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a></dd> |
---|
64 | <dd><a href="wx._core.html#Object">wx._core.Object</a></dd> |
---|
65 | <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
---|
66 | </dl> |
---|
67 | <hr> |
---|
68 | Methods defined here:<br> |
---|
69 | <dl><dt><a name="XYpair-CallbackDMOV"><strong>CallbackDMOV</strong></a>(self, epics_args, user_args)</dt><dd><tt>receive a callback on the DMOV field</tt></dd></dl> |
---|
70 | |
---|
71 | <dl><dt><a name="XYpair-CallbackPositions"><strong>CallbackPositions</strong></a>(self, epics_args, user_args)</dt><dd><tt>receive a callback on the VAL and RBV fields</tt></dd></dl> |
---|
72 | |
---|
73 | <dl><dt><a name="XYpair-CallbackTitle"><strong>CallbackTitle</strong></a>(self, epics_args, user_args)</dt><dd><tt>receive a callback on the DESC and EGU fields</tt></dd></dl> |
---|
74 | |
---|
75 | <dl><dt><a name="XYpair-ConnectEpics"><strong>ConnectEpics</strong></a>(self)</dt><dd><tt>try to connect the XY_pair PV names with EPICS</tt></dd></dl> |
---|
76 | |
---|
77 | <dl><dt><a name="XYpair-DeleteTab"><strong>DeleteTab</strong></a>(self)</dt><dd><tt>Delete the given tab</tt></dd></dl> |
---|
78 | |
---|
79 | <dl><dt><a name="XYpair-GetAxisTitleX"><strong>GetAxisTitleX</strong></a>(self)</dt><dd><tt>@return X axis title</tt></dd></dl> |
---|
80 | |
---|
81 | <dl><dt><a name="XYpair-GetAxisTitleY"><strong>GetAxisTitleY</strong></a>(self)</dt><dd><tt>@return Y axis title</tt></dd></dl> |
---|
82 | |
---|
83 | <dl><dt><a name="XYpair-GetEpicsConfig"><strong>GetEpicsConfig</strong></a>(self)</dt><dd><tt>@return deep copy of EPICS PV configuration</tt></dd></dl> |
---|
84 | |
---|
85 | <dl><dt><a name="XYpair-GetPageTitle"><strong>GetPageTitle</strong></a>(self)</dt><dd><tt>@return page title</tt></dd></dl> |
---|
86 | |
---|
87 | <dl><dt><a name="XYpair-GetRbvXY"><strong>GetRbvXY</strong></a>(self)</dt><dd><tt>@return readback values for X and Y as a tuple</tt></dd></dl> |
---|
88 | |
---|
89 | <dl><dt><a name="XYpair-GetSelection"><strong>GetSelection</strong></a>(self)</dt><dd><tt>@return index number of the selected tab object</tt></dd></dl> |
---|
90 | |
---|
91 | <dl><dt><a name="XYpair-GetTabSelection"><strong>GetTabSelection</strong></a>(self)</dt><dd><tt>@return selected tab object</tt></dd></dl> |
---|
92 | |
---|
93 | <dl><dt><a name="XYpair-GetTabText"><strong>GetTabText</strong></a>(self, tabnum)</dt><dd><tt>return the text of the tab numbered tabnum<br> |
---|
94 | @param tabnum: [int] index of selected tab</tt></dd></dl> |
---|
95 | |
---|
96 | <dl><dt><a name="XYpair-MoveAxes"><strong>MoveAxes</strong></a>(self, x, y)</dt><dd><tt>Command both axes to move to new position<br> |
---|
97 | @param x: [float] new X position<br> |
---|
98 | @param y: [float] new Y position</tt></dd></dl> |
---|
99 | |
---|
100 | <dl><dt><a name="XYpair-NewTab"><strong>NewTab</strong></a>(self, newrow<font color="#909090">=True</font>)</dt><dd><tt>make a new tab<br> |
---|
101 | @param newrow: [Boolean] option to create a first row</tt></dd></dl> |
---|
102 | |
---|
103 | <dl><dt><a name="XYpair-OnStopButton"><strong>OnStopButton</strong></a>(self, event)</dt><dd><tt>user requested to stop the X and Y motors<br> |
---|
104 | @param event: wxPython event object</tt></dd></dl> |
---|
105 | |
---|
106 | <dl><dt><a name="XYpair-ReleaseEpics"><strong>ReleaseEpics</strong></a>(self)</dt><dd><tt>release connections with the XY_pair EPICS PVs<br> |
---|
107 | @note: When will this be called?</tt></dd></dl> |
---|
108 | |
---|
109 | <dl><dt><a name="XYpair-SetAxisTitles"><strong>SetAxisTitles</strong></a>(self, x_title, y_title)</dt><dd><tt>define the axis titles<br> |
---|
110 | @param x_title: [string] X axis title<br> |
---|
111 | @param y_title: [string] Y axis title</tt></dd></dl> |
---|
112 | |
---|
113 | <dl><dt><a name="XYpair-SetEpicsConfig"><strong>SetEpicsConfig</strong></a>(self, config)</dt><dd><tt>define the EPICS PVs from a configuration<br> |
---|
114 | @param config: Python dictionary with axes configurations</tt></dd></dl> |
---|
115 | |
---|
116 | <dl><dt><a name="XYpair-SetMotorColor"><strong>SetMotorColor</strong></a>(self, axis, state)</dt><dd><tt>change the background color of the RBV and VAL widgets<br> |
---|
117 | <br> |
---|
118 | @param axis: [string] either "x" or "y"<br> |
---|
119 | @param state: [Boolean], color is green if state == False, neutral if True</tt></dd></dl> |
---|
120 | |
---|
121 | <dl><dt><a name="XYpair-SetPageTitle"><strong>SetPageTitle</strong></a>(self, title)</dt><dd><tt>define the page title<br> |
---|
122 | @param title: [string] new page title</tt></dd></dl> |
---|
123 | |
---|
124 | <dl><dt><a name="XYpair-SetTabText"><strong>SetTabText</strong></a>(self, tabnum, text)</dt><dd><tt>set the text of the tab numbered tabnum<br> |
---|
125 | @param tabnum: [int] index of selected tab<br> |
---|
126 | @param text: [string] new text</tt></dd></dl> |
---|
127 | |
---|
128 | <dl><dt><a name="XYpair-StopAxes"><strong>StopAxes</strong></a>(self)</dt><dd><tt>Send a stop to both axes</tt></dd></dl> |
---|
129 | |
---|
130 | <dl><dt><a name="XYpair-TabHandler"><strong>TabHandler</strong></a>(self, theTab, theRow, command)</dt><dd><tt>Callback function to handle a command from a tab<br> |
---|
131 | @param theTab: wxmtxy_tab.Tab object<br> |
---|
132 | @param theRow: wxmtxy_row.Row object<br> |
---|
133 | @param command: [string] Row button action to pass upward for handling</tt></dd></dl> |
---|
134 | |
---|
135 | <dl><dt><a name="XYpair-__init__"><strong>__init__</strong></a>(self, parent, name, root, rootCallback, newtab<font color="#909090">=False</font>)</dt><dd><tt>initialize an instance of this class<br> |
---|
136 | @param parent: object that owns this class<br> |
---|
137 | @param name: display test that describes this <a href="#XYpair">XYpair</a><br> |
---|
138 | @param root: root object<br> |
---|
139 | @param rootCallback: routine in the parent to handle Button events from the Tab<br> |
---|
140 | @param newtab: [Boolean] create a default Tab group?</tt></dd></dl> |
---|
141 | |
---|
142 | <dl><dt><a name="XYpair-__init_names__"><strong>__init_names__</strong></a>(self)</dt><dd><tt>cross-reference the widgets to a dictionary</tt></dd></dl> |
---|
143 | |
---|
144 | <hr> |
---|
145 | Data and other attributes defined here:<br> |
---|
146 | <dl><dt><strong>COLOR_MOVING</strong> = wx.Colour(179, 250, 142, 255)</dl> |
---|
147 | |
---|
148 | <dl><dt><strong>COLOR_NOT_MOVING</strong> = wx.Colour(237, 233, 227, 255)</dl> |
---|
149 | |
---|
150 | <hr> |
---|
151 | Methods inherited from <a href="wx._windows.html#Panel">wx._windows.Panel</a>:<br> |
---|
152 | <dl><dt><a name="XYpair-Create"><strong>Create</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Create">Create</a>(self, Window parent, int id=-1, Point pos=DefaultPosition, <br> |
---|
153 | Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, <br> |
---|
154 | String name=PanelNameStr) -> bool<br> |
---|
155 | <br> |
---|
156 | Create the GUI part of the Window for 2-phase creation mode.</tt></dd></dl> |
---|
157 | |
---|
158 | <dl><dt><a name="XYpair-SetFocusIgnoringChildren"><strong>SetFocusIgnoringChildren</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetFocusIgnoringChildren">SetFocusIgnoringChildren</a>(self)<br> |
---|
159 | <br> |
---|
160 | In contrast to `SetFocus` (see above) this will set the focus to the<br> |
---|
161 | panel even of there are child windows in the panel. This is only<br> |
---|
162 | rarely needed.</tt></dd></dl> |
---|
163 | |
---|
164 | <dl><dt><a name="XYpair-__repr__"><strong>__repr__</strong></a> = _swig_repr(self)</dt></dl> |
---|
165 | |
---|
166 | <hr> |
---|
167 | Static methods inherited from <a href="wx._windows.html#Panel">wx._windows.Panel</a>:<br> |
---|
168 | <dl><dt><a name="XYpair-GetClassDefaultAttributes"><strong>GetClassDefaultAttributes</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetClassDefaultAttributes">GetClassDefaultAttributes</a>(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes<br> |
---|
169 | <br> |
---|
170 | Get the default attributes for this class. This is useful if you want<br> |
---|
171 | to use the same font or colour in your own control as in a standard<br> |
---|
172 | control -- which is a much better idea than hard coding specific<br> |
---|
173 | colours or fonts which might look completely out of place on the<br> |
---|
174 | user's system, especially if it uses themes.<br> |
---|
175 | <br> |
---|
176 | The variant parameter is only relevant under Mac currently and is<br> |
---|
177 | ignore under other platforms. Under Mac, it will change the size of<br> |
---|
178 | the returned font. See `wx.Window.SetWindowVariant` for more about<br> |
---|
179 | this.</tt></dd></dl> |
---|
180 | |
---|
181 | <hr> |
---|
182 | Data descriptors inherited from <a href="wx._windows.html#Panel">wx._windows.Panel</a>:<br> |
---|
183 | <dl><dt><strong>thisown</strong></dt> |
---|
184 | <dd><tt>The membership flag</tt></dd> |
---|
185 | </dl> |
---|
186 | <hr> |
---|
187 | Methods inherited from <a href="wx._core.html#Window">wx._core.Window</a>:<br> |
---|
188 | <dl><dt><a name="XYpair-AcceptsFocus"><strong>AcceptsFocus</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-AcceptsFocus">AcceptsFocus</a>(self) -> bool<br> |
---|
189 | <br> |
---|
190 | Can this window have focus?</tt></dd></dl> |
---|
191 | |
---|
192 | <dl><dt><a name="XYpair-AcceptsFocusFromKeyboard"><strong>AcceptsFocusFromKeyboard</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-AcceptsFocusFromKeyboard">AcceptsFocusFromKeyboard</a>(self) -> bool<br> |
---|
193 | <br> |
---|
194 | Can this window be given focus by keyboard navigation? if not, the<br> |
---|
195 | only way to give it focus (provided it accepts it at all) is to click<br> |
---|
196 | it.</tt></dd></dl> |
---|
197 | |
---|
198 | <dl><dt><a name="XYpair-AddChild"><strong>AddChild</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-AddChild">AddChild</a>(self, Window child)<br> |
---|
199 | <br> |
---|
200 | Adds a child window. This is called automatically by window creation<br> |
---|
201 | functions so should not be required by the application programmer.</tt></dd></dl> |
---|
202 | |
---|
203 | <dl><dt><a name="XYpair-AdjustForLayoutDirection"><strong>AdjustForLayoutDirection</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-AdjustForLayoutDirection">AdjustForLayoutDirection</a>(self, int x, int width, int widthTotal) -> int<br> |
---|
204 | <br> |
---|
205 | Mirror coordinates for RTL layout if this window uses it and if the<br> |
---|
206 | mirroring is not done automatically like Win32.</tt></dd></dl> |
---|
207 | |
---|
208 | <dl><dt><a name="XYpair-AssociateHandle"><strong>AssociateHandle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-AssociateHandle">AssociateHandle</a>(self, long handle)<br> |
---|
209 | <br> |
---|
210 | Associate the window with a new native handle</tt></dd></dl> |
---|
211 | |
---|
212 | <dl><dt><a name="XYpair-CacheBestSize"><strong>CacheBestSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-CacheBestSize">CacheBestSize</a>(self, Size size)<br> |
---|
213 | <br> |
---|
214 | Cache the best size so it doesn't need to be calculated again, (at least until<br> |
---|
215 | some properties of the window change.)</tt></dd></dl> |
---|
216 | |
---|
217 | <dl><dt><a name="XYpair-CanSetTransparent"><strong>CanSetTransparent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-CanSetTransparent">CanSetTransparent</a>(self) -> bool<br> |
---|
218 | <br> |
---|
219 | Returns ``True`` if the platform supports setting the transparency for<br> |
---|
220 | this window. Note that this method will err on the side of caution,<br> |
---|
221 | so it is possible that this will return ``False`` when it is in fact<br> |
---|
222 | possible to set the transparency.<br> |
---|
223 | <br> |
---|
224 | NOTE: On X-windows systems the X server must have the composite<br> |
---|
225 | extension loaded, and there must be a composite manager program (such<br> |
---|
226 | as xcompmgr) running.</tt></dd></dl> |
---|
227 | |
---|
228 | <dl><dt><a name="XYpair-CaptureMouse"><strong>CaptureMouse</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-CaptureMouse">CaptureMouse</a>(self)<br> |
---|
229 | <br> |
---|
230 | Directs all mouse input to this window. Call wx.Window.ReleaseMouse to<br> |
---|
231 | release the capture.<br> |
---|
232 | <br> |
---|
233 | Note that wxWindows maintains the stack of windows having captured the<br> |
---|
234 | mouse and when the mouse is released the capture returns to the window<br> |
---|
235 | which had had captured it previously and it is only really released if<br> |
---|
236 | there were no previous window. In particular, this means that you must<br> |
---|
237 | release the mouse as many times as you capture it, unless the window<br> |
---|
238 | receives the `wx.MouseCaptureLostEvent` event.<br> |
---|
239 | <br> |
---|
240 | Any application which captures the mouse in the beginning of some<br> |
---|
241 | operation *must* handle `wx.MouseCaptureLostEvent` and cancel this<br> |
---|
242 | operation when it receives the event. The event handler must not<br> |
---|
243 | recapture mouse.</tt></dd></dl> |
---|
244 | |
---|
245 | <dl><dt><a name="XYpair-Center"><strong>Center</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Center">Center</a>(self, int direction=BOTH)<br> |
---|
246 | <br> |
---|
247 | Centers the window. The parameter specifies the direction for<br> |
---|
248 | cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may<br> |
---|
249 | also include wx.CENTER_ON_SCREEN flag if you want to center the window<br> |
---|
250 | on the entire screen and not on its parent window. If it is a<br> |
---|
251 | top-level window and has no parent then it will always be centered<br> |
---|
252 | relative to the screen.</tt></dd></dl> |
---|
253 | |
---|
254 | <dl><dt><a name="XYpair-CenterOnParent"><strong>CenterOnParent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-CenterOnParent">CenterOnParent</a>(self, int dir=BOTH)<br> |
---|
255 | <br> |
---|
256 | Center with respect to the the parent window</tt></dd></dl> |
---|
257 | |
---|
258 | <dl><dt><a name="XYpair-Centre"><strong>Centre</strong></a> = Center(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Center">Center</a>(self, int direction=BOTH)<br> |
---|
259 | <br> |
---|
260 | Centers the window. The parameter specifies the direction for<br> |
---|
261 | cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may<br> |
---|
262 | also include wx.CENTER_ON_SCREEN flag if you want to center the window<br> |
---|
263 | on the entire screen and not on its parent window. If it is a<br> |
---|
264 | top-level window and has no parent then it will always be centered<br> |
---|
265 | relative to the screen.</tt></dd></dl> |
---|
266 | |
---|
267 | <dl><dt><a name="XYpair-CentreOnParent"><strong>CentreOnParent</strong></a> = CenterOnParent(*args, **kwargs)</dt><dd><tt><a href="#XYpair-CenterOnParent">CenterOnParent</a>(self, int dir=BOTH)<br> |
---|
268 | <br> |
---|
269 | Center with respect to the the parent window</tt></dd></dl> |
---|
270 | |
---|
271 | <dl><dt><a name="XYpair-ClearBackground"><strong>ClearBackground</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ClearBackground">ClearBackground</a>(self)<br> |
---|
272 | <br> |
---|
273 | Clears the window by filling it with the current background<br> |
---|
274 | colour. Does not cause an erase background event to be generated.</tt></dd></dl> |
---|
275 | |
---|
276 | <dl><dt><a name="XYpair-ClientToScreen"><strong>ClientToScreen</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ClientToScreen">ClientToScreen</a>(self, Point pt) -> Point<br> |
---|
277 | <br> |
---|
278 | Converts to screen coordinates from coordinates relative to this window.</tt></dd></dl> |
---|
279 | |
---|
280 | <dl><dt><a name="XYpair-ClientToScreenXY"><strong>ClientToScreenXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ClientToScreenXY">ClientToScreenXY</a>(int x, int y) -> (x,y)<br> |
---|
281 | <br> |
---|
282 | Converts to screen coordinates from coordinates relative to this window.</tt></dd></dl> |
---|
283 | |
---|
284 | <dl><dt><a name="XYpair-Close"><strong>Close</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Close">Close</a>(self, bool force=False) -> bool<br> |
---|
285 | <br> |
---|
286 | This function simply generates a EVT_CLOSE event whose handler usually<br> |
---|
287 | tries to close the window. It doesn't close the window itself,<br> |
---|
288 | however. If force is False (the default) then the window's close<br> |
---|
289 | handler will be allowed to veto the destruction of the window.</tt></dd></dl> |
---|
290 | |
---|
291 | <dl><dt><a name="XYpair-ConvertDialogPointToPixels"><strong>ConvertDialogPointToPixels</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ConvertDialogPointToPixels">ConvertDialogPointToPixels</a>(self, Point pt) -> Point<br> |
---|
292 | <br> |
---|
293 | Converts a point or size from dialog units to pixels. Dialog units<br> |
---|
294 | are used for maintaining a dialog's proportions even if the font<br> |
---|
295 | changes. For the x dimension, the dialog units are multiplied by the<br> |
---|
296 | average character width and then divided by 4. For the y dimension,<br> |
---|
297 | the dialog units are multiplied by the average character height and<br> |
---|
298 | then divided by 8.</tt></dd></dl> |
---|
299 | |
---|
300 | <dl><dt><a name="XYpair-ConvertDialogSizeToPixels"><strong>ConvertDialogSizeToPixels</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ConvertDialogSizeToPixels">ConvertDialogSizeToPixels</a>(self, Size sz) -> Size<br> |
---|
301 | <br> |
---|
302 | Converts a point or size from dialog units to pixels. Dialog units<br> |
---|
303 | are used for maintaining a dialog's proportions even if the font<br> |
---|
304 | changes. For the x dimension, the dialog units are multiplied by the<br> |
---|
305 | average character width and then divided by 4. For the y dimension,<br> |
---|
306 | the dialog units are multiplied by the average character height and<br> |
---|
307 | then divided by 8.</tt></dd></dl> |
---|
308 | |
---|
309 | <dl><dt><a name="XYpair-ConvertPixelPointToDialog"><strong>ConvertPixelPointToDialog</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ConvertPixelPointToDialog">ConvertPixelPointToDialog</a>(self, Point pt) -> Point</tt></dd></dl> |
---|
310 | |
---|
311 | <dl><dt><a name="XYpair-ConvertPixelSizeToDialog"><strong>ConvertPixelSizeToDialog</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ConvertPixelSizeToDialog">ConvertPixelSizeToDialog</a>(self, Size sz) -> Size</tt></dd></dl> |
---|
312 | |
---|
313 | <dl><dt><a name="XYpair-DLG_PNT"><strong>DLG_PNT</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-DLG_PNT">DLG_PNT</a>(self, Point pt) -> Point<br> |
---|
314 | <br> |
---|
315 | Converts a point or size from dialog units to pixels. Dialog units<br> |
---|
316 | are used for maintaining a dialog's proportions even if the font<br> |
---|
317 | changes. For the x dimension, the dialog units are multiplied by the<br> |
---|
318 | average character width and then divided by 4. For the y dimension,<br> |
---|
319 | the dialog units are multiplied by the average character height and<br> |
---|
320 | then divided by 8.</tt></dd></dl> |
---|
321 | |
---|
322 | <dl><dt><a name="XYpair-DLG_SZE"><strong>DLG_SZE</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-DLG_SZE">DLG_SZE</a>(self, Size sz) -> Size<br> |
---|
323 | <br> |
---|
324 | Converts a point or size from dialog units to pixels. Dialog units<br> |
---|
325 | are used for maintaining a dialog's proportions even if the font<br> |
---|
326 | changes. For the x dimension, the dialog units are multiplied by the<br> |
---|
327 | average character width and then divided by 4. For the y dimension,<br> |
---|
328 | the dialog units are multiplied by the average character height and<br> |
---|
329 | then divided by 8.</tt></dd></dl> |
---|
330 | |
---|
331 | <dl><dt><a name="XYpair-Destroy"><strong>Destroy</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Destroy">Destroy</a>(self) -> bool<br> |
---|
332 | <br> |
---|
333 | Destroys the window safely. Frames and dialogs are not destroyed<br> |
---|
334 | immediately when this function is called -- they are added to a list<br> |
---|
335 | of windows to be deleted on idle time, when all the window's events<br> |
---|
336 | have been processed. This prevents problems with events being sent to<br> |
---|
337 | non-existent windows.<br> |
---|
338 | <br> |
---|
339 | Returns True if the window has either been successfully deleted, or it<br> |
---|
340 | has been added to the list of windows pending real deletion.</tt></dd></dl> |
---|
341 | |
---|
342 | <dl><dt><a name="XYpair-DestroyChildren"><strong>DestroyChildren</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-DestroyChildren">DestroyChildren</a>(self) -> bool<br> |
---|
343 | <br> |
---|
344 | Destroys all children of a window. Called automatically by the<br> |
---|
345 | destructor.</tt></dd></dl> |
---|
346 | |
---|
347 | <dl><dt><a name="XYpair-Disable"><strong>Disable</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Disable">Disable</a>(self) -> bool<br> |
---|
348 | <br> |
---|
349 | Disables the window, same as <a href="#XYpair-Enable">Enable</a>(false).</tt></dd></dl> |
---|
350 | |
---|
351 | <dl><dt><a name="XYpair-DissociateHandle"><strong>DissociateHandle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-DissociateHandle">DissociateHandle</a>(self)<br> |
---|
352 | <br> |
---|
353 | Dissociate the current native handle from the window</tt></dd></dl> |
---|
354 | |
---|
355 | <dl><dt><a name="XYpair-DragAcceptFiles"><strong>DragAcceptFiles</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-DragAcceptFiles">DragAcceptFiles</a>(self, bool accept)<br> |
---|
356 | <br> |
---|
357 | Enables or disables eligibility for drop file events, EVT_DROP_FILES.<br> |
---|
358 | Only functional on Windows.</tt></dd></dl> |
---|
359 | |
---|
360 | <dl><dt><a name="XYpair-Enable"><strong>Enable</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Enable">Enable</a>(self, bool enable=True) -> bool<br> |
---|
361 | <br> |
---|
362 | Enable or disable the window for user input. Note that when a parent<br> |
---|
363 | window is disabled, all of its children are disabled as well and they<br> |
---|
364 | are reenabled again when the parent is. Returns true if the window<br> |
---|
365 | has been enabled or disabled, false if nothing was done, i.e. if the<br> |
---|
366 | window had already been in the specified state.</tt></dd></dl> |
---|
367 | |
---|
368 | <dl><dt><a name="XYpair-FindWindowById"><strong>FindWindowById</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-FindWindowById">FindWindowById</a>(self, long winid) -> Window<br> |
---|
369 | <br> |
---|
370 | Find a child of this window by window ID</tt></dd></dl> |
---|
371 | |
---|
372 | <dl><dt><a name="XYpair-FindWindowByName"><strong>FindWindowByName</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-FindWindowByName">FindWindowByName</a>(self, String name) -> Window<br> |
---|
373 | <br> |
---|
374 | Find a child of this window by name</tt></dd></dl> |
---|
375 | |
---|
376 | <dl><dt><a name="XYpair-Fit"><strong>Fit</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Fit">Fit</a>(self)<br> |
---|
377 | <br> |
---|
378 | Sizes the window so that it fits around its subwindows. This function<br> |
---|
379 | won't do anything if there are no subwindows and will only really work<br> |
---|
380 | correctly if sizers are used for the subwindows layout. Also, if the<br> |
---|
381 | window has exactly one subwindow it is better (faster and the result<br> |
---|
382 | is more precise as Fit adds some margin to account for fuzziness of<br> |
---|
383 | its calculations) to call window.<a href="#XYpair-SetClientSize">SetClientSize</a>(child.<a href="#XYpair-GetSize">GetSize</a>())<br> |
---|
384 | instead of calling Fit.</tt></dd></dl> |
---|
385 | |
---|
386 | <dl><dt><a name="XYpair-FitInside"><strong>FitInside</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-FitInside">FitInside</a>(self)<br> |
---|
387 | <br> |
---|
388 | Similar to Fit, but sizes the interior (virtual) size of a<br> |
---|
389 | window. Mainly useful with scrolled windows to reset scrollbars after<br> |
---|
390 | sizing changes that do not trigger a size event, and/or scrolled<br> |
---|
391 | windows without an interior sizer. This function similarly won't do<br> |
---|
392 | anything if there are no subwindows.</tt></dd></dl> |
---|
393 | |
---|
394 | <dl><dt><a name="XYpair-Freeze"><strong>Freeze</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Freeze">Freeze</a>(self)<br> |
---|
395 | <br> |
---|
396 | Freezes the window or, in other words, prevents any updates from<br> |
---|
397 | taking place on screen, the window is not redrawn at all. Thaw must be<br> |
---|
398 | called to reenable window redrawing. Calls to Freeze/Thaw may be<br> |
---|
399 | nested, with the actual Thaw being delayed until all the nesting has<br> |
---|
400 | been undone.<br> |
---|
401 | <br> |
---|
402 | This method is useful for visual appearance optimization (for example,<br> |
---|
403 | it is a good idea to use it before inserting large amount of text into<br> |
---|
404 | a wxTextCtrl under wxGTK) but is not implemented on all platforms nor<br> |
---|
405 | for all controls so it is mostly just a hint to wxWindows and not a<br> |
---|
406 | mandatory directive.</tt></dd></dl> |
---|
407 | |
---|
408 | <dl><dt><a name="XYpair-GetAcceleratorTable"><strong>GetAcceleratorTable</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetAcceleratorTable">GetAcceleratorTable</a>(self) -> AcceleratorTable<br> |
---|
409 | <br> |
---|
410 | Gets the accelerator table for this window.</tt></dd></dl> |
---|
411 | |
---|
412 | <dl><dt><a name="XYpair-GetAdjustedBestSize"><strong>GetAdjustedBestSize</strong></a> = deprecatedWrapper(*args, **kwargs)</dt><dd><tt>Use `GetEffectiveMinSize` instead.</tt></dd></dl> |
---|
413 | |
---|
414 | <dl><dt><a name="XYpair-GetAutoLayout"><strong>GetAutoLayout</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetAutoLayout">GetAutoLayout</a>(self) -> bool<br> |
---|
415 | <br> |
---|
416 | Returns the current autoLayout setting</tt></dd></dl> |
---|
417 | |
---|
418 | <dl><dt><a name="XYpair-GetBackgroundColour"><strong>GetBackgroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetBackgroundColour">GetBackgroundColour</a>(self) -> Colour<br> |
---|
419 | <br> |
---|
420 | Returns the background colour of the window.</tt></dd></dl> |
---|
421 | |
---|
422 | <dl><dt><a name="XYpair-GetBackgroundStyle"><strong>GetBackgroundStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetBackgroundStyle">GetBackgroundStyle</a>(self) -> int<br> |
---|
423 | <br> |
---|
424 | Returns the background style of the window.<br> |
---|
425 | <br> |
---|
426 | :see: `SetBackgroundStyle`</tt></dd></dl> |
---|
427 | |
---|
428 | <dl><dt><a name="XYpair-GetBestFittingSize"><strong>GetBestFittingSize</strong></a> = deprecatedWrapper(*args, **kwargs)</dt><dd><tt>Use `GetEffectiveMinSize` instead.</tt></dd></dl> |
---|
429 | |
---|
430 | <dl><dt><a name="XYpair-GetBestSize"><strong>GetBestSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetBestSize">GetBestSize</a>(self) -> Size<br> |
---|
431 | <br> |
---|
432 | This function returns the best acceptable minimal size for the<br> |
---|
433 | window, if applicable. For example, for a static text control, it will<br> |
---|
434 | be the minimal size such that the control label is not truncated. For<br> |
---|
435 | windows containing subwindows (suzh aswx.<a href="wx._windows.html#Panel">Panel</a>), the size returned by<br> |
---|
436 | this function will be the same as the size the window would have had<br> |
---|
437 | after calling Fit.</tt></dd></dl> |
---|
438 | |
---|
439 | <dl><dt><a name="XYpair-GetBestSizeTuple"><strong>GetBestSizeTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetBestSizeTuple">GetBestSizeTuple</a>() -> (width, height)<br> |
---|
440 | <br> |
---|
441 | This function returns the best acceptable minimal size for the<br> |
---|
442 | window, if applicable. For example, for a static text control, it will<br> |
---|
443 | be the minimal size such that the control label is not truncated. For<br> |
---|
444 | windows containing subwindows (suzh aswx.<a href="wx._windows.html#Panel">Panel</a>), the size returned by<br> |
---|
445 | this function will be the same as the size the window would have had<br> |
---|
446 | after calling Fit.</tt></dd></dl> |
---|
447 | |
---|
448 | <dl><dt><a name="XYpair-GetBestVirtualSize"><strong>GetBestVirtualSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetBestVirtualSize">GetBestVirtualSize</a>(self) -> Size<br> |
---|
449 | <br> |
---|
450 | Return the largest of ClientSize and BestSize (as determined by a<br> |
---|
451 | sizer, interior children, or other means)</tt></dd></dl> |
---|
452 | |
---|
453 | <dl><dt><a name="XYpair-GetBorder"><strong>GetBorder</strong></a>(*args)</dt><dd><tt><a href="#XYpair-GetBorder">GetBorder</a>(self, long flags) -> int<br> |
---|
454 | <a href="#XYpair-GetBorder">GetBorder</a>(self) -> int<br> |
---|
455 | <br> |
---|
456 | Get border for the flags of this window</tt></dd></dl> |
---|
457 | |
---|
458 | <dl><dt><a name="XYpair-GetCaret"><strong>GetCaret</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetCaret">GetCaret</a>(self) -> Caret<br> |
---|
459 | <br> |
---|
460 | Returns the caret associated with the window.</tt></dd></dl> |
---|
461 | |
---|
462 | <dl><dt><a name="XYpair-GetCharHeight"><strong>GetCharHeight</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetCharHeight">GetCharHeight</a>(self) -> int<br> |
---|
463 | <br> |
---|
464 | Get the (average) character size for the current font.</tt></dd></dl> |
---|
465 | |
---|
466 | <dl><dt><a name="XYpair-GetCharWidth"><strong>GetCharWidth</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetCharWidth">GetCharWidth</a>(self) -> int<br> |
---|
467 | <br> |
---|
468 | Get the (average) character size for the current font.</tt></dd></dl> |
---|
469 | |
---|
470 | <dl><dt><a name="XYpair-GetChildren"><strong>GetChildren</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetChildren">GetChildren</a>(self) -> WindowList<br> |
---|
471 | <br> |
---|
472 | Returns an object containing a list of the window's children. The<br> |
---|
473 | object provides a Python sequence-like interface over the internal<br> |
---|
474 | list maintained by the window..</tt></dd></dl> |
---|
475 | |
---|
476 | <dl><dt><a name="XYpair-GetClientAreaOrigin"><strong>GetClientAreaOrigin</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetClientAreaOrigin">GetClientAreaOrigin</a>(self) -> Point<br> |
---|
477 | <br> |
---|
478 | Get the origin of the client area of the window relative to the<br> |
---|
479 | window's top left corner (the client area may be shifted because of<br> |
---|
480 | the borders, scrollbars, other decorations...)</tt></dd></dl> |
---|
481 | |
---|
482 | <dl><dt><a name="XYpair-GetClientRect"><strong>GetClientRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetClientRect">GetClientRect</a>(self) -> Rect<br> |
---|
483 | <br> |
---|
484 | Get the client area position and size as a `wx.Rect` object.</tt></dd></dl> |
---|
485 | |
---|
486 | <dl><dt><a name="XYpair-GetClientSize"><strong>GetClientSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetClientSize">GetClientSize</a>(self) -> Size<br> |
---|
487 | <br> |
---|
488 | This gets the size of the window's 'client area' in pixels. The client<br> |
---|
489 | area is the area which may be drawn on by the programmer, excluding<br> |
---|
490 | title bar, border, scrollbars, etc.</tt></dd></dl> |
---|
491 | |
---|
492 | <dl><dt><a name="XYpair-GetClientSizeTuple"><strong>GetClientSizeTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetClientSizeTuple">GetClientSizeTuple</a>() -> (width, height)<br> |
---|
493 | <br> |
---|
494 | This gets the size of the window's 'client area' in pixels. The client<br> |
---|
495 | area is the area which may be drawn on by the programmer, excluding<br> |
---|
496 | title bar, border, scrollbars, etc.</tt></dd></dl> |
---|
497 | |
---|
498 | <dl><dt><a name="XYpair-GetConstraints"><strong>GetConstraints</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetConstraints">GetConstraints</a>(self) -> LayoutConstraints<br> |
---|
499 | <br> |
---|
500 | Returns a pointer to the window's layout constraints, or None if there<br> |
---|
501 | are none.</tt></dd></dl> |
---|
502 | |
---|
503 | <dl><dt><a name="XYpair-GetContainingSizer"><strong>GetContainingSizer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetContainingSizer">GetContainingSizer</a>(self) -> Sizer<br> |
---|
504 | <br> |
---|
505 | Return the sizer that this window is a member of, if any, otherwise None.</tt></dd></dl> |
---|
506 | |
---|
507 | <dl><dt><a name="XYpair-GetCursor"><strong>GetCursor</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetCursor">GetCursor</a>(self) -> Cursor<br> |
---|
508 | <br> |
---|
509 | Return the cursor associated with this window.</tt></dd></dl> |
---|
510 | |
---|
511 | <dl><dt><a name="XYpair-GetDefaultAttributes"><strong>GetDefaultAttributes</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetDefaultAttributes">GetDefaultAttributes</a>(self) -> VisualAttributes<br> |
---|
512 | <br> |
---|
513 | Get the default attributes for an instance of this class. This is<br> |
---|
514 | useful if you want to use the same font or colour in your own control<br> |
---|
515 | as in a standard control -- which is a much better idea than hard<br> |
---|
516 | coding specific colours or fonts which might look completely out of<br> |
---|
517 | place on the user's system, especially if it uses themes.</tt></dd></dl> |
---|
518 | |
---|
519 | <dl><dt><a name="XYpair-GetDropTarget"><strong>GetDropTarget</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetDropTarget">GetDropTarget</a>(self) -> DropTarget<br> |
---|
520 | <br> |
---|
521 | Returns the associated drop target, which may be None.</tt></dd></dl> |
---|
522 | |
---|
523 | <dl><dt><a name="XYpair-GetEffectiveMinSize"><strong>GetEffectiveMinSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetEffectiveMinSize">GetEffectiveMinSize</a>(self) -> Size<br> |
---|
524 | <br> |
---|
525 | This function will merge the window's best size into the window's<br> |
---|
526 | minimum size, giving priority to the min size components, and returns<br> |
---|
527 | the results.</tt></dd></dl> |
---|
528 | |
---|
529 | <dl><dt><a name="XYpair-GetEventHandler"><strong>GetEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetEventHandler">GetEventHandler</a>(self) -> EvtHandler<br> |
---|
530 | <br> |
---|
531 | Returns the event handler for this window. By default, the window is<br> |
---|
532 | its own event handler.</tt></dd></dl> |
---|
533 | |
---|
534 | <dl><dt><a name="XYpair-GetExtraStyle"><strong>GetExtraStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetExtraStyle">GetExtraStyle</a>(self) -> long<br> |
---|
535 | <br> |
---|
536 | Returns the extra style bits for the window.</tt></dd></dl> |
---|
537 | |
---|
538 | <dl><dt><a name="XYpair-GetFont"><strong>GetFont</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetFont">GetFont</a>(self) -> Font<br> |
---|
539 | <br> |
---|
540 | Returns the default font used for this window.</tt></dd></dl> |
---|
541 | |
---|
542 | <dl><dt><a name="XYpair-GetForegroundColour"><strong>GetForegroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetForegroundColour">GetForegroundColour</a>(self) -> Colour<br> |
---|
543 | <br> |
---|
544 | Returns the foreground colour of the window. The interpretation of<br> |
---|
545 | foreground colour is dependent on the window class; it may be the text<br> |
---|
546 | colour or other colour, or it may not be used at all.</tt></dd></dl> |
---|
547 | |
---|
548 | <dl><dt><a name="XYpair-GetFullTextExtent"><strong>GetFullTextExtent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetFullTextExtent">GetFullTextExtent</a>(String string, Font font=None) -><br> |
---|
549 | (width, height, descent, externalLeading)<br> |
---|
550 | <br> |
---|
551 | Get the width, height, decent and leading of the text using the<br> |
---|
552 | current or specified font.</tt></dd></dl> |
---|
553 | |
---|
554 | <dl><dt><a name="XYpair-GetGrandParent"><strong>GetGrandParent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetGrandParent">GetGrandParent</a>(self) -> Window<br> |
---|
555 | <br> |
---|
556 | Returns the parent of the parent of this window, or None if there<br> |
---|
557 | isn't one.</tt></dd></dl> |
---|
558 | |
---|
559 | <dl><dt><a name="XYpair-GetGtkWidget"><strong>GetGtkWidget</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetGtkWidget">GetGtkWidget</a>(self) -> long<br> |
---|
560 | <br> |
---|
561 | On wxGTK returns a pointer to the GtkWidget for this window as a long<br> |
---|
562 | integer. On the other platforms this method returns zero.</tt></dd></dl> |
---|
563 | |
---|
564 | <dl><dt><a name="XYpair-GetHandle"><strong>GetHandle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetHandle">GetHandle</a>(self) -> long<br> |
---|
565 | <br> |
---|
566 | Returns the platform-specific handle (as a long integer) of the<br> |
---|
567 | physical window. On wxMSW this is the win32 window handle, on wxGTK<br> |
---|
568 | it is the XWindow ID, and on wxMac it is the ControlRef.</tt></dd></dl> |
---|
569 | |
---|
570 | <dl><dt><a name="XYpair-GetHelpText"><strong>GetHelpText</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetHelpText">GetHelpText</a>(self) -> String<br> |
---|
571 | <br> |
---|
572 | Gets the help text to be used as context-sensitive help for this<br> |
---|
573 | window. Note that the text is actually stored by the current<br> |
---|
574 | `wx.HelpProvider` implementation, and not in the window object itself.</tt></dd></dl> |
---|
575 | |
---|
576 | <dl><dt><a name="XYpair-GetHelpTextAtPoint"><strong>GetHelpTextAtPoint</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetHelpTextAtPoint">GetHelpTextAtPoint</a>(self, Point pt, wxHelpEvent::Origin origin) -> String<br> |
---|
577 | <br> |
---|
578 | Get the help string associated with the given position in this window.<br> |
---|
579 | <br> |
---|
580 | Notice that pt may be invalid if event origin is keyboard or unknown<br> |
---|
581 | and this method should return the global window help text then</tt></dd></dl> |
---|
582 | |
---|
583 | <dl><dt><a name="XYpair-GetId"><strong>GetId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetId">GetId</a>(self) -> int<br> |
---|
584 | <br> |
---|
585 | Returns the identifier of the window. Each window has an integer<br> |
---|
586 | identifier. If the application has not provided one (or the default Id<br> |
---|
587 | -1 is used) then an unique identifier with a negative value will be<br> |
---|
588 | generated.</tt></dd></dl> |
---|
589 | |
---|
590 | <dl><dt><a name="XYpair-GetLabel"><strong>GetLabel</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetLabel">GetLabel</a>(self) -> String<br> |
---|
591 | <br> |
---|
592 | Generic way of getting a label from any window, for identification<br> |
---|
593 | purposes. The interpretation of this function differs from class to<br> |
---|
594 | class. For frames and dialogs, the value returned is the title. For<br> |
---|
595 | buttons or static text controls, it is the button text. This function<br> |
---|
596 | can be useful for meta-programs such as testing tools or special-needs<br> |
---|
597 | access programs)which need to identify windows by name.</tt></dd></dl> |
---|
598 | |
---|
599 | <dl><dt><a name="XYpair-GetLayoutDirection"><strong>GetLayoutDirection</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetLayoutDirection">GetLayoutDirection</a>(self) -> int<br> |
---|
600 | <br> |
---|
601 | Get the layout direction (LTR or RTL) for this window. Returns<br> |
---|
602 | ``wx.Layout_Default`` if layout direction is not supported.</tt></dd></dl> |
---|
603 | |
---|
604 | <dl><dt><a name="XYpair-GetMaxHeight"><strong>GetMaxHeight</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetMaxHeight">GetMaxHeight</a>(self) -> int</tt></dd></dl> |
---|
605 | |
---|
606 | <dl><dt><a name="XYpair-GetMaxSize"><strong>GetMaxSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetMaxSize">GetMaxSize</a>(self) -> Size</tt></dd></dl> |
---|
607 | |
---|
608 | <dl><dt><a name="XYpair-GetMaxWidth"><strong>GetMaxWidth</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetMaxWidth">GetMaxWidth</a>(self) -> int</tt></dd></dl> |
---|
609 | |
---|
610 | <dl><dt><a name="XYpair-GetMinHeight"><strong>GetMinHeight</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetMinHeight">GetMinHeight</a>(self) -> int</tt></dd></dl> |
---|
611 | |
---|
612 | <dl><dt><a name="XYpair-GetMinSize"><strong>GetMinSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetMinSize">GetMinSize</a>(self) -> Size</tt></dd></dl> |
---|
613 | |
---|
614 | <dl><dt><a name="XYpair-GetMinWidth"><strong>GetMinWidth</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetMinWidth">GetMinWidth</a>(self) -> int</tt></dd></dl> |
---|
615 | |
---|
616 | <dl><dt><a name="XYpair-GetName"><strong>GetName</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetName">GetName</a>(self) -> String<br> |
---|
617 | <br> |
---|
618 | Returns the windows name. This name is not guaranteed to be unique;<br> |
---|
619 | it is up to the programmer to supply an appropriate name in the window<br> |
---|
620 | constructor or via wx.Window.SetName.</tt></dd></dl> |
---|
621 | |
---|
622 | <dl><dt><a name="XYpair-GetParent"><strong>GetParent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetParent">GetParent</a>(self) -> Window<br> |
---|
623 | <br> |
---|
624 | Returns the parent window of this window, or None if there isn't one.</tt></dd></dl> |
---|
625 | |
---|
626 | <dl><dt><a name="XYpair-GetPosition"><strong>GetPosition</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetPosition">GetPosition</a>(self) -> Point<br> |
---|
627 | <br> |
---|
628 | Get the window's position. Notice that the position is in client<br> |
---|
629 | coordinates for child windows and screen coordinates for the top level<br> |
---|
630 | ones, use `GetScreenPosition` if you need screen coordinates for all<br> |
---|
631 | kinds of windows.</tt></dd></dl> |
---|
632 | |
---|
633 | <dl><dt><a name="XYpair-GetPositionTuple"><strong>GetPositionTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetPositionTuple">GetPositionTuple</a>() -> (x,y)<br> |
---|
634 | <br> |
---|
635 | Get the window's position. Notice that the position is in client<br> |
---|
636 | coordinates for child windows and screen coordinates for the top level<br> |
---|
637 | ones, use `GetScreenPosition` if you need screen coordinates for all<br> |
---|
638 | kinds of windows.</tt></dd></dl> |
---|
639 | |
---|
640 | <dl><dt><a name="XYpair-GetRect"><strong>GetRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetRect">GetRect</a>(self) -> Rect<br> |
---|
641 | <br> |
---|
642 | Returns the size and position of the window as a `wx.Rect` object.</tt></dd></dl> |
---|
643 | |
---|
644 | <dl><dt><a name="XYpair-GetScreenPosition"><strong>GetScreenPosition</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetScreenPosition">GetScreenPosition</a>(self) -> Point<br> |
---|
645 | <br> |
---|
646 | Get the position of the window in screen coordinantes.</tt></dd></dl> |
---|
647 | |
---|
648 | <dl><dt><a name="XYpair-GetScreenPositionTuple"><strong>GetScreenPositionTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetScreenPositionTuple">GetScreenPositionTuple</a>() -> (x,y)<br> |
---|
649 | <br> |
---|
650 | Get the position of the window in screen coordinantes.</tt></dd></dl> |
---|
651 | |
---|
652 | <dl><dt><a name="XYpair-GetScreenRect"><strong>GetScreenRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetScreenRect">GetScreenRect</a>(self) -> Rect<br> |
---|
653 | <br> |
---|
654 | Returns the size and position of the window in screen coordinantes as<br> |
---|
655 | a `wx.Rect` object.</tt></dd></dl> |
---|
656 | |
---|
657 | <dl><dt><a name="XYpair-GetScrollPos"><strong>GetScrollPos</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetScrollPos">GetScrollPos</a>(self, int orientation) -> int<br> |
---|
658 | <br> |
---|
659 | Returns the built-in scrollbar position.</tt></dd></dl> |
---|
660 | |
---|
661 | <dl><dt><a name="XYpair-GetScrollRange"><strong>GetScrollRange</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetScrollRange">GetScrollRange</a>(self, int orientation) -> int<br> |
---|
662 | <br> |
---|
663 | Returns the built-in scrollbar range.</tt></dd></dl> |
---|
664 | |
---|
665 | <dl><dt><a name="XYpair-GetScrollThumb"><strong>GetScrollThumb</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetScrollThumb">GetScrollThumb</a>(self, int orientation) -> int<br> |
---|
666 | <br> |
---|
667 | Returns the built-in scrollbar thumb size.</tt></dd></dl> |
---|
668 | |
---|
669 | <dl><dt><a name="XYpair-GetSize"><strong>GetSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetSize">GetSize</a>(self) -> Size<br> |
---|
670 | <br> |
---|
671 | Get the window size.</tt></dd></dl> |
---|
672 | |
---|
673 | <dl><dt><a name="XYpair-GetSizeTuple"><strong>GetSizeTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetSizeTuple">GetSizeTuple</a>() -> (width, height)<br> |
---|
674 | <br> |
---|
675 | Get the window size.</tt></dd></dl> |
---|
676 | |
---|
677 | <dl><dt><a name="XYpair-GetSizer"><strong>GetSizer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetSizer">GetSizer</a>(self) -> Sizer<br> |
---|
678 | <br> |
---|
679 | Return the sizer associated with the window by a previous call to<br> |
---|
680 | SetSizer or None if there isn't one.</tt></dd></dl> |
---|
681 | |
---|
682 | <dl><dt><a name="XYpair-GetTextExtent"><strong>GetTextExtent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetTextExtent">GetTextExtent</a>(String string) -> (width, height)<br> |
---|
683 | <br> |
---|
684 | Get the width and height of the text using the current font.</tt></dd></dl> |
---|
685 | |
---|
686 | <dl><dt><a name="XYpair-GetThemeEnabled"><strong>GetThemeEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetThemeEnabled">GetThemeEnabled</a>(self) -> bool<br> |
---|
687 | <br> |
---|
688 | Return the themeEnabled flag.</tt></dd></dl> |
---|
689 | |
---|
690 | <dl><dt><a name="XYpair-GetToolTip"><strong>GetToolTip</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetToolTip">GetToolTip</a>(self) -> ToolTip<br> |
---|
691 | <br> |
---|
692 | get the associated tooltip or None if none</tt></dd></dl> |
---|
693 | |
---|
694 | <dl><dt><a name="XYpair-GetTopLevelParent"><strong>GetTopLevelParent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetTopLevelParent">GetTopLevelParent</a>(self) -> Window<br> |
---|
695 | <br> |
---|
696 | Returns the first frame or dialog in this window's parental hierarchy.</tt></dd></dl> |
---|
697 | |
---|
698 | <dl><dt><a name="XYpair-GetUpdateClientRect"><strong>GetUpdateClientRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetUpdateClientRect">GetUpdateClientRect</a>(self) -> Rect<br> |
---|
699 | <br> |
---|
700 | Get the update rectangle region bounding box in client coords.</tt></dd></dl> |
---|
701 | |
---|
702 | <dl><dt><a name="XYpair-GetUpdateRegion"><strong>GetUpdateRegion</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetUpdateRegion">GetUpdateRegion</a>(self) -> Region<br> |
---|
703 | <br> |
---|
704 | Returns the region specifying which parts of the window have been<br> |
---|
705 | damaged. Should only be called within an EVT_PAINT handler.</tt></dd></dl> |
---|
706 | |
---|
707 | <dl><dt><a name="XYpair-GetValidator"><strong>GetValidator</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetValidator">GetValidator</a>(self) -> Validator<br> |
---|
708 | <br> |
---|
709 | Returns a pointer to the current validator for the window, or None if<br> |
---|
710 | there is none.</tt></dd></dl> |
---|
711 | |
---|
712 | <dl><dt><a name="XYpair-GetVirtualSize"><strong>GetVirtualSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetVirtualSize">GetVirtualSize</a>(self) -> Size<br> |
---|
713 | <br> |
---|
714 | Get the the virtual size of the window in pixels. For most windows<br> |
---|
715 | this is just the client area of the window, but for some like scrolled<br> |
---|
716 | windows it is more or less independent of the screen window size.</tt></dd></dl> |
---|
717 | |
---|
718 | <dl><dt><a name="XYpair-GetVirtualSizeTuple"><strong>GetVirtualSizeTuple</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetVirtualSizeTuple">GetVirtualSizeTuple</a>() -> (width, height)<br> |
---|
719 | <br> |
---|
720 | Get the the virtual size of the window in pixels. For most windows<br> |
---|
721 | this is just the client area of the window, but for some like scrolled<br> |
---|
722 | windows it is more or less independent of the screen window size.</tt></dd></dl> |
---|
723 | |
---|
724 | <dl><dt><a name="XYpair-GetWindowBorderSize"><strong>GetWindowBorderSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetWindowBorderSize">GetWindowBorderSize</a>(self) -> Size<br> |
---|
725 | <br> |
---|
726 | Return the size of the left/right and top/bottom borders.</tt></dd></dl> |
---|
727 | |
---|
728 | <dl><dt><a name="XYpair-GetWindowStyle"><strong>GetWindowStyle</strong></a> = GetWindowStyleFlag(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetWindowStyleFlag">GetWindowStyleFlag</a>(self) -> long<br> |
---|
729 | <br> |
---|
730 | Gets the window style that was passed to the constructor or Create<br> |
---|
731 | method.</tt></dd></dl> |
---|
732 | |
---|
733 | <dl><dt><a name="XYpair-GetWindowStyleFlag"><strong>GetWindowStyleFlag</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetWindowStyleFlag">GetWindowStyleFlag</a>(self) -> long<br> |
---|
734 | <br> |
---|
735 | Gets the window style that was passed to the constructor or Create<br> |
---|
736 | method.</tt></dd></dl> |
---|
737 | |
---|
738 | <dl><dt><a name="XYpair-GetWindowVariant"><strong>GetWindowVariant</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetWindowVariant">GetWindowVariant</a>(self) -> int</tt></dd></dl> |
---|
739 | |
---|
740 | <dl><dt><a name="XYpair-HasCapture"><strong>HasCapture</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-HasCapture">HasCapture</a>(self) -> bool<br> |
---|
741 | <br> |
---|
742 | Returns true if this window has the current mouse capture.</tt></dd></dl> |
---|
743 | |
---|
744 | <dl><dt><a name="XYpair-HasFlag"><strong>HasFlag</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-HasFlag">HasFlag</a>(self, int flag) -> bool<br> |
---|
745 | <br> |
---|
746 | Test if the given style is set for this window.</tt></dd></dl> |
---|
747 | |
---|
748 | <dl><dt><a name="XYpair-HasMultiplePages"><strong>HasMultiplePages</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-HasMultiplePages">HasMultiplePages</a>(self) -> bool</tt></dd></dl> |
---|
749 | |
---|
750 | <dl><dt><a name="XYpair-HasScrollbar"><strong>HasScrollbar</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-HasScrollbar">HasScrollbar</a>(self, int orient) -> bool<br> |
---|
751 | <br> |
---|
752 | Does the window have the scrollbar for this orientation?</tt></dd></dl> |
---|
753 | |
---|
754 | <dl><dt><a name="XYpair-HasTransparentBackground"><strong>HasTransparentBackground</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-HasTransparentBackground">HasTransparentBackground</a>(self) -> bool<br> |
---|
755 | <br> |
---|
756 | Returns True if this window's background is transparent (as, for<br> |
---|
757 | example, for `wx.StaticText`) and should show the parent window's<br> |
---|
758 | background.<br> |
---|
759 | <br> |
---|
760 | This method is mostly used internally by the library itself and you<br> |
---|
761 | normally shouldn't have to call it. You may, however, have to override<br> |
---|
762 | it in your custom control classes to ensure that background is painted<br> |
---|
763 | correctly.</tt></dd></dl> |
---|
764 | |
---|
765 | <dl><dt><a name="XYpair-Hide"><strong>Hide</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Hide">Hide</a>(self) -> bool<br> |
---|
766 | <br> |
---|
767 | Equivalent to calling <a href="#XYpair-Show">Show</a>(False).</tt></dd></dl> |
---|
768 | |
---|
769 | <dl><dt><a name="XYpair-HitTest"><strong>HitTest</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-HitTest">HitTest</a>(self, Point pt) -> int<br> |
---|
770 | <br> |
---|
771 | Test where the given (in client coords) point lies</tt></dd></dl> |
---|
772 | |
---|
773 | <dl><dt><a name="XYpair-HitTestXY"><strong>HitTestXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-HitTestXY">HitTestXY</a>(self, int x, int y) -> int<br> |
---|
774 | <br> |
---|
775 | Test where the given (in client coords) point lies</tt></dd></dl> |
---|
776 | |
---|
777 | <dl><dt><a name="XYpair-InheritAttributes"><strong>InheritAttributes</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-InheritAttributes">InheritAttributes</a>(self)<br> |
---|
778 | <br> |
---|
779 | This function is (or should be, in case of custom controls) called<br> |
---|
780 | during window creation to intelligently set up the window visual<br> |
---|
781 | attributes, that is the font and the foreground and background<br> |
---|
782 | colours.<br> |
---|
783 | <br> |
---|
784 | By 'intelligently' the following is meant: by default, all windows use<br> |
---|
785 | their own default attributes. However if some of the parent's<br> |
---|
786 | attributes are explicitly changed (that is, using SetFont and not<br> |
---|
787 | SetOwnFont) and if the corresponding attribute hadn't been<br> |
---|
788 | explicitly set for this window itself, then this window takes the same<br> |
---|
789 | value as used by the parent. In addition, if the window overrides<br> |
---|
790 | ShouldInheritColours to return false, the colours will not be changed<br> |
---|
791 | no matter what and only the font might.<br> |
---|
792 | <br> |
---|
793 | This rather complicated logic is necessary in order to accommodate the<br> |
---|
794 | different usage scenarios. The most common one is when all default<br> |
---|
795 | attributes are used and in this case, nothing should be inherited as<br> |
---|
796 | in modern GUIs different controls use different fonts (and colours)<br> |
---|
797 | than their siblings so they can't inherit the same value from the<br> |
---|
798 | parent. However it was also deemed desirable to allow to simply change<br> |
---|
799 | the attributes of all children at once by just changing the font or<br> |
---|
800 | colour of their common parent, hence in this case we do inherit the<br> |
---|
801 | parents attributes.</tt></dd></dl> |
---|
802 | |
---|
803 | <dl><dt><a name="XYpair-InheritsBackgroundColour"><strong>InheritsBackgroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-InheritsBackgroundColour">InheritsBackgroundColour</a>(self) -> bool</tt></dd></dl> |
---|
804 | |
---|
805 | <dl><dt><a name="XYpair-InitDialog"><strong>InitDialog</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-InitDialog">InitDialog</a>(self)<br> |
---|
806 | <br> |
---|
807 | Sends an EVT_INIT_DIALOG event, whose handler usually transfers data<br> |
---|
808 | to the dialog via validators.</tt></dd></dl> |
---|
809 | |
---|
810 | <dl><dt><a name="XYpair-InvalidateBestSize"><strong>InvalidateBestSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-InvalidateBestSize">InvalidateBestSize</a>(self)<br> |
---|
811 | <br> |
---|
812 | Reset the cached best size value so it will be recalculated the next<br> |
---|
813 | time it is needed.</tt></dd></dl> |
---|
814 | |
---|
815 | <dl><dt><a name="XYpair-IsBeingDeleted"><strong>IsBeingDeleted</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsBeingDeleted">IsBeingDeleted</a>(self) -> bool<br> |
---|
816 | <br> |
---|
817 | Is the window in the process of being deleted?</tt></dd></dl> |
---|
818 | |
---|
819 | <dl><dt><a name="XYpair-IsDoubleBuffered"><strong>IsDoubleBuffered</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsDoubleBuffered">IsDoubleBuffered</a>(self) -> bool<br> |
---|
820 | <br> |
---|
821 | Returns ``True`` if the window contents is double-buffered by the<br> |
---|
822 | system, i.e. if any drawing done on the window is really done on a<br> |
---|
823 | temporary backing surface and transferred to the screen all at once<br> |
---|
824 | later.</tt></dd></dl> |
---|
825 | |
---|
826 | <dl><dt><a name="XYpair-IsEnabled"><strong>IsEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsEnabled">IsEnabled</a>(self) -> bool<br> |
---|
827 | <br> |
---|
828 | Returns true if the window is enabled for input, false otherwise.</tt></dd></dl> |
---|
829 | |
---|
830 | <dl><dt><a name="XYpair-IsExposed"><strong>IsExposed</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsExposed">IsExposed</a>(self, int x, int y, int w=1, int h=1) -> bool<br> |
---|
831 | <br> |
---|
832 | Returns true if the given point or rectangle area has been exposed<br> |
---|
833 | since the last repaint. Call this in an paint event handler to<br> |
---|
834 | optimize redrawing by only redrawing those areas, which have been<br> |
---|
835 | exposed.</tt></dd></dl> |
---|
836 | |
---|
837 | <dl><dt><a name="XYpair-IsExposedPoint"><strong>IsExposedPoint</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsExposedPoint">IsExposedPoint</a>(self, Point pt) -> bool<br> |
---|
838 | <br> |
---|
839 | Returns true if the given point or rectangle area has been exposed<br> |
---|
840 | since the last repaint. Call this in an paint event handler to<br> |
---|
841 | optimize redrawing by only redrawing those areas, which have been<br> |
---|
842 | exposed.</tt></dd></dl> |
---|
843 | |
---|
844 | <dl><dt><a name="XYpair-IsExposedRect"><strong>IsExposedRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsExposedRect">IsExposedRect</a>(self, Rect rect) -> bool<br> |
---|
845 | <br> |
---|
846 | Returns true if the given point or rectangle area has been exposed<br> |
---|
847 | since the last repaint. Call this in an paint event handler to<br> |
---|
848 | optimize redrawing by only redrawing those areas, which have been<br> |
---|
849 | exposed.</tt></dd></dl> |
---|
850 | |
---|
851 | <dl><dt><a name="XYpair-IsFrozen"><strong>IsFrozen</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsFrozen">IsFrozen</a>(self) -> bool<br> |
---|
852 | <br> |
---|
853 | Returns ``True`` if the window has been frozen and not thawed yet.<br> |
---|
854 | <br> |
---|
855 | :see: `Freeze` and `Thaw`</tt></dd></dl> |
---|
856 | |
---|
857 | <dl><dt><a name="XYpair-IsRetained"><strong>IsRetained</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsRetained">IsRetained</a>(self) -> bool<br> |
---|
858 | <br> |
---|
859 | Returns true if the window is retained, false otherwise. Retained<br> |
---|
860 | windows are only available on X platforms.</tt></dd></dl> |
---|
861 | |
---|
862 | <dl><dt><a name="XYpair-IsShown"><strong>IsShown</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsShown">IsShown</a>(self) -> bool<br> |
---|
863 | <br> |
---|
864 | Returns true if the window is shown, false if it has been hidden.</tt></dd></dl> |
---|
865 | |
---|
866 | <dl><dt><a name="XYpair-IsShownOnScreen"><strong>IsShownOnScreen</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsShownOnScreen">IsShownOnScreen</a>(self) -> bool<br> |
---|
867 | <br> |
---|
868 | Returns ``True`` if the window is physically visible on the screen,<br> |
---|
869 | i.e. it is shown and all its parents up to the toplevel window are<br> |
---|
870 | shown as well.</tt></dd></dl> |
---|
871 | |
---|
872 | <dl><dt><a name="XYpair-IsTopLevel"><strong>IsTopLevel</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsTopLevel">IsTopLevel</a>(self) -> bool<br> |
---|
873 | <br> |
---|
874 | Returns true if the given window is a top-level one. Currently all<br> |
---|
875 | frames and dialogs are always considered to be top-level windows (even<br> |
---|
876 | if they have a parent window).</tt></dd></dl> |
---|
877 | |
---|
878 | <dl><dt><a name="XYpair-Layout"><strong>Layout</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Layout">Layout</a>(self) -> bool<br> |
---|
879 | <br> |
---|
880 | Invokes the constraint-based layout algorithm or the sizer-based<br> |
---|
881 | algorithm for this window. See SetAutoLayout: when auto layout is on,<br> |
---|
882 | this function gets called automatically by the default EVT_SIZE<br> |
---|
883 | handler when the window is resized.</tt></dd></dl> |
---|
884 | |
---|
885 | <dl><dt><a name="XYpair-LineDown"><strong>LineDown</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-LineDown">LineDown</a>(self) -> bool<br> |
---|
886 | <br> |
---|
887 | This is just a wrapper for <a href="#XYpair-ScrollLines">ScrollLines</a>(1).</tt></dd></dl> |
---|
888 | |
---|
889 | <dl><dt><a name="XYpair-LineUp"><strong>LineUp</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-LineUp">LineUp</a>(self) -> bool<br> |
---|
890 | <br> |
---|
891 | This is just a wrapper for <a href="#XYpair-ScrollLines">ScrollLines</a>(-1).</tt></dd></dl> |
---|
892 | |
---|
893 | <dl><dt><a name="XYpair-Lower"><strong>Lower</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Lower">Lower</a>(self)<br> |
---|
894 | <br> |
---|
895 | Lowers the window to the bottom of the window hierarchy. In current<br> |
---|
896 | version of wxWidgets this works both for managed and child windows.</tt></dd></dl> |
---|
897 | |
---|
898 | <dl><dt><a name="XYpair-MakeModal"><strong>MakeModal</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-MakeModal">MakeModal</a>(self, bool modal=True)<br> |
---|
899 | <br> |
---|
900 | Disables all other windows in the application so that the user can<br> |
---|
901 | only interact with this window. Passing False will reverse this<br> |
---|
902 | effect.</tt></dd></dl> |
---|
903 | |
---|
904 | <dl><dt><a name="XYpair-Move"><strong>Move</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Move">Move</a>(self, Point pt, int flags=SIZE_USE_EXISTING)<br> |
---|
905 | <br> |
---|
906 | Moves the window to the given position.</tt></dd></dl> |
---|
907 | |
---|
908 | <dl><dt><a name="XYpair-MoveAfterInTabOrder"><strong>MoveAfterInTabOrder</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-MoveAfterInTabOrder">MoveAfterInTabOrder</a>(self, Window win)<br> |
---|
909 | <br> |
---|
910 | Moves this window in the tab navigation order after the specified<br> |
---|
911 | sibling window. This means that when the user presses the TAB key on<br> |
---|
912 | that other window, the focus switches to this window.<br> |
---|
913 | <br> |
---|
914 | The default tab order is the same as creation order. This function<br> |
---|
915 | and `MoveBeforeInTabOrder` allow to change it after creating all the<br> |
---|
916 | windows.</tt></dd></dl> |
---|
917 | |
---|
918 | <dl><dt><a name="XYpair-MoveBeforeInTabOrder"><strong>MoveBeforeInTabOrder</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-MoveBeforeInTabOrder">MoveBeforeInTabOrder</a>(self, Window win)<br> |
---|
919 | <br> |
---|
920 | Same as `MoveAfterInTabOrder` except that it inserts this window just<br> |
---|
921 | before win instead of putting it right after it.</tt></dd></dl> |
---|
922 | |
---|
923 | <dl><dt><a name="XYpair-MoveXY"><strong>MoveXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-MoveXY">MoveXY</a>(self, int x, int y, int flags=SIZE_USE_EXISTING)<br> |
---|
924 | <br> |
---|
925 | Moves the window to the given position.</tt></dd></dl> |
---|
926 | |
---|
927 | <dl><dt><a name="XYpair-Navigate"><strong>Navigate</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Navigate">Navigate</a>(self, int flags=NavigationKeyEvent.IsForward) -> bool<br> |
---|
928 | <br> |
---|
929 | Does keyboard navigation from this window to another, by sending a<br> |
---|
930 | `wx.NavigationKeyEvent`.</tt></dd></dl> |
---|
931 | |
---|
932 | <dl><dt><a name="XYpair-PageDown"><strong>PageDown</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-PageDown">PageDown</a>(self) -> bool<br> |
---|
933 | <br> |
---|
934 | This is just a wrapper for <a href="#XYpair-ScrollPages">ScrollPages</a>(1).</tt></dd></dl> |
---|
935 | |
---|
936 | <dl><dt><a name="XYpair-PageUp"><strong>PageUp</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-PageUp">PageUp</a>(self) -> bool<br> |
---|
937 | <br> |
---|
938 | This is just a wrapper for <a href="#XYpair-ScrollPages">ScrollPages</a>(-1).</tt></dd></dl> |
---|
939 | |
---|
940 | <dl><dt><a name="XYpair-PopEventHandler"><strong>PopEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-PopEventHandler">PopEventHandler</a>(self, bool deleteHandler=False) -> EvtHandler<br> |
---|
941 | <br> |
---|
942 | Removes and returns the top-most event handler on the event handler<br> |
---|
943 | stack. If deleteHandler is True then the wx.EvtHandler object will be<br> |
---|
944 | destroyed after it is popped, and ``None`` will be returned instead.</tt></dd></dl> |
---|
945 | |
---|
946 | <dl><dt><a name="XYpair-PopupMenu"><strong>PopupMenu</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-PopupMenu">PopupMenu</a>(self, Menu menu, Point pos=DefaultPosition) -> bool<br> |
---|
947 | <br> |
---|
948 | Pops up the given menu at the specified coordinates, relative to this window,<br> |
---|
949 | and returns control when the user has dismissed the menu. If a menu item is<br> |
---|
950 | selected, the corresponding menu event is generated and will be processed as<br> |
---|
951 | usual. If the default position is given then the current position of the<br> |
---|
952 | mouse cursor will be used.</tt></dd></dl> |
---|
953 | |
---|
954 | <dl><dt><a name="XYpair-PopupMenuXY"><strong>PopupMenuXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-PopupMenuXY">PopupMenuXY</a>(self, Menu menu, int x=-1, int y=-1) -> bool<br> |
---|
955 | <br> |
---|
956 | Pops up the given menu at the specified coordinates, relative to this window,<br> |
---|
957 | and returns control when the user has dismissed the menu. If a menu item is<br> |
---|
958 | selected, the corresponding menu event is generated and will be processed as<br> |
---|
959 | usual. If the default position is given then the current position of the<br> |
---|
960 | mouse cursor will be used.</tt></dd></dl> |
---|
961 | |
---|
962 | <dl><dt><a name="XYpair-PostCreate"><strong>PostCreate</strong></a>(self, pre)</dt><dd><tt>Phase 3 of the 2-phase create <wink!><br> |
---|
963 | Call this method after precreating the window with the 2-phase create method.</tt></dd></dl> |
---|
964 | |
---|
965 | <dl><dt><a name="XYpair-PrepareDC"><strong>PrepareDC</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-PrepareDC">PrepareDC</a>(self, DC dc)<br> |
---|
966 | <br> |
---|
967 | Call this function to prepare the device context for drawing a<br> |
---|
968 | scrolled image. It sets the device origin according to the current<br> |
---|
969 | scroll position.</tt></dd></dl> |
---|
970 | |
---|
971 | <dl><dt><a name="XYpair-PushEventHandler"><strong>PushEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-PushEventHandler">PushEventHandler</a>(self, EvtHandler handler)<br> |
---|
972 | <br> |
---|
973 | Pushes this event handler onto the event handler stack for the window.<br> |
---|
974 | An event handler is an object that is capable of processing the events<br> |
---|
975 | sent to a window. (In other words, is able to dispatch the events to a<br> |
---|
976 | handler function.) By default, the window is its own event handler,<br> |
---|
977 | but an application may wish to substitute another, for example to<br> |
---|
978 | allow central implementation of event-handling for a variety of<br> |
---|
979 | different window classes.<br> |
---|
980 | <br> |
---|
981 | wx.Window.PushEventHandler allows an application to set up a chain of<br> |
---|
982 | event handlers, where an event not handled by one event handler is<br> |
---|
983 | handed to the next one in the chain. Use `wx.Window.PopEventHandler`<br> |
---|
984 | to remove the event handler. Ownership of the handler is *not* given<br> |
---|
985 | to the window, so you should be sure to pop the handler before the<br> |
---|
986 | window is destroyed and either let PopEventHandler destroy it, or call<br> |
---|
987 | its Destroy method yourself.</tt></dd></dl> |
---|
988 | |
---|
989 | <dl><dt><a name="XYpair-Raise"><strong>Raise</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Raise">Raise</a>(self)<br> |
---|
990 | <br> |
---|
991 | Raises the window to the top of the window hierarchy. In current<br> |
---|
992 | version of wxWidgets this works both for managed and child windows.</tt></dd></dl> |
---|
993 | |
---|
994 | <dl><dt><a name="XYpair-Refresh"><strong>Refresh</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Refresh">Refresh</a>(self, bool eraseBackground=True, Rect rect=None)<br> |
---|
995 | <br> |
---|
996 | Mark the specified rectangle (or the whole window) as "dirty" so it<br> |
---|
997 | will be repainted. Causes an EVT_PAINT event to be generated and sent<br> |
---|
998 | to the window.</tt></dd></dl> |
---|
999 | |
---|
1000 | <dl><dt><a name="XYpair-RefreshRect"><strong>RefreshRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-RefreshRect">RefreshRect</a>(self, Rect rect, bool eraseBackground=True)<br> |
---|
1001 | <br> |
---|
1002 | Redraws the contents of the given rectangle: the area inside it will<br> |
---|
1003 | be repainted. This is the same as Refresh but has a nicer syntax.</tt></dd></dl> |
---|
1004 | |
---|
1005 | <dl><dt><a name="XYpair-RegisterHotKey"><strong>RegisterHotKey</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-RegisterHotKey">RegisterHotKey</a>(self, int hotkeyId, int modifiers, int keycode) -> bool<br> |
---|
1006 | <br> |
---|
1007 | Registers a system wide hotkey. Every time the user presses the hotkey<br> |
---|
1008 | registered here, this window will receive a hotkey event. It will<br> |
---|
1009 | receive the event even if the application is in the background and<br> |
---|
1010 | does not have the input focus because the user is working with some<br> |
---|
1011 | other application. To bind an event handler function to this hotkey<br> |
---|
1012 | use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the<br> |
---|
1013 | hotkey was registered successfully.</tt></dd></dl> |
---|
1014 | |
---|
1015 | <dl><dt><a name="XYpair-ReleaseMouse"><strong>ReleaseMouse</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ReleaseMouse">ReleaseMouse</a>(self)<br> |
---|
1016 | <br> |
---|
1017 | Releases mouse input captured with wx.Window.CaptureMouse.</tt></dd></dl> |
---|
1018 | |
---|
1019 | <dl><dt><a name="XYpair-RemoveChild"><strong>RemoveChild</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-RemoveChild">RemoveChild</a>(self, Window child)<br> |
---|
1020 | <br> |
---|
1021 | Removes a child window. This is called automatically by window<br> |
---|
1022 | deletion functions so should not be required by the application<br> |
---|
1023 | programmer.</tt></dd></dl> |
---|
1024 | |
---|
1025 | <dl><dt><a name="XYpair-RemoveEventHandler"><strong>RemoveEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-RemoveEventHandler">RemoveEventHandler</a>(self, EvtHandler handler) -> bool<br> |
---|
1026 | <br> |
---|
1027 | Find the given handler in the event handler chain and remove (but not<br> |
---|
1028 | delete) it from the event handler chain, returns True if it was found<br> |
---|
1029 | and False otherwise (this also results in an assert failure so this<br> |
---|
1030 | function should only be called when the handler is supposed to be<br> |
---|
1031 | there.)</tt></dd></dl> |
---|
1032 | |
---|
1033 | <dl><dt><a name="XYpair-Reparent"><strong>Reparent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Reparent">Reparent</a>(self, Window newParent) -> bool<br> |
---|
1034 | <br> |
---|
1035 | Reparents the window, i.e the window will be removed from its current<br> |
---|
1036 | parent window (e.g. a non-standard toolbar in a wxFrame) and then<br> |
---|
1037 | re-inserted into another. Available on Windows and GTK. Returns True<br> |
---|
1038 | if the parent was changed, False otherwise (error or newParent ==<br> |
---|
1039 | oldParent)</tt></dd></dl> |
---|
1040 | |
---|
1041 | <dl><dt><a name="XYpair-ScreenToClient"><strong>ScreenToClient</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ScreenToClient">ScreenToClient</a>(self, Point pt) -> Point<br> |
---|
1042 | <br> |
---|
1043 | Converts from screen to client window coordinates.</tt></dd></dl> |
---|
1044 | |
---|
1045 | <dl><dt><a name="XYpair-ScreenToClientXY"><strong>ScreenToClientXY</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ScreenToClientXY">ScreenToClientXY</a>(int x, int y) -> (x,y)<br> |
---|
1046 | <br> |
---|
1047 | Converts from screen to client window coordinates.</tt></dd></dl> |
---|
1048 | |
---|
1049 | <dl><dt><a name="XYpair-ScrollLines"><strong>ScrollLines</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ScrollLines">ScrollLines</a>(self, int lines) -> bool<br> |
---|
1050 | <br> |
---|
1051 | If the platform and window class supports it, scrolls the window by<br> |
---|
1052 | the given number of lines down, if lines is positive, or up if lines<br> |
---|
1053 | is negative. Returns True if the window was scrolled, False if it was<br> |
---|
1054 | already on top/bottom and nothing was done.</tt></dd></dl> |
---|
1055 | |
---|
1056 | <dl><dt><a name="XYpair-ScrollPages"><strong>ScrollPages</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ScrollPages">ScrollPages</a>(self, int pages) -> bool<br> |
---|
1057 | <br> |
---|
1058 | If the platform and window class supports it, scrolls the window by<br> |
---|
1059 | the given number of pages down, if pages is positive, or up if pages<br> |
---|
1060 | is negative. Returns True if the window was scrolled, False if it was<br> |
---|
1061 | already on top/bottom and nothing was done.</tt></dd></dl> |
---|
1062 | |
---|
1063 | <dl><dt><a name="XYpair-ScrollWindow"><strong>ScrollWindow</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ScrollWindow">ScrollWindow</a>(self, int dx, int dy, Rect rect=None)<br> |
---|
1064 | <br> |
---|
1065 | Physically scrolls the pixels in the window and move child windows<br> |
---|
1066 | accordingly. Use this function to optimise your scrolling<br> |
---|
1067 | implementations, to minimise the area that must be redrawn. Note that<br> |
---|
1068 | it is rarely required to call this function from a user program.</tt></dd></dl> |
---|
1069 | |
---|
1070 | <dl><dt><a name="XYpair-SendSizeEvent"><strong>SendSizeEvent</strong></a>(self)</dt></dl> |
---|
1071 | |
---|
1072 | <dl><dt><a name="XYpair-SetAcceleratorTable"><strong>SetAcceleratorTable</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetAcceleratorTable">SetAcceleratorTable</a>(self, AcceleratorTable accel)<br> |
---|
1073 | <br> |
---|
1074 | Sets the accelerator table for this window.</tt></dd></dl> |
---|
1075 | |
---|
1076 | <dl><dt><a name="XYpair-SetAutoLayout"><strong>SetAutoLayout</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetAutoLayout">SetAutoLayout</a>(self, bool autoLayout)<br> |
---|
1077 | <br> |
---|
1078 | Determines whether the Layout function will be called automatically<br> |
---|
1079 | when the window is resized. lease note that this only happens for the<br> |
---|
1080 | windows usually used to contain children, namely `wx.<a href="wx._windows.html#Panel">Panel</a>` and<br> |
---|
1081 | `wx.TopLevelWindow` (and the classes deriving from them).<br> |
---|
1082 | <br> |
---|
1083 | This method is called implicitly by `SetSizer` but if you use<br> |
---|
1084 | `SetConstraints` you should call it manually or otherwise the window<br> |
---|
1085 | layout won't be correctly updated when its size changes.</tt></dd></dl> |
---|
1086 | |
---|
1087 | <dl><dt><a name="XYpair-SetBackgroundColour"><strong>SetBackgroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetBackgroundColour">SetBackgroundColour</a>(self, Colour colour) -> bool<br> |
---|
1088 | <br> |
---|
1089 | Sets the background colour of the window. Returns True if the colour<br> |
---|
1090 | was changed. The background colour is usually painted by the default<br> |
---|
1091 | EVT_ERASE_BACKGROUND event handler function under Windows and<br> |
---|
1092 | automatically under GTK. Using `wx.NullColour` will reset the window<br> |
---|
1093 | to the default background colour.<br> |
---|
1094 | <br> |
---|
1095 | Note that setting the background colour may not cause an immediate<br> |
---|
1096 | refresh, so you may wish to call `ClearBackground` or `Refresh` after<br> |
---|
1097 | calling this function.<br> |
---|
1098 | <br> |
---|
1099 | Using this function will disable attempts to use themes for this<br> |
---|
1100 | window, if the system supports them. Use with care since usually the<br> |
---|
1101 | themes represent the appearance chosen by the user to be used for all<br> |
---|
1102 | applications on the system.</tt></dd></dl> |
---|
1103 | |
---|
1104 | <dl><dt><a name="XYpair-SetBackgroundStyle"><strong>SetBackgroundStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetBackgroundStyle">SetBackgroundStyle</a>(self, int style) -> bool<br> |
---|
1105 | <br> |
---|
1106 | Returns the background style of the window. The background style<br> |
---|
1107 | indicates how the background of the window is drawn.<br> |
---|
1108 | <br> |
---|
1109 | ====================== ========================================<br> |
---|
1110 | wx.BG_STYLE_SYSTEM The background colour or pattern should<br> |
---|
1111 | be determined by the system<br> |
---|
1112 | wx.BG_STYLE_COLOUR The background should be a solid colour<br> |
---|
1113 | wx.BG_STYLE_CUSTOM The background will be implemented by the<br> |
---|
1114 | application.<br> |
---|
1115 | ====================== ========================================<br> |
---|
1116 | <br> |
---|
1117 | On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of<br> |
---|
1118 | a custom background, such as a tiled bitmap. Currently the style has<br> |
---|
1119 | no effect on other platforms.<br> |
---|
1120 | <br> |
---|
1121 | :see: `GetBackgroundStyle`, `SetBackgroundColour`</tt></dd></dl> |
---|
1122 | |
---|
1123 | <dl><dt><a name="XYpair-SetBestFittingSize"><strong>SetBestFittingSize</strong></a> = deprecatedWrapper(*args, **kwargs)</dt><dd><tt>Use `SetInitialSize`</tt></dd></dl> |
---|
1124 | |
---|
1125 | <dl><dt><a name="XYpair-SetCaret"><strong>SetCaret</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetCaret">SetCaret</a>(self, Caret caret)<br> |
---|
1126 | <br> |
---|
1127 | Sets the caret associated with the window.</tt></dd></dl> |
---|
1128 | |
---|
1129 | <dl><dt><a name="XYpair-SetClientRect"><strong>SetClientRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetClientRect">SetClientRect</a>(self, Rect rect)<br> |
---|
1130 | <br> |
---|
1131 | This sets the size of the window client area in pixels. Using this<br> |
---|
1132 | function to size a window tends to be more device-independent than<br> |
---|
1133 | wx.Window.SetSize, since the application need not worry about what<br> |
---|
1134 | dimensions the border or title bar have when trying to fit the window<br> |
---|
1135 | around panel items, for example.</tt></dd></dl> |
---|
1136 | |
---|
1137 | <dl><dt><a name="XYpair-SetClientSize"><strong>SetClientSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetClientSize">SetClientSize</a>(self, Size size)<br> |
---|
1138 | <br> |
---|
1139 | This sets the size of the window client area in pixels. Using this<br> |
---|
1140 | function to size a window tends to be more device-independent than<br> |
---|
1141 | wx.Window.SetSize, since the application need not worry about what<br> |
---|
1142 | dimensions the border or title bar have when trying to fit the window<br> |
---|
1143 | around panel items, for example.</tt></dd></dl> |
---|
1144 | |
---|
1145 | <dl><dt><a name="XYpair-SetClientSizeWH"><strong>SetClientSizeWH</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetClientSizeWH">SetClientSizeWH</a>(self, int width, int height)<br> |
---|
1146 | <br> |
---|
1147 | This sets the size of the window client area in pixels. Using this<br> |
---|
1148 | function to size a window tends to be more device-independent than<br> |
---|
1149 | wx.Window.SetSize, since the application need not worry about what<br> |
---|
1150 | dimensions the border or title bar have when trying to fit the window<br> |
---|
1151 | around panel items, for example.</tt></dd></dl> |
---|
1152 | |
---|
1153 | <dl><dt><a name="XYpair-SetConstraints"><strong>SetConstraints</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetConstraints">SetConstraints</a>(self, LayoutConstraints constraints)<br> |
---|
1154 | <br> |
---|
1155 | Sets the window to have the given layout constraints. If an existing<br> |
---|
1156 | layout constraints object is already owned by the window, it will be<br> |
---|
1157 | deleted. Pass None to disassociate and delete the window's current<br> |
---|
1158 | constraints.<br> |
---|
1159 | <br> |
---|
1160 | You must call SetAutoLayout to tell a window to use the constraints<br> |
---|
1161 | automatically in its default EVT_SIZE handler; otherwise, you must<br> |
---|
1162 | handle EVT_SIZE yourself and call <a href="#XYpair-Layout">Layout</a>() explicitly. When setting<br> |
---|
1163 | both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have<br> |
---|
1164 | effect.</tt></dd></dl> |
---|
1165 | |
---|
1166 | <dl><dt><a name="XYpair-SetContainingSizer"><strong>SetContainingSizer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetContainingSizer">SetContainingSizer</a>(self, Sizer sizer)<br> |
---|
1167 | <br> |
---|
1168 | This normally does not need to be called by application code. It is<br> |
---|
1169 | called internally when a window is added to a sizer, and is used so<br> |
---|
1170 | the window can remove itself from the sizer when it is destroyed.</tt></dd></dl> |
---|
1171 | |
---|
1172 | <dl><dt><a name="XYpair-SetCursor"><strong>SetCursor</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetCursor">SetCursor</a>(self, Cursor cursor) -> bool<br> |
---|
1173 | <br> |
---|
1174 | Sets the window's cursor. Notice that the window cursor also sets it<br> |
---|
1175 | for the children of the window implicitly.<br> |
---|
1176 | <br> |
---|
1177 | The cursor may be wx.NullCursor in which case the window cursor will<br> |
---|
1178 | be reset back to default.</tt></dd></dl> |
---|
1179 | |
---|
1180 | <dl><dt><a name="XYpair-SetDimensions"><strong>SetDimensions</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetDimensions">SetDimensions</a>(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)<br> |
---|
1181 | <br> |
---|
1182 | Sets the position and size of the window in pixels. The sizeFlags<br> |
---|
1183 | parameter indicates the interpretation of the other params if they are<br> |
---|
1184 | equal to -1.<br> |
---|
1185 | <br> |
---|
1186 | ======================== ======================================<br> |
---|
1187 | wx.SIZE_AUTO A -1 indicates that a class-specific<br> |
---|
1188 | default should be used.<br> |
---|
1189 | wx.SIZE_USE_EXISTING Axisting dimensions should be used if<br> |
---|
1190 | -1 values are supplied.<br> |
---|
1191 | wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be<br> |
---|
1192 | interpreted as real dimensions, not<br> |
---|
1193 | default values.<br> |
---|
1194 | ======================== ======================================</tt></dd></dl> |
---|
1195 | |
---|
1196 | <dl><dt><a name="XYpair-SetDoubleBuffered"><strong>SetDoubleBuffered</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetDoubleBuffered">SetDoubleBuffered</a>(self, bool on)<br> |
---|
1197 | <br> |
---|
1198 | Currently wxGTK2 only.</tt></dd></dl> |
---|
1199 | |
---|
1200 | <dl><dt><a name="XYpair-SetDropTarget"><strong>SetDropTarget</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetDropTarget">SetDropTarget</a>(self, DropTarget dropTarget)<br> |
---|
1201 | <br> |
---|
1202 | Associates a drop target with this window. If the window already has<br> |
---|
1203 | a drop target, it is deleted.</tt></dd></dl> |
---|
1204 | |
---|
1205 | <dl><dt><a name="XYpair-SetEventHandler"><strong>SetEventHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetEventHandler">SetEventHandler</a>(self, EvtHandler handler)<br> |
---|
1206 | <br> |
---|
1207 | Sets the event handler for this window. An event handler is an object<br> |
---|
1208 | that is capable of processing the events sent to a window. (In other<br> |
---|
1209 | words, is able to dispatch the events to handler function.) By<br> |
---|
1210 | default, the window is its own event handler, but an application may<br> |
---|
1211 | wish to substitute another, for example to allow central<br> |
---|
1212 | implementation of event-handling for a variety of different window<br> |
---|
1213 | classes.<br> |
---|
1214 | <br> |
---|
1215 | It is usually better to use `wx.Window.PushEventHandler` since this sets<br> |
---|
1216 | up a chain of event handlers, where an event not handled by one event<br> |
---|
1217 | handler is handed off to the next one in the chain.</tt></dd></dl> |
---|
1218 | |
---|
1219 | <dl><dt><a name="XYpair-SetExtraStyle"><strong>SetExtraStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetExtraStyle">SetExtraStyle</a>(self, long exStyle)<br> |
---|
1220 | <br> |
---|
1221 | Sets the extra style bits for the window. Extra styles are the less<br> |
---|
1222 | often used style bits which can't be set with the constructor or with<br> |
---|
1223 | <a href="#XYpair-SetWindowStyleFlag">SetWindowStyleFlag</a>()</tt></dd></dl> |
---|
1224 | |
---|
1225 | <dl><dt><a name="XYpair-SetFocus"><strong>SetFocus</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetFocus">SetFocus</a>(self)<br> |
---|
1226 | <br> |
---|
1227 | Set's the focus to this window, allowing it to receive keyboard input.</tt></dd></dl> |
---|
1228 | |
---|
1229 | <dl><dt><a name="XYpair-SetFocusFromKbd"><strong>SetFocusFromKbd</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetFocusFromKbd">SetFocusFromKbd</a>(self)<br> |
---|
1230 | <br> |
---|
1231 | Set focus to this window as the result of a keyboard action. Normally<br> |
---|
1232 | only called internally.</tt></dd></dl> |
---|
1233 | |
---|
1234 | <dl><dt><a name="XYpair-SetFont"><strong>SetFont</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetFont">SetFont</a>(self, Font font) -> bool<br> |
---|
1235 | <br> |
---|
1236 | Sets the font for this window.</tt></dd></dl> |
---|
1237 | |
---|
1238 | <dl><dt><a name="XYpair-SetForegroundColour"><strong>SetForegroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetForegroundColour">SetForegroundColour</a>(self, Colour colour) -> bool<br> |
---|
1239 | <br> |
---|
1240 | Sets the foreground colour of the window. Returns True is the colour<br> |
---|
1241 | was changed. The interpretation of foreground colour is dependent on<br> |
---|
1242 | the window class; it may be the text colour or other colour, or it may<br> |
---|
1243 | not be used at all.</tt></dd></dl> |
---|
1244 | |
---|
1245 | <dl><dt><a name="XYpair-SetHelpText"><strong>SetHelpText</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetHelpText">SetHelpText</a>(self, String text)<br> |
---|
1246 | <br> |
---|
1247 | Sets the help text to be used as context-sensitive help for this<br> |
---|
1248 | window. Note that the text is actually stored by the current<br> |
---|
1249 | `wx.HelpProvider` implementation, and not in the window object itself.</tt></dd></dl> |
---|
1250 | |
---|
1251 | <dl><dt><a name="XYpair-SetHelpTextForId"><strong>SetHelpTextForId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetHelpTextForId">SetHelpTextForId</a>(self, String text)<br> |
---|
1252 | <br> |
---|
1253 | Associate this help text with all windows with the same id as this<br> |
---|
1254 | one.</tt></dd></dl> |
---|
1255 | |
---|
1256 | <dl><dt><a name="XYpair-SetId"><strong>SetId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetId">SetId</a>(self, int winid)<br> |
---|
1257 | <br> |
---|
1258 | Sets the identifier of the window. Each window has an integer<br> |
---|
1259 | identifier. If the application has not provided one, an identifier<br> |
---|
1260 | will be generated. Normally, the identifier should be provided on<br> |
---|
1261 | creation and should not be modified subsequently.</tt></dd></dl> |
---|
1262 | |
---|
1263 | <dl><dt><a name="XYpair-SetInitialSize"><strong>SetInitialSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetInitialSize">SetInitialSize</a>(self, Size size=DefaultSize)<br> |
---|
1264 | <br> |
---|
1265 | A 'Smart' SetSize that will fill in default size components with the<br> |
---|
1266 | window's *best size* values. Also set's the minsize for use with sizers.</tt></dd></dl> |
---|
1267 | |
---|
1268 | <dl><dt><a name="XYpair-SetLabel"><strong>SetLabel</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetLabel">SetLabel</a>(self, String label)<br> |
---|
1269 | <br> |
---|
1270 | Set the text which the window shows in its label if applicable.</tt></dd></dl> |
---|
1271 | |
---|
1272 | <dl><dt><a name="XYpair-SetLayoutDirection"><strong>SetLayoutDirection</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetLayoutDirection">SetLayoutDirection</a>(self, int dir)<br> |
---|
1273 | <br> |
---|
1274 | Set the layout direction (LTR or RTL) for this window.</tt></dd></dl> |
---|
1275 | |
---|
1276 | <dl><dt><a name="XYpair-SetMaxSize"><strong>SetMaxSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetMaxSize">SetMaxSize</a>(self, Size maxSize)<br> |
---|
1277 | <br> |
---|
1278 | A more convenient method than `SetSizeHints` for setting just the<br> |
---|
1279 | max size.</tt></dd></dl> |
---|
1280 | |
---|
1281 | <dl><dt><a name="XYpair-SetMinSize"><strong>SetMinSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetMinSize">SetMinSize</a>(self, Size minSize)<br> |
---|
1282 | <br> |
---|
1283 | A more convenient method than `SetSizeHints` for setting just the<br> |
---|
1284 | min size.</tt></dd></dl> |
---|
1285 | |
---|
1286 | <dl><dt><a name="XYpair-SetName"><strong>SetName</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetName">SetName</a>(self, String name)<br> |
---|
1287 | <br> |
---|
1288 | Sets the window's name. The window name is used for ressource setting<br> |
---|
1289 | in X, it is not the same as the window title/label</tt></dd></dl> |
---|
1290 | |
---|
1291 | <dl><dt><a name="XYpair-SetOwnBackgroundColour"><strong>SetOwnBackgroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetOwnBackgroundColour">SetOwnBackgroundColour</a>(self, Colour colour)</tt></dd></dl> |
---|
1292 | |
---|
1293 | <dl><dt><a name="XYpair-SetOwnFont"><strong>SetOwnFont</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetOwnFont">SetOwnFont</a>(self, Font font)</tt></dd></dl> |
---|
1294 | |
---|
1295 | <dl><dt><a name="XYpair-SetOwnForegroundColour"><strong>SetOwnForegroundColour</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetOwnForegroundColour">SetOwnForegroundColour</a>(self, Colour colour)</tt></dd></dl> |
---|
1296 | |
---|
1297 | <dl><dt><a name="XYpair-SetPosition"><strong>SetPosition</strong></a> = Move(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Move">Move</a>(self, Point pt, int flags=SIZE_USE_EXISTING)<br> |
---|
1298 | <br> |
---|
1299 | Moves the window to the given position.</tt></dd></dl> |
---|
1300 | |
---|
1301 | <dl><dt><a name="XYpair-SetRect"><strong>SetRect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetRect">SetRect</a>(self, Rect rect, int sizeFlags=SIZE_AUTO)<br> |
---|
1302 | <br> |
---|
1303 | Sets the position and size of the window in pixels using a wx.Rect.</tt></dd></dl> |
---|
1304 | |
---|
1305 | <dl><dt><a name="XYpair-SetScrollPos"><strong>SetScrollPos</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetScrollPos">SetScrollPos</a>(self, int orientation, int pos, bool refresh=True)<br> |
---|
1306 | <br> |
---|
1307 | Sets the position of one of the built-in scrollbars.</tt></dd></dl> |
---|
1308 | |
---|
1309 | <dl><dt><a name="XYpair-SetScrollbar"><strong>SetScrollbar</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetScrollbar">SetScrollbar</a>(self, int orientation, int position, int thumbSize, int range, <br> |
---|
1310 | bool refresh=True)<br> |
---|
1311 | <br> |
---|
1312 | Sets the scrollbar properties of a built-in scrollbar.</tt></dd></dl> |
---|
1313 | |
---|
1314 | <dl><dt><a name="XYpair-SetSize"><strong>SetSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetSize">SetSize</a>(self, Size size)<br> |
---|
1315 | <br> |
---|
1316 | Sets the size of the window in pixels.</tt></dd></dl> |
---|
1317 | |
---|
1318 | <dl><dt><a name="XYpair-SetSizeHints"><strong>SetSizeHints</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetSizeHints">SetSizeHints</a>(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, <br> |
---|
1319 | int incH=-1)<br> |
---|
1320 | <br> |
---|
1321 | Allows specification of minimum and maximum window sizes, and window<br> |
---|
1322 | size increments. If a pair of values is not set (or set to -1), the<br> |
---|
1323 | default values will be used. If this function is called, the user<br> |
---|
1324 | will not be able to size the window outside the given bounds (if it is<br> |
---|
1325 | a top-level window.) Sizers will also inspect the minimum window size<br> |
---|
1326 | and will use that value if set when calculating layout.<br> |
---|
1327 | <br> |
---|
1328 | The resizing increments are only significant under Motif or Xt.</tt></dd></dl> |
---|
1329 | |
---|
1330 | <dl><dt><a name="XYpair-SetSizeHintsSz"><strong>SetSizeHintsSz</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetSizeHintsSz">SetSizeHintsSz</a>(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)<br> |
---|
1331 | <br> |
---|
1332 | Allows specification of minimum and maximum window sizes, and window<br> |
---|
1333 | size increments. If a pair of values is not set (or set to -1), the<br> |
---|
1334 | default values will be used. If this function is called, the user<br> |
---|
1335 | will not be able to size the window outside the given bounds (if it is<br> |
---|
1336 | a top-level window.) Sizers will also inspect the minimum window size<br> |
---|
1337 | and will use that value if set when calculating layout.<br> |
---|
1338 | <br> |
---|
1339 | The resizing increments are only significant under Motif or Xt.</tt></dd></dl> |
---|
1340 | |
---|
1341 | <dl><dt><a name="XYpair-SetSizeWH"><strong>SetSizeWH</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetSizeWH">SetSizeWH</a>(self, int width, int height)<br> |
---|
1342 | <br> |
---|
1343 | Sets the size of the window in pixels.</tt></dd></dl> |
---|
1344 | |
---|
1345 | <dl><dt><a name="XYpair-SetSizer"><strong>SetSizer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetSizer">SetSizer</a>(self, Sizer sizer, bool deleteOld=True)<br> |
---|
1346 | <br> |
---|
1347 | Sets the window to have the given layout sizer. The window will then<br> |
---|
1348 | own the object, and will take care of its deletion. If an existing<br> |
---|
1349 | layout sizer object is already owned by the window, it will be deleted<br> |
---|
1350 | if the deleteOld parameter is true. Note that this function will also<br> |
---|
1351 | call SetAutoLayout implicitly with a True parameter if the sizer is<br> |
---|
1352 | non-None, and False otherwise.</tt></dd></dl> |
---|
1353 | |
---|
1354 | <dl><dt><a name="XYpair-SetSizerAndFit"><strong>SetSizerAndFit</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetSizerAndFit">SetSizerAndFit</a>(self, Sizer sizer, bool deleteOld=True)<br> |
---|
1355 | <br> |
---|
1356 | The same as SetSizer, except it also sets the size hints for the<br> |
---|
1357 | window based on the sizer's minimum size.</tt></dd></dl> |
---|
1358 | |
---|
1359 | <dl><dt><a name="XYpair-SetThemeEnabled"><strong>SetThemeEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetThemeEnabled">SetThemeEnabled</a>(self, bool enableTheme)<br> |
---|
1360 | <br> |
---|
1361 | This function tells a window if it should use the system's "theme"<br> |
---|
1362 | code to draw the windows' background instead if its own background<br> |
---|
1363 | drawing code. This will only have an effect on platforms that support<br> |
---|
1364 | the notion of themes in user defined windows. One such platform is<br> |
---|
1365 | GTK+ where windows can have (very colourful) backgrounds defined by a<br> |
---|
1366 | user's selected theme.<br> |
---|
1367 | <br> |
---|
1368 | Dialogs, notebook pages and the status bar have this flag set to true<br> |
---|
1369 | by default so that the default look and feel is simulated best.</tt></dd></dl> |
---|
1370 | |
---|
1371 | <dl><dt><a name="XYpair-SetToolTip"><strong>SetToolTip</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetToolTip">SetToolTip</a>(self, ToolTip tip)<br> |
---|
1372 | <br> |
---|
1373 | Attach a tooltip to the window.</tt></dd></dl> |
---|
1374 | |
---|
1375 | <dl><dt><a name="XYpair-SetToolTipString"><strong>SetToolTipString</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetToolTipString">SetToolTipString</a>(self, String tip)<br> |
---|
1376 | <br> |
---|
1377 | Attach a tooltip to the window.</tt></dd></dl> |
---|
1378 | |
---|
1379 | <dl><dt><a name="XYpair-SetTransparent"><strong>SetTransparent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetTransparent">SetTransparent</a>(self, byte alpha) -> bool<br> |
---|
1380 | <br> |
---|
1381 | Attempt to set the transparency of this window to the ``alpha`` value,<br> |
---|
1382 | returns True on success. The ``alpha`` value is an integer in the<br> |
---|
1383 | range of 0 to 255, where 0 is fully transparent and 255 is fully<br> |
---|
1384 | opaque.</tt></dd></dl> |
---|
1385 | |
---|
1386 | <dl><dt><a name="XYpair-SetValidator"><strong>SetValidator</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetValidator">SetValidator</a>(self, Validator validator)<br> |
---|
1387 | <br> |
---|
1388 | Deletes the current validator (if any) and sets the window validator,<br> |
---|
1389 | having called wx.Validator.Clone to create a new validator of this<br> |
---|
1390 | type.</tt></dd></dl> |
---|
1391 | |
---|
1392 | <dl><dt><a name="XYpair-SetVirtualSize"><strong>SetVirtualSize</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetVirtualSize">SetVirtualSize</a>(self, Size size)<br> |
---|
1393 | <br> |
---|
1394 | Set the the virtual size of a window in pixels. For most windows this<br> |
---|
1395 | is just the client area of the window, but for some like scrolled<br> |
---|
1396 | windows it is more or less independent of the screen window size.</tt></dd></dl> |
---|
1397 | |
---|
1398 | <dl><dt><a name="XYpair-SetVirtualSizeHints"><strong>SetVirtualSizeHints</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetVirtualSizeHints">SetVirtualSizeHints</a>(self, int minW, int minH, int maxW=-1, int maxH=-1)<br> |
---|
1399 | <br> |
---|
1400 | Allows specification of minimum and maximum virtual window sizes. If a<br> |
---|
1401 | pair of values is not set (or set to -1), the default values will be<br> |
---|
1402 | used. If this function is called, the user will not be able to size<br> |
---|
1403 | the virtual area of the window outside the given bounds.</tt></dd></dl> |
---|
1404 | |
---|
1405 | <dl><dt><a name="XYpair-SetVirtualSizeHintsSz"><strong>SetVirtualSizeHintsSz</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetVirtualSizeHintsSz">SetVirtualSizeHintsSz</a>(self, Size minSize, Size maxSize=DefaultSize)<br> |
---|
1406 | <br> |
---|
1407 | Allows specification of minimum and maximum virtual window sizes. If a<br> |
---|
1408 | pair of values is not set (or set to -1), the default values will be<br> |
---|
1409 | used. If this function is called, the user will not be able to size<br> |
---|
1410 | the virtual area of the window outside the given bounds.</tt></dd></dl> |
---|
1411 | |
---|
1412 | <dl><dt><a name="XYpair-SetVirtualSizeWH"><strong>SetVirtualSizeWH</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetVirtualSizeWH">SetVirtualSizeWH</a>(self, int w, int h)<br> |
---|
1413 | <br> |
---|
1414 | Set the the virtual size of a window in pixels. For most windows this<br> |
---|
1415 | is just the client area of the window, but for some like scrolled<br> |
---|
1416 | windows it is more or less independent of the screen window size.</tt></dd></dl> |
---|
1417 | |
---|
1418 | <dl><dt><a name="XYpair-SetWindowStyle"><strong>SetWindowStyle</strong></a> = SetWindowStyleFlag(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetWindowStyleFlag">SetWindowStyleFlag</a>(self, long style)<br> |
---|
1419 | <br> |
---|
1420 | Sets the style of the window. Please note that some styles cannot be<br> |
---|
1421 | changed after the window creation and that <a href="#XYpair-Refresh">Refresh</a>() might need to be<br> |
---|
1422 | called after changing the others for the change to take place<br> |
---|
1423 | immediately.</tt></dd></dl> |
---|
1424 | |
---|
1425 | <dl><dt><a name="XYpair-SetWindowStyleFlag"><strong>SetWindowStyleFlag</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetWindowStyleFlag">SetWindowStyleFlag</a>(self, long style)<br> |
---|
1426 | <br> |
---|
1427 | Sets the style of the window. Please note that some styles cannot be<br> |
---|
1428 | changed after the window creation and that <a href="#XYpair-Refresh">Refresh</a>() might need to be<br> |
---|
1429 | called after changing the others for the change to take place<br> |
---|
1430 | immediately.</tt></dd></dl> |
---|
1431 | |
---|
1432 | <dl><dt><a name="XYpair-SetWindowVariant"><strong>SetWindowVariant</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetWindowVariant">SetWindowVariant</a>(self, int variant)<br> |
---|
1433 | <br> |
---|
1434 | Sets the variant of the window/font size to use for this window, if<br> |
---|
1435 | the platform supports variants, for example, wxMac.</tt></dd></dl> |
---|
1436 | |
---|
1437 | <dl><dt><a name="XYpair-ShouldInheritColours"><strong>ShouldInheritColours</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ShouldInheritColours">ShouldInheritColours</a>(self) -> bool<br> |
---|
1438 | <br> |
---|
1439 | Return true from here to allow the colours of this window to be<br> |
---|
1440 | changed by InheritAttributes, returning false forbids inheriting them<br> |
---|
1441 | from the parent window.<br> |
---|
1442 | <br> |
---|
1443 | The base class version returns false, but this method is overridden in<br> |
---|
1444 | wxControl where it returns true.</tt></dd></dl> |
---|
1445 | |
---|
1446 | <dl><dt><a name="XYpair-Show"><strong>Show</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Show">Show</a>(self, bool show=True) -> bool<br> |
---|
1447 | <br> |
---|
1448 | Shows or hides the window. You may need to call Raise for a top level<br> |
---|
1449 | window if you want to bring it to top, although this is not needed if<br> |
---|
1450 | Show is called immediately after the frame creation. Returns True if<br> |
---|
1451 | the window has been shown or hidden or False if nothing was done<br> |
---|
1452 | because it already was in the requested state.</tt></dd></dl> |
---|
1453 | |
---|
1454 | <dl><dt><a name="XYpair-Thaw"><strong>Thaw</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Thaw">Thaw</a>(self)<br> |
---|
1455 | <br> |
---|
1456 | Reenables window updating after a previous call to Freeze. Calls to<br> |
---|
1457 | Freeze/Thaw may be nested, so Thaw must be called the same number of<br> |
---|
1458 | times that Freeze was before the window will be updated.</tt></dd></dl> |
---|
1459 | |
---|
1460 | <dl><dt><a name="XYpair-ToggleWindowStyle"><strong>ToggleWindowStyle</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ToggleWindowStyle">ToggleWindowStyle</a>(self, int flag) -> bool<br> |
---|
1461 | <br> |
---|
1462 | Turn the flag on if it had been turned off before and vice versa,<br> |
---|
1463 | returns True if the flag is turned on by this function call.</tt></dd></dl> |
---|
1464 | |
---|
1465 | <dl><dt><a name="XYpair-TransferDataFromWindow"><strong>TransferDataFromWindow</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-TransferDataFromWindow">TransferDataFromWindow</a>(self) -> bool<br> |
---|
1466 | <br> |
---|
1467 | Transfers values from child controls to data areas specified by their<br> |
---|
1468 | validators. Returns false if a transfer failed. If the window has<br> |
---|
1469 | wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will<br> |
---|
1470 | also call <a href="#XYpair-TransferDataFromWindow">TransferDataFromWindow</a>() of all child windows.</tt></dd></dl> |
---|
1471 | |
---|
1472 | <dl><dt><a name="XYpair-TransferDataToWindow"><strong>TransferDataToWindow</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-TransferDataToWindow">TransferDataToWindow</a>(self) -> bool<br> |
---|
1473 | <br> |
---|
1474 | Transfers values to child controls from data areas specified by their<br> |
---|
1475 | validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra<br> |
---|
1476 | style flag set, the method will also call <a href="#XYpair-TransferDataToWindow">TransferDataToWindow</a>() of<br> |
---|
1477 | all child windows.</tt></dd></dl> |
---|
1478 | |
---|
1479 | <dl><dt><a name="XYpair-UnregisterHotKey"><strong>UnregisterHotKey</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-UnregisterHotKey">UnregisterHotKey</a>(self, int hotkeyId) -> bool<br> |
---|
1480 | <br> |
---|
1481 | Unregisters a system wide hotkey.</tt></dd></dl> |
---|
1482 | |
---|
1483 | <dl><dt><a name="XYpair-Update"><strong>Update</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Update">Update</a>(self)<br> |
---|
1484 | <br> |
---|
1485 | Calling this method immediately repaints the invalidated area of the<br> |
---|
1486 | window instead of waiting for the EVT_PAINT event to happen, (normally<br> |
---|
1487 | this would usually only happen when the flow of control returns to the<br> |
---|
1488 | event loop.) Notice that this function doesn't refresh the window and<br> |
---|
1489 | does nothing if the window has been already repainted. Use `Refresh`<br> |
---|
1490 | first if you want to immediately redraw the window (or some portion of<br> |
---|
1491 | it) unconditionally.</tt></dd></dl> |
---|
1492 | |
---|
1493 | <dl><dt><a name="XYpair-UpdateWindowUI"><strong>UpdateWindowUI</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-UpdateWindowUI">UpdateWindowUI</a>(self, long flags=UPDATE_UI_NONE)<br> |
---|
1494 | <br> |
---|
1495 | This function sends EVT_UPDATE_UI events to the window. The particular<br> |
---|
1496 | implementation depends on the window; for example a wx.ToolBar will<br> |
---|
1497 | send an update UI event for each toolbar button, and a wx.Frame will<br> |
---|
1498 | send an update UI event for each menubar menu item. You can call this<br> |
---|
1499 | function from your application to ensure that your UI is up-to-date at<br> |
---|
1500 | a particular point in time (as far as your EVT_UPDATE_UI handlers are<br> |
---|
1501 | concerned). This may be necessary if you have called<br> |
---|
1502 | `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to<br> |
---|
1503 | limit the overhead that wxWindows incurs by sending update UI events<br> |
---|
1504 | in idle time.</tt></dd></dl> |
---|
1505 | |
---|
1506 | <dl><dt><a name="XYpair-UseBgCol"><strong>UseBgCol</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-UseBgCol">UseBgCol</a>(self) -> bool</tt></dd></dl> |
---|
1507 | |
---|
1508 | <dl><dt><a name="XYpair-Validate"><strong>Validate</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Validate">Validate</a>(self) -> bool<br> |
---|
1509 | <br> |
---|
1510 | Validates the current values of the child controls using their<br> |
---|
1511 | validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra<br> |
---|
1512 | style flag set, the method will also call <a href="#XYpair-Validate">Validate</a>() of all child<br> |
---|
1513 | windows. Returns false if any of the validations failed.</tt></dd></dl> |
---|
1514 | |
---|
1515 | <dl><dt><a name="XYpair-WarpPointer"><strong>WarpPointer</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-WarpPointer">WarpPointer</a>(self, int x, int y)<br> |
---|
1516 | <br> |
---|
1517 | Moves the pointer to the given position on the window.<br> |
---|
1518 | <br> |
---|
1519 | NOTE: This function is not supported under Mac because Apple Human<br> |
---|
1520 | Interface Guidelines forbid moving the mouse cursor programmatically.</tt></dd></dl> |
---|
1521 | |
---|
1522 | <hr> |
---|
1523 | Static methods inherited from <a href="wx._core.html#Window">wx._core.Window</a>:<br> |
---|
1524 | <dl><dt><a name="XYpair-FindFocus"><strong>FindFocus</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-FindFocus">FindFocus</a>() -> Window<br> |
---|
1525 | <br> |
---|
1526 | Returns the window or control that currently has the keyboard focus,<br> |
---|
1527 | or None.</tt></dd></dl> |
---|
1528 | |
---|
1529 | <dl><dt><a name="XYpair-GetCapture"><strong>GetCapture</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetCapture">GetCapture</a>() -> Window<br> |
---|
1530 | <br> |
---|
1531 | Returns the window which currently captures the mouse or None</tt></dd></dl> |
---|
1532 | |
---|
1533 | <dl><dt><a name="XYpair-NewControlId"><strong>NewControlId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-NewControlId">NewControlId</a>() -> int<br> |
---|
1534 | <br> |
---|
1535 | Generate a control id for the controls which were not given one.</tt></dd></dl> |
---|
1536 | |
---|
1537 | <dl><dt><a name="XYpair-NextControlId"><strong>NextControlId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-NextControlId">NextControlId</a>(int winid) -> int<br> |
---|
1538 | <br> |
---|
1539 | Get the id of the control following the one with the given<br> |
---|
1540 | autogenerated) id</tt></dd></dl> |
---|
1541 | |
---|
1542 | <dl><dt><a name="XYpair-PrevControlId"><strong>PrevControlId</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-PrevControlId">PrevControlId</a>(int winid) -> int<br> |
---|
1543 | <br> |
---|
1544 | Get the id of the control preceding the one with the given<br> |
---|
1545 | autogenerated) id</tt></dd></dl> |
---|
1546 | |
---|
1547 | <hr> |
---|
1548 | Data descriptors inherited from <a href="wx._core.html#Window">wx._core.Window</a>:<br> |
---|
1549 | <dl><dt><strong>AcceleratorTable</strong></dt> |
---|
1550 | <dd><tt>See `GetAcceleratorTable` and `SetAcceleratorTable`</tt></dd> |
---|
1551 | </dl> |
---|
1552 | <dl><dt><strong>AutoLayout</strong></dt> |
---|
1553 | <dd><tt>See `GetAutoLayout` and `SetAutoLayout`</tt></dd> |
---|
1554 | </dl> |
---|
1555 | <dl><dt><strong>BackgroundColour</strong></dt> |
---|
1556 | <dd><tt>See `GetBackgroundColour` and `SetBackgroundColour`</tt></dd> |
---|
1557 | </dl> |
---|
1558 | <dl><dt><strong>BackgroundStyle</strong></dt> |
---|
1559 | <dd><tt>See `GetBackgroundStyle` and `SetBackgroundStyle`</tt></dd> |
---|
1560 | </dl> |
---|
1561 | <dl><dt><strong>BestSize</strong></dt> |
---|
1562 | <dd><tt>See `GetBestSize`</tt></dd> |
---|
1563 | </dl> |
---|
1564 | <dl><dt><strong>BestVirtualSize</strong></dt> |
---|
1565 | <dd><tt>See `GetBestVirtualSize`</tt></dd> |
---|
1566 | </dl> |
---|
1567 | <dl><dt><strong>Border</strong></dt> |
---|
1568 | <dd><tt>See `GetBorder`</tt></dd> |
---|
1569 | </dl> |
---|
1570 | <dl><dt><strong>Caret</strong></dt> |
---|
1571 | <dd><tt>See `GetCaret` and `SetCaret`</tt></dd> |
---|
1572 | </dl> |
---|
1573 | <dl><dt><strong>CharHeight</strong></dt> |
---|
1574 | <dd><tt>See `GetCharHeight`</tt></dd> |
---|
1575 | </dl> |
---|
1576 | <dl><dt><strong>CharWidth</strong></dt> |
---|
1577 | <dd><tt>See `GetCharWidth`</tt></dd> |
---|
1578 | </dl> |
---|
1579 | <dl><dt><strong>Children</strong></dt> |
---|
1580 | <dd><tt>See `GetChildren`</tt></dd> |
---|
1581 | </dl> |
---|
1582 | <dl><dt><strong>ClientAreaOrigin</strong></dt> |
---|
1583 | <dd><tt>See `GetClientAreaOrigin`</tt></dd> |
---|
1584 | </dl> |
---|
1585 | <dl><dt><strong>ClientRect</strong></dt> |
---|
1586 | <dd><tt>See `GetClientRect` and `SetClientRect`</tt></dd> |
---|
1587 | </dl> |
---|
1588 | <dl><dt><strong>ClientSize</strong></dt> |
---|
1589 | <dd><tt>See `GetClientSize` and `SetClientSize`</tt></dd> |
---|
1590 | </dl> |
---|
1591 | <dl><dt><strong>Constraints</strong></dt> |
---|
1592 | <dd><tt>See `GetConstraints` and `SetConstraints`</tt></dd> |
---|
1593 | </dl> |
---|
1594 | <dl><dt><strong>ContainingSizer</strong></dt> |
---|
1595 | <dd><tt>See `GetContainingSizer` and `SetContainingSizer`</tt></dd> |
---|
1596 | </dl> |
---|
1597 | <dl><dt><strong>Cursor</strong></dt> |
---|
1598 | <dd><tt>See `GetCursor` and `SetCursor`</tt></dd> |
---|
1599 | </dl> |
---|
1600 | <dl><dt><strong>DefaultAttributes</strong></dt> |
---|
1601 | <dd><tt>See `GetDefaultAttributes`</tt></dd> |
---|
1602 | </dl> |
---|
1603 | <dl><dt><strong>DropTarget</strong></dt> |
---|
1604 | <dd><tt>See `GetDropTarget` and `SetDropTarget`</tt></dd> |
---|
1605 | </dl> |
---|
1606 | <dl><dt><strong>EffectiveMinSize</strong></dt> |
---|
1607 | <dd><tt>See `GetEffectiveMinSize`</tt></dd> |
---|
1608 | </dl> |
---|
1609 | <dl><dt><strong>Enabled</strong></dt> |
---|
1610 | <dd><tt>See `IsEnabled` and `Enable`</tt></dd> |
---|
1611 | </dl> |
---|
1612 | <dl><dt><strong>EventHandler</strong></dt> |
---|
1613 | <dd><tt>See `GetEventHandler` and `SetEventHandler`</tt></dd> |
---|
1614 | </dl> |
---|
1615 | <dl><dt><strong>ExtraStyle</strong></dt> |
---|
1616 | <dd><tt>See `GetExtraStyle` and `SetExtraStyle`</tt></dd> |
---|
1617 | </dl> |
---|
1618 | <dl><dt><strong>Font</strong></dt> |
---|
1619 | <dd><tt>See `GetFont` and `SetFont`</tt></dd> |
---|
1620 | </dl> |
---|
1621 | <dl><dt><strong>ForegroundColour</strong></dt> |
---|
1622 | <dd><tt>See `GetForegroundColour` and `SetForegroundColour`</tt></dd> |
---|
1623 | </dl> |
---|
1624 | <dl><dt><strong>GrandParent</strong></dt> |
---|
1625 | <dd><tt>See `GetGrandParent`</tt></dd> |
---|
1626 | </dl> |
---|
1627 | <dl><dt><strong>GtkWidget</strong></dt> |
---|
1628 | <dd><tt>GetGtkWidget(self) -> long<br> |
---|
1629 | <br> |
---|
1630 | On wxGTK returns a pointer to the GtkWidget for this window as a long<br> |
---|
1631 | integer. On the other platforms this method returns zero.</tt></dd> |
---|
1632 | </dl> |
---|
1633 | <dl><dt><strong>Handle</strong></dt> |
---|
1634 | <dd><tt>See `GetHandle`</tt></dd> |
---|
1635 | </dl> |
---|
1636 | <dl><dt><strong>HelpText</strong></dt> |
---|
1637 | <dd><tt>See `GetHelpText` and `SetHelpText`</tt></dd> |
---|
1638 | </dl> |
---|
1639 | <dl><dt><strong>Id</strong></dt> |
---|
1640 | <dd><tt>See `GetId` and `SetId`</tt></dd> |
---|
1641 | </dl> |
---|
1642 | <dl><dt><strong>Label</strong></dt> |
---|
1643 | <dd><tt>See `GetLabel` and `SetLabel`</tt></dd> |
---|
1644 | </dl> |
---|
1645 | <dl><dt><strong>LayoutDirection</strong></dt> |
---|
1646 | <dd><tt>See `GetLayoutDirection` and `SetLayoutDirection`</tt></dd> |
---|
1647 | </dl> |
---|
1648 | <dl><dt><strong>MaxHeight</strong></dt> |
---|
1649 | <dd><tt>See `GetMaxHeight`</tt></dd> |
---|
1650 | </dl> |
---|
1651 | <dl><dt><strong>MaxSize</strong></dt> |
---|
1652 | <dd><tt>See `GetMaxSize` and `SetMaxSize`</tt></dd> |
---|
1653 | </dl> |
---|
1654 | <dl><dt><strong>MaxWidth</strong></dt> |
---|
1655 | <dd><tt>See `GetMaxWidth`</tt></dd> |
---|
1656 | </dl> |
---|
1657 | <dl><dt><strong>MinHeight</strong></dt> |
---|
1658 | <dd><tt>See `GetMinHeight`</tt></dd> |
---|
1659 | </dl> |
---|
1660 | <dl><dt><strong>MinSize</strong></dt> |
---|
1661 | <dd><tt>See `GetMinSize` and `SetMinSize`</tt></dd> |
---|
1662 | </dl> |
---|
1663 | <dl><dt><strong>MinWidth</strong></dt> |
---|
1664 | <dd><tt>See `GetMinWidth`</tt></dd> |
---|
1665 | </dl> |
---|
1666 | <dl><dt><strong>Name</strong></dt> |
---|
1667 | <dd><tt>See `GetName` and `SetName`</tt></dd> |
---|
1668 | </dl> |
---|
1669 | <dl><dt><strong>Parent</strong></dt> |
---|
1670 | <dd><tt>See `GetParent`</tt></dd> |
---|
1671 | </dl> |
---|
1672 | <dl><dt><strong>Position</strong></dt> |
---|
1673 | <dd><tt>See `GetPosition` and `SetPosition`</tt></dd> |
---|
1674 | </dl> |
---|
1675 | <dl><dt><strong>Rect</strong></dt> |
---|
1676 | <dd><tt>See `GetRect` and `SetRect`</tt></dd> |
---|
1677 | </dl> |
---|
1678 | <dl><dt><strong>ScreenPosition</strong></dt> |
---|
1679 | <dd><tt>See `GetScreenPosition`</tt></dd> |
---|
1680 | </dl> |
---|
1681 | <dl><dt><strong>ScreenRect</strong></dt> |
---|
1682 | <dd><tt>See `GetScreenRect`</tt></dd> |
---|
1683 | </dl> |
---|
1684 | <dl><dt><strong>Shown</strong></dt> |
---|
1685 | <dd><tt>See `IsShown` and `Show`</tt></dd> |
---|
1686 | </dl> |
---|
1687 | <dl><dt><strong>Size</strong></dt> |
---|
1688 | <dd><tt>See `GetSize` and `SetSize`</tt></dd> |
---|
1689 | </dl> |
---|
1690 | <dl><dt><strong>Sizer</strong></dt> |
---|
1691 | <dd><tt>See `GetSizer` and `SetSizer`</tt></dd> |
---|
1692 | </dl> |
---|
1693 | <dl><dt><strong>ThemeEnabled</strong></dt> |
---|
1694 | <dd><tt>See `GetThemeEnabled` and `SetThemeEnabled`</tt></dd> |
---|
1695 | </dl> |
---|
1696 | <dl><dt><strong>ToolTip</strong></dt> |
---|
1697 | <dd><tt>See `GetToolTip` and `SetToolTip`</tt></dd> |
---|
1698 | </dl> |
---|
1699 | <dl><dt><strong>TopLevel</strong></dt> |
---|
1700 | <dd><tt>See `IsTopLevel`</tt></dd> |
---|
1701 | </dl> |
---|
1702 | <dl><dt><strong>TopLevelParent</strong></dt> |
---|
1703 | <dd><tt>See `GetTopLevelParent`</tt></dd> |
---|
1704 | </dl> |
---|
1705 | <dl><dt><strong>UpdateClientRect</strong></dt> |
---|
1706 | <dd><tt>See `GetUpdateClientRect`</tt></dd> |
---|
1707 | </dl> |
---|
1708 | <dl><dt><strong>UpdateRegion</strong></dt> |
---|
1709 | <dd><tt>See `GetUpdateRegion`</tt></dd> |
---|
1710 | </dl> |
---|
1711 | <dl><dt><strong>Validator</strong></dt> |
---|
1712 | <dd><tt>See `GetValidator` and `SetValidator`</tt></dd> |
---|
1713 | </dl> |
---|
1714 | <dl><dt><strong>VirtualSize</strong></dt> |
---|
1715 | <dd><tt>See `GetVirtualSize` and `SetVirtualSize`</tt></dd> |
---|
1716 | </dl> |
---|
1717 | <dl><dt><strong>WindowStyle</strong></dt> |
---|
1718 | <dd><tt>See `GetWindowStyle` and `SetWindowStyle`</tt></dd> |
---|
1719 | </dl> |
---|
1720 | <dl><dt><strong>WindowStyleFlag</strong></dt> |
---|
1721 | <dd><tt>See `GetWindowStyleFlag` and `SetWindowStyleFlag`</tt></dd> |
---|
1722 | </dl> |
---|
1723 | <dl><dt><strong>WindowVariant</strong></dt> |
---|
1724 | <dd><tt>See `GetWindowVariant` and `SetWindowVariant`</tt></dd> |
---|
1725 | </dl> |
---|
1726 | <hr> |
---|
1727 | Methods inherited from <a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a>:<br> |
---|
1728 | <dl><dt><a name="XYpair-AddPendingEvent"><strong>AddPendingEvent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-AddPendingEvent">AddPendingEvent</a>(self, Event event)</tt></dd></dl> |
---|
1729 | |
---|
1730 | <dl><dt><a name="XYpair-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> |
---|
1731 | <br> |
---|
1732 | :param event: One of the EVT_* objects that specifies the<br> |
---|
1733 | type of event to bind,<br> |
---|
1734 | <br> |
---|
1735 | :param handler: A callable object to be invoked when the<br> |
---|
1736 | event is delivered to self. Pass None to<br> |
---|
1737 | disconnect an event handler.<br> |
---|
1738 | <br> |
---|
1739 | :param source: Sometimes the event originates from a<br> |
---|
1740 | different window than self, but you still<br> |
---|
1741 | want to catch it in self. (For example, a<br> |
---|
1742 | button event delivered to a frame.) By<br> |
---|
1743 | passing the source of the event, the event<br> |
---|
1744 | handling system is able to differentiate<br> |
---|
1745 | between the same event type from different<br> |
---|
1746 | controls.<br> |
---|
1747 | <br> |
---|
1748 | :param id: Used to spcify the event source by ID instead<br> |
---|
1749 | of instance.<br> |
---|
1750 | <br> |
---|
1751 | :param id2: Used when it is desirable to bind a handler<br> |
---|
1752 | to a range of IDs, such as with EVT_MENU_RANGE.</tt></dd></dl> |
---|
1753 | |
---|
1754 | <dl><dt><a name="XYpair-Connect"><strong>Connect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Connect">Connect</a>(self, int id, int lastId, int eventType, PyObject func)</tt></dd></dl> |
---|
1755 | |
---|
1756 | <dl><dt><a name="XYpair-Disconnect"><strong>Disconnect</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-Disconnect">Disconnect</a>(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool</tt></dd></dl> |
---|
1757 | |
---|
1758 | <dl><dt><a name="XYpair-GetEvtHandlerEnabled"><strong>GetEvtHandlerEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetEvtHandlerEnabled">GetEvtHandlerEnabled</a>(self) -> bool</tt></dd></dl> |
---|
1759 | |
---|
1760 | <dl><dt><a name="XYpair-GetNextHandler"><strong>GetNextHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetNextHandler">GetNextHandler</a>(self) -> EvtHandler</tt></dd></dl> |
---|
1761 | |
---|
1762 | <dl><dt><a name="XYpair-GetPreviousHandler"><strong>GetPreviousHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetPreviousHandler">GetPreviousHandler</a>(self) -> EvtHandler</tt></dd></dl> |
---|
1763 | |
---|
1764 | <dl><dt><a name="XYpair-ProcessEvent"><strong>ProcessEvent</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ProcessEvent">ProcessEvent</a>(self, Event event) -> bool</tt></dd></dl> |
---|
1765 | |
---|
1766 | <dl><dt><a name="XYpair-ProcessPendingEvents"><strong>ProcessPendingEvents</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-ProcessPendingEvents">ProcessPendingEvents</a>(self)</tt></dd></dl> |
---|
1767 | |
---|
1768 | <dl><dt><a name="XYpair-SetEvtHandlerEnabled"><strong>SetEvtHandlerEnabled</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetEvtHandlerEnabled">SetEvtHandlerEnabled</a>(self, bool enabled)</tt></dd></dl> |
---|
1769 | |
---|
1770 | <dl><dt><a name="XYpair-SetNextHandler"><strong>SetNextHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetNextHandler">SetNextHandler</a>(self, EvtHandler handler)</tt></dd></dl> |
---|
1771 | |
---|
1772 | <dl><dt><a name="XYpair-SetPreviousHandler"><strong>SetPreviousHandler</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-SetPreviousHandler">SetPreviousHandler</a>(self, EvtHandler handler)</tt></dd></dl> |
---|
1773 | |
---|
1774 | <dl><dt><a name="XYpair-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> |
---|
1775 | Returns True if successful.</tt></dd></dl> |
---|
1776 | |
---|
1777 | <hr> |
---|
1778 | Data descriptors inherited from <a href="wx._core.html#EvtHandler">wx._core.EvtHandler</a>:<br> |
---|
1779 | <dl><dt><strong>EvtHandlerEnabled</strong></dt> |
---|
1780 | <dd><tt>See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`</tt></dd> |
---|
1781 | </dl> |
---|
1782 | <dl><dt><strong>NextHandler</strong></dt> |
---|
1783 | <dd><tt>See `GetNextHandler` and `SetNextHandler`</tt></dd> |
---|
1784 | </dl> |
---|
1785 | <dl><dt><strong>PreviousHandler</strong></dt> |
---|
1786 | <dd><tt>See `GetPreviousHandler` and `SetPreviousHandler`</tt></dd> |
---|
1787 | </dl> |
---|
1788 | <hr> |
---|
1789 | Methods inherited from <a href="wx._core.html#Object">wx._core.Object</a>:<br> |
---|
1790 | <dl><dt><a name="XYpair-GetClassName"><strong>GetClassName</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-GetClassName">GetClassName</a>(self) -> String<br> |
---|
1791 | <br> |
---|
1792 | Returns the class name of the C++ class using wxRTTI.</tt></dd></dl> |
---|
1793 | |
---|
1794 | <dl><dt><a name="XYpair-IsSameAs"><strong>IsSameAs</strong></a>(*args, **kwargs)</dt><dd><tt><a href="#XYpair-IsSameAs">IsSameAs</a>(self, Object p) -> bool<br> |
---|
1795 | <br> |
---|
1796 | For wx.Objects that use C++ reference counting internally, this method<br> |
---|
1797 | can be used to determine if two objects are referencing the same data<br> |
---|
1798 | object.</tt></dd></dl> |
---|
1799 | |
---|
1800 | <hr> |
---|
1801 | Data descriptors inherited from <a href="wx._core.html#Object">wx._core.Object</a>:<br> |
---|
1802 | <dl><dt><strong>ClassName</strong></dt> |
---|
1803 | <dd><tt>See `GetClassName`</tt></dd> |
---|
1804 | </dl> |
---|
1805 | <dl><dt><strong>__dict__</strong></dt> |
---|
1806 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
---|
1807 | </dl> |
---|
1808 | <dl><dt><strong>__weakref__</strong></dt> |
---|
1809 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
---|
1810 | </dl> |
---|
1811 | </td></tr></table></td></tr></table><p> |
---|
1812 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
---|
1813 | <tr bgcolor="#55aa55"> |
---|
1814 | <td colspan=3 valign=bottom> <br> |
---|
1815 | <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
---|
1816 | |
---|
1817 | <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
---|
1818 | <td width="100%"><strong>wxID_XYPAIR</strong> = 113<br> |
---|
1819 | <strong>wxID_XYPAIRLBLMOTOR</strong> = 114<br> |
---|
1820 | <strong>wxID_XYPAIRLBLREADBACK</strong> = 115<br> |
---|
1821 | <strong>wxID_XYPAIRLBLTARGET</strong> = 116<br> |
---|
1822 | <strong>wxID_XYPAIRLBL_X_TITLE</strong> = 117<br> |
---|
1823 | <strong>wxID_XYPAIRLBL_Y_TITLE</strong> = 118<br> |
---|
1824 | <strong>wxID_XYPAIRSTOP</strong> = 119<br> |
---|
1825 | <strong>wxID_XYPAIRTABLE</strong> = 120<br> |
---|
1826 | <strong>wxID_XYPAIRTITLE</strong> = 121<br> |
---|
1827 | <strong>wxID_XYPAIRX_RBV</strong> = 122<br> |
---|
1828 | <strong>wxID_XYPAIRX_VAL</strong> = 123<br> |
---|
1829 | <strong>wxID_XYPAIRY_RBV</strong> = 124<br> |
---|
1830 | <strong>wxID_XYPAIRY_VAL</strong> = 125</td></tr></table> |
---|
1831 | </body></html> |
---|