source: sasview/sansguiframe/docs/sphinx/html/api/aboutbox.html @ 96cbb53

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 211.1 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>aboutbox &mdash; guiframe v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="guiframe v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="config" href="config.html" />
28    <link rel="prev" title="Reference" href="index.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="config.html" title="config"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="index.html" title="Reference"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="aboutbox">
57<h1>aboutbox<a class="headerlink" href="#aboutbox" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.aboutbox">
59<span id="sans-guiframe-aboutbox"></span><h2><a class="reference internal" href="#module-sans.guiframe.aboutbox" title="sans.guiframe.aboutbox"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.aboutbox</span></tt></a><a class="headerlink" href="#module-sans.guiframe.aboutbox" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.guiframe.aboutbox.DialogAbout">
62<em class="property">class </em><tt class="descclassname">sans.guiframe.aboutbox.</tt><tt class="descname">DialogAbout</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
64<p>&#8220;About&#8221; Dialog</p>
65<p>Shows product name, current version, authors, and link to the product page.
66Current version is taken from version.py</p>
67<dl class="attribute">
68<dt id="sans.guiframe.aboutbox.DialogAbout.AcceleratorTable">
69<tt class="descname">AcceleratorTable</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AcceleratorTable" title="Permalink to this definition">¶</a></dt>
70<dd><p>See <cite>GetAcceleratorTable</cite> and <cite>SetAcceleratorTable</cite></p>
71</dd></dl>
72
73<dl class="method">
74<dt id="sans.guiframe.aboutbox.DialogAbout.AcceptsFocus">
75<tt class="descname">AcceptsFocus</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AcceptsFocus" title="Permalink to this definition">¶</a></dt>
76<dd><p>AcceptsFocus(self) -&gt; bool</p>
77<p>Can this window have focus?</p>
78</dd></dl>
79
80<dl class="method">
81<dt id="sans.guiframe.aboutbox.DialogAbout.AcceptsFocusFromKeyboard">
82<tt class="descname">AcceptsFocusFromKeyboard</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AcceptsFocusFromKeyboard" title="Permalink to this definition">¶</a></dt>
83<dd><p>AcceptsFocusFromKeyboard(self) -&gt; bool</p>
84<p>Can this window be given focus by keyboard navigation? if not, the
85only way to give it focus (provided it accepts it at all) is to click
86it.</p>
87</dd></dl>
88
89<dl class="method">
90<dt id="sans.guiframe.aboutbox.DialogAbout.AddChild">
91<tt class="descname">AddChild</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AddChild" title="Permalink to this definition">¶</a></dt>
92<dd><p>AddChild(self, Window child)</p>
93<p>Adds a child window. This is called automatically by window creation
94functions so should not be required by the application programmer.</p>
95</dd></dl>
96
97<dl class="method">
98<dt id="sans.guiframe.aboutbox.DialogAbout.AddPendingEvent">
99<tt class="descname">AddPendingEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AddPendingEvent" title="Permalink to this definition">¶</a></dt>
100<dd><p>AddPendingEvent(self, Event event)</p>
101</dd></dl>
102
103<dl class="method">
104<dt id="sans.guiframe.aboutbox.DialogAbout.AdjustForLayoutDirection">
105<tt class="descname">AdjustForLayoutDirection</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AdjustForLayoutDirection" title="Permalink to this definition">¶</a></dt>
106<dd><p>AdjustForLayoutDirection(self, int x, int width, int widthTotal) -&gt; int</p>
107<p>Mirror coordinates for RTL layout if this window uses it and if the
108mirroring is not done automatically like Win32.</p>
109</dd></dl>
110
111<dl class="attribute">
112<dt id="sans.guiframe.aboutbox.DialogAbout.AffirmativeId">
113<tt class="descname">AffirmativeId</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AffirmativeId" title="Permalink to this definition">¶</a></dt>
114<dd><p>See <cite>GetAffirmativeId</cite> and <cite>SetAffirmativeId</cite></p>
115</dd></dl>
116
117<dl class="method">
118<dt id="sans.guiframe.aboutbox.DialogAbout.AssociateHandle">
119<tt class="descname">AssociateHandle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AssociateHandle" title="Permalink to this definition">¶</a></dt>
120<dd><p>AssociateHandle(self, long handle)</p>
121<p>Associate the window with a new native handle</p>
122</dd></dl>
123
124<dl class="attribute">
125<dt id="sans.guiframe.aboutbox.DialogAbout.AutoLayout">
126<tt class="descname">AutoLayout</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.AutoLayout" title="Permalink to this definition">¶</a></dt>
127<dd><p>See <cite>GetAutoLayout</cite> and <cite>SetAutoLayout</cite></p>
128</dd></dl>
129
130<dl class="attribute">
131<dt id="sans.guiframe.aboutbox.DialogAbout.BackgroundColour">
132<tt class="descname">BackgroundColour</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.BackgroundColour" title="Permalink to this definition">¶</a></dt>
133<dd><p>See <cite>GetBackgroundColour</cite> and <cite>SetBackgroundColour</cite></p>
134</dd></dl>
135
136<dl class="attribute">
137<dt id="sans.guiframe.aboutbox.DialogAbout.BackgroundStyle">
138<tt class="descname">BackgroundStyle</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.BackgroundStyle" title="Permalink to this definition">¶</a></dt>
139<dd><p>See <cite>GetBackgroundStyle</cite> and <cite>SetBackgroundStyle</cite></p>
140</dd></dl>
141
142<dl class="attribute">
143<dt id="sans.guiframe.aboutbox.DialogAbout.BestSize">
144<tt class="descname">BestSize</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.BestSize" title="Permalink to this definition">¶</a></dt>
145<dd><p>See <cite>GetBestSize</cite></p>
146</dd></dl>
147
148<dl class="attribute">
149<dt id="sans.guiframe.aboutbox.DialogAbout.BestVirtualSize">
150<tt class="descname">BestVirtualSize</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.BestVirtualSize" title="Permalink to this definition">¶</a></dt>
151<dd><p>See <cite>GetBestVirtualSize</cite></p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.guiframe.aboutbox.DialogAbout.Bind">
156<tt class="descname">Bind</tt><big>(</big><em>event</em>, <em>handler</em>, <em>source=None</em>, <em>id=-1</em>, <em>id2=-1</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Bind" title="Permalink to this definition">¶</a></dt>
157<dd><p>Bind an event to an event handler.</p>
158<table class="docutils field-list" frame="void" rules="none">
159<col class="field-name" />
160<col class="field-body" />
161<tbody valign="top">
162<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
163<li><strong>event</strong> &#8211; One of the EVT_* objects that specifies the
164type of event to bind,</li>
165<li><strong>handler</strong> &#8211; A callable object to be invoked when the
166event is delivered to self.  Pass None to
167disconnect an event handler.</li>
168<li><strong>source</strong> &#8211; Sometimes the event originates from a
169different window than self, but you still
170want to catch it in self.  (For example, a
171button event delivered to a frame.)  By
172passing the source of the event, the event
173handling system is able to differentiate
174between the same event type from different
175controls.</li>
176<li><strong>id</strong> &#8211; Used to spcify the event source by ID instead
177of instance.</li>
178<li><strong>id2</strong> &#8211; Used when it is desirable to bind a handler
179to a range of IDs, such as with EVT_MENU_RANGE.</li>
180</ul>
181</td>
182</tr>
183</tbody>
184</table>
185</dd></dl>
186
187<dl class="attribute">
188<dt id="sans.guiframe.aboutbox.DialogAbout.Border">
189<tt class="descname">Border</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Border" title="Permalink to this definition">¶</a></dt>
190<dd><p>See <cite>GetBorder</cite></p>
191</dd></dl>
192
193<dl class="method">
194<dt id="sans.guiframe.aboutbox.DialogAbout.CacheBestSize">
195<tt class="descname">CacheBestSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CacheBestSize" title="Permalink to this definition">¶</a></dt>
196<dd><p>CacheBestSize(self, Size size)</p>
197<p>Cache the best size so it doesn&#8217;t need to be calculated again, (at least until
198some properties of the window change.)</p>
199</dd></dl>
200
201<dl class="method">
202<dt id="sans.guiframe.aboutbox.DialogAbout.CanSetTransparent">
203<tt class="descname">CanSetTransparent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CanSetTransparent" title="Permalink to this definition">¶</a></dt>
204<dd><p>CanSetTransparent(self) -&gt; bool</p>
205<p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the platform supports setting the transparency for
206this window.  Note that this method will err on the side of caution,
207so it is possible that this will return <tt class="xref docutils literal"><span class="pre">False</span></tt> when it is in fact
208possible to set the transparency.</p>
209<p>NOTE: On X-windows systems the X server must have the composite
210extension loaded, and there must be a composite manager program (such
211as xcompmgr) running.</p>
212</dd></dl>
213
214<dl class="method">
215<dt id="sans.guiframe.aboutbox.DialogAbout.CaptureMouse">
216<tt class="descname">CaptureMouse</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CaptureMouse" title="Permalink to this definition">¶</a></dt>
217<dd><p>CaptureMouse(self)</p>
218<p>Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
219release the capture.</p>
220<p>Note that wxWindows maintains the stack of windows having captured the
221mouse and when the mouse is released the capture returns to the window
222which had had captured it previously and it is only really released if
223there were no previous window. In particular, this means that you must
224release the mouse as many times as you capture it, unless the window
225receives the <cite>wx.MouseCaptureLostEvent</cite> event.</p>
226<p>Any application which captures the mouse in the beginning of some
227operation <em>must</em> handle <cite>wx.MouseCaptureLostEvent</cite> and cancel this
228operation when it receives the event. The event handler must not
229recapture mouse.</p>
230</dd></dl>
231
232<dl class="attribute">
233<dt id="sans.guiframe.aboutbox.DialogAbout.Caret">
234<tt class="descname">Caret</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Caret" title="Permalink to this definition">¶</a></dt>
235<dd><p>See <cite>GetCaret</cite> and <cite>SetCaret</cite></p>
236</dd></dl>
237
238<dl class="method">
239<dt id="sans.guiframe.aboutbox.DialogAbout.Center">
240<tt class="descname">Center</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Center" title="Permalink to this definition">¶</a></dt>
241<dd><p>Center(self, int direction=BOTH)</p>
242<p>Centers the window.  The parameter specifies the direction for
243centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
244also include wx.CENTER_ON_SCREEN flag if you want to center the window
245on the entire screen and not on its parent window.  If it is a
246top-level window and has no parent then it will always be centered
247relative to the screen.</p>
248</dd></dl>
249
250<dl class="method">
251<dt id="sans.guiframe.aboutbox.DialogAbout.CenterOnParent">
252<tt class="descname">CenterOnParent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CenterOnParent" title="Permalink to this definition">¶</a></dt>
253<dd><p>CenterOnParent(self, int dir=BOTH)</p>
254<p>Center with respect to the the parent window</p>
255</dd></dl>
256
257<dl class="method">
258<dt id="sans.guiframe.aboutbox.DialogAbout.CenterOnScreen">
259<tt class="descname">CenterOnScreen</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CenterOnScreen" title="Permalink to this definition">¶</a></dt>
260<dd><p>CenterOnScreen(self, int dir=BOTH)</p>
261<p>Center the window on screen</p>
262</dd></dl>
263
264<dl class="method">
265<dt id="sans.guiframe.aboutbox.DialogAbout.Centre">
266<tt class="descname">Centre</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Centre" title="Permalink to this definition">¶</a></dt>
267<dd><p>Center(self, int direction=BOTH)</p>
268<p>Centers the window.  The parameter specifies the direction for
269centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
270also include wx.CENTER_ON_SCREEN flag if you want to center the window
271on the entire screen and not on its parent window.  If it is a
272top-level window and has no parent then it will always be centered
273relative to the screen.</p>
274</dd></dl>
275
276<dl class="method">
277<dt id="sans.guiframe.aboutbox.DialogAbout.CentreOnParent">
278<tt class="descname">CentreOnParent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CentreOnParent" title="Permalink to this definition">¶</a></dt>
279<dd><p>CenterOnParent(self, int dir=BOTH)</p>
280<p>Center with respect to the the parent window</p>
281</dd></dl>
282
283<dl class="method">
284<dt id="sans.guiframe.aboutbox.DialogAbout.CentreOnScreen">
285<tt class="descname">CentreOnScreen</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CentreOnScreen" title="Permalink to this definition">¶</a></dt>
286<dd><p>CenterOnScreen(self, int dir=BOTH)</p>
287<p>Center the window on screen</p>
288</dd></dl>
289
290<dl class="attribute">
291<dt id="sans.guiframe.aboutbox.DialogAbout.CharHeight">
292<tt class="descname">CharHeight</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CharHeight" title="Permalink to this definition">¶</a></dt>
293<dd><p>See <cite>GetCharHeight</cite></p>
294</dd></dl>
295
296<dl class="attribute">
297<dt id="sans.guiframe.aboutbox.DialogAbout.CharWidth">
298<tt class="descname">CharWidth</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CharWidth" title="Permalink to this definition">¶</a></dt>
299<dd><p>See <cite>GetCharWidth</cite></p>
300</dd></dl>
301
302<dl class="attribute">
303<dt id="sans.guiframe.aboutbox.DialogAbout.Children">
304<tt class="descname">Children</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Children" title="Permalink to this definition">¶</a></dt>
305<dd><p>See <cite>GetChildren</cite></p>
306</dd></dl>
307
308<dl class="attribute">
309<dt id="sans.guiframe.aboutbox.DialogAbout.ClassName">
310<tt class="descname">ClassName</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ClassName" title="Permalink to this definition">¶</a></dt>
311<dd><p>See <cite>GetClassName</cite></p>
312</dd></dl>
313
314<dl class="method">
315<dt id="sans.guiframe.aboutbox.DialogAbout.ClearBackground">
316<tt class="descname">ClearBackground</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ClearBackground" title="Permalink to this definition">¶</a></dt>
317<dd><p>ClearBackground(self)</p>
318<p>Clears the window by filling it with the current background
319colour. Does not cause an erase background event to be generated.</p>
320</dd></dl>
321
322<dl class="attribute">
323<dt id="sans.guiframe.aboutbox.DialogAbout.ClientAreaOrigin">
324<tt class="descname">ClientAreaOrigin</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ClientAreaOrigin" title="Permalink to this definition">¶</a></dt>
325<dd><p>See <cite>GetClientAreaOrigin</cite></p>
326</dd></dl>
327
328<dl class="attribute">
329<dt id="sans.guiframe.aboutbox.DialogAbout.ClientRect">
330<tt class="descname">ClientRect</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ClientRect" title="Permalink to this definition">¶</a></dt>
331<dd><p>See <cite>GetClientRect</cite> and <cite>SetClientRect</cite></p>
332</dd></dl>
333
334<dl class="attribute">
335<dt id="sans.guiframe.aboutbox.DialogAbout.ClientSize">
336<tt class="descname">ClientSize</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ClientSize" title="Permalink to this definition">¶</a></dt>
337<dd><p>See <cite>GetClientSize</cite> and <cite>SetClientSize</cite></p>
338</dd></dl>
339
340<dl class="method">
341<dt id="sans.guiframe.aboutbox.DialogAbout.ClientToScreen">
342<tt class="descname">ClientToScreen</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ClientToScreen" title="Permalink to this definition">¶</a></dt>
343<dd><p>ClientToScreen(self, Point pt) -&gt; Point</p>
344<p>Converts to screen coordinates from coordinates relative to this window.</p>
345</dd></dl>
346
347<dl class="method">
348<dt id="sans.guiframe.aboutbox.DialogAbout.ClientToScreenXY">
349<tt class="descname">ClientToScreenXY</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ClientToScreenXY" title="Permalink to this definition">¶</a></dt>
350<dd><p>ClientToScreenXY(int x, int y) -&gt; (x,y)</p>
351<p>Converts to screen coordinates from coordinates relative to this window.</p>
352</dd></dl>
353
354<dl class="method">
355<dt id="sans.guiframe.aboutbox.DialogAbout.ClientToWindowSize">
356<tt class="descname">ClientToWindowSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ClientToWindowSize" title="Permalink to this definition">¶</a></dt>
357<dd><p>ClientToWindowSize(self, Size size) -&gt; Size</p>
358</dd></dl>
359
360<dl class="method">
361<dt id="sans.guiframe.aboutbox.DialogAbout.Close">
362<tt class="descname">Close</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Close" title="Permalink to this definition">¶</a></dt>
363<dd><p>Close(self, bool force=False) -&gt; bool</p>
364<p>This function simply generates a EVT_CLOSE event whose handler usually
365tries to close the window. It doesn&#8217;t close the window itself,
366however.  If force is False (the default) then the window&#8217;s close
367handler will be allowed to veto the destruction of the window.</p>
368</dd></dl>
369
370<dl class="method">
371<dt id="sans.guiframe.aboutbox.DialogAbout.Connect">
372<tt class="descname">Connect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Connect" title="Permalink to this definition">¶</a></dt>
373<dd><p>Connect(self, int id, int lastId, int eventType, PyObject func)</p>
374</dd></dl>
375
376<dl class="attribute">
377<dt id="sans.guiframe.aboutbox.DialogAbout.Constraints">
378<tt class="descname">Constraints</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Constraints" title="Permalink to this definition">¶</a></dt>
379<dd><p>See <cite>GetConstraints</cite> and <cite>SetConstraints</cite></p>
380</dd></dl>
381
382<dl class="attribute">
383<dt id="sans.guiframe.aboutbox.DialogAbout.ContainingSizer">
384<tt class="descname">ContainingSizer</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ContainingSizer" title="Permalink to this definition">¶</a></dt>
385<dd><p>See <cite>GetContainingSizer</cite> and <cite>SetContainingSizer</cite></p>
386</dd></dl>
387
388<dl class="method">
389<dt id="sans.guiframe.aboutbox.DialogAbout.ConvertDialogPointToPixels">
390<tt class="descname">ConvertDialogPointToPixels</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ConvertDialogPointToPixels" title="Permalink to this definition">¶</a></dt>
391<dd><p>ConvertDialogPointToPixels(self, Point pt) -&gt; Point</p>
392<p>Converts a point or size from dialog units to pixels.  Dialog units
393are used for maintaining a dialog&#8217;s proportions even if the font
394changes. For the x dimension, the dialog units are multiplied by the
395average character width and then divided by 4. For the y dimension,
396the dialog units are multiplied by the average character height and
397then divided by 8.</p>
398</dd></dl>
399
400<dl class="method">
401<dt id="sans.guiframe.aboutbox.DialogAbout.ConvertDialogSizeToPixels">
402<tt class="descname">ConvertDialogSizeToPixels</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ConvertDialogSizeToPixels" title="Permalink to this definition">¶</a></dt>
403<dd><p>ConvertDialogSizeToPixels(self, Size sz) -&gt; Size</p>
404<p>Converts a point or size from dialog units to pixels.  Dialog units
405are used for maintaining a dialog&#8217;s proportions even if the font
406changes. For the x dimension, the dialog units are multiplied by the
407average character width and then divided by 4. For the y dimension,
408the dialog units are multiplied by the average character height and
409then divided by 8.</p>
410</dd></dl>
411
412<dl class="method">
413<dt id="sans.guiframe.aboutbox.DialogAbout.ConvertPixelPointToDialog">
414<tt class="descname">ConvertPixelPointToDialog</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ConvertPixelPointToDialog" title="Permalink to this definition">¶</a></dt>
415<dd><p>ConvertPixelPointToDialog(self, Point pt) -&gt; Point</p>
416</dd></dl>
417
418<dl class="method">
419<dt id="sans.guiframe.aboutbox.DialogAbout.ConvertPixelSizeToDialog">
420<tt class="descname">ConvertPixelSizeToDialog</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ConvertPixelSizeToDialog" title="Permalink to this definition">¶</a></dt>
421<dd><p>ConvertPixelSizeToDialog(self, Size sz) -&gt; Size</p>
422</dd></dl>
423
424<dl class="method">
425<dt id="sans.guiframe.aboutbox.DialogAbout.Create">
426<tt class="descname">Create</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Create" title="Permalink to this definition">¶</a></dt>
427<dd><dl class="docutils">
428<dt>Create(self, Window parent, int id=-1, String title=EmptyString, </dt>
429<dd>Point pos=DefaultPosition, Size size=DefaultSize,
430long style=DEFAULT_DIALOG_STYLE, String name=DialogNameStr) -&gt; bool</dd>
431</dl>
432</dd></dl>
433
434<dl class="method">
435<dt id="sans.guiframe.aboutbox.DialogAbout.CreateButtonSizer">
436<tt class="descname">CreateButtonSizer</tt><big>(</big><em>flags</em>, <em>*ignored</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CreateButtonSizer" title="Permalink to this definition">¶</a></dt>
437<dd></dd></dl>
438
439<dl class="method">
440<dt id="sans.guiframe.aboutbox.DialogAbout.CreateSeparatedButtonSizer">
441<tt class="descname">CreateSeparatedButtonSizer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CreateSeparatedButtonSizer" title="Permalink to this definition">¶</a></dt>
442<dd><p>CreateSeparatedButtonSizer(self, long flags) -&gt; Sizer</p>
443</dd></dl>
444
445<dl class="method">
446<dt id="sans.guiframe.aboutbox.DialogAbout.CreateStdDialogButtonSizer">
447<tt class="descname">CreateStdDialogButtonSizer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CreateStdDialogButtonSizer" title="Permalink to this definition">¶</a></dt>
448<dd><p>CreateStdDialogButtonSizer(self, long flags) -&gt; StdDialogButtonSizer</p>
449</dd></dl>
450
451<dl class="method">
452<dt id="sans.guiframe.aboutbox.DialogAbout.CreateTextSizer">
453<tt class="descname">CreateTextSizer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.CreateTextSizer" title="Permalink to this definition">¶</a></dt>
454<dd><p>CreateTextSizer(self, String message) -&gt; Sizer</p>
455</dd></dl>
456
457<dl class="attribute">
458<dt id="sans.guiframe.aboutbox.DialogAbout.Cursor">
459<tt class="descname">Cursor</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Cursor" title="Permalink to this definition">¶</a></dt>
460<dd><p>See <cite>GetCursor</cite> and <cite>SetCursor</cite></p>
461</dd></dl>
462
463<dl class="method">
464<dt id="sans.guiframe.aboutbox.DialogAbout.DLG_PNT">
465<tt class="descname">DLG_PNT</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.DLG_PNT" title="Permalink to this definition">¶</a></dt>
466<dd><p>DLG_PNT(self, Point pt) -&gt; Point</p>
467<p>Converts a point or size from dialog units to pixels.  Dialog units
468are used for maintaining a dialog&#8217;s proportions even if the font
469changes. For the x dimension, the dialog units are multiplied by the
470average character width and then divided by 4. For the y dimension,
471the dialog units are multiplied by the average character height and
472then divided by 8.</p>
473</dd></dl>
474
475<dl class="method">
476<dt id="sans.guiframe.aboutbox.DialogAbout.DLG_SZE">
477<tt class="descname">DLG_SZE</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.DLG_SZE" title="Permalink to this definition">¶</a></dt>
478<dd><p>DLG_SZE(self, Size sz) -&gt; Size</p>
479<p>Converts a point or size from dialog units to pixels.  Dialog units
480are used for maintaining a dialog&#8217;s proportions even if the font
481changes. For the x dimension, the dialog units are multiplied by the
482average character width and then divided by 4. For the y dimension,
483the dialog units are multiplied by the average character height and
484then divided by 8.</p>
485</dd></dl>
486
487<dl class="attribute">
488<dt id="sans.guiframe.aboutbox.DialogAbout.DefaultAttributes">
489<tt class="descname">DefaultAttributes</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.DefaultAttributes" title="Permalink to this definition">¶</a></dt>
490<dd><p>See <cite>GetDefaultAttributes</cite></p>
491</dd></dl>
492
493<dl class="attribute">
494<dt id="sans.guiframe.aboutbox.DialogAbout.DefaultItem">
495<tt class="descname">DefaultItem</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.DefaultItem" title="Permalink to this definition">¶</a></dt>
496<dd><p>See <cite>GetDefaultItem</cite> and <cite>SetDefaultItem</cite></p>
497</dd></dl>
498
499<dl class="method">
500<dt id="sans.guiframe.aboutbox.DialogAbout.Destroy">
501<tt class="descname">Destroy</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Destroy" title="Permalink to this definition">¶</a></dt>
502<dd><p>Destroy(self) -&gt; bool</p>
503<p>Destroys the window safely.  Frames and dialogs are not destroyed
504immediately when this function is called &#8211; they are added to a list
505of windows to be deleted on idle time, when all the window&#8217;s events
506have been processed. This prevents problems with events being sent to
507non-existent windows.</p>
508<p>Returns True if the window has either been successfully deleted, or it
509has been added to the list of windows pending real deletion.</p>
510</dd></dl>
511
512<dl class="method">
513<dt id="sans.guiframe.aboutbox.DialogAbout.DestroyChildren">
514<tt class="descname">DestroyChildren</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.DestroyChildren" title="Permalink to this definition">¶</a></dt>
515<dd><p>DestroyChildren(self) -&gt; bool</p>
516<p>Destroys all children of a window. Called automatically by the
517destructor.</p>
518</dd></dl>
519
520<dl class="method">
521<dt id="sans.guiframe.aboutbox.DialogAbout.Disable">
522<tt class="descname">Disable</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Disable" title="Permalink to this definition">¶</a></dt>
523<dd><p>Disable(self) -&gt; bool</p>
524<p>Disables the window, same as Enable(false).</p>
525</dd></dl>
526
527<dl class="method">
528<dt id="sans.guiframe.aboutbox.DialogAbout.Disconnect">
529<tt class="descname">Disconnect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Disconnect" title="Permalink to this definition">¶</a></dt>
530<dd><dl class="docutils">
531<dt>Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, </dt>
532<dd>PyObject func=None) -&gt; bool</dd>
533</dl>
534</dd></dl>
535
536<dl class="method">
537<dt id="sans.guiframe.aboutbox.DialogAbout.DissociateHandle">
538<tt class="descname">DissociateHandle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.DissociateHandle" title="Permalink to this definition">¶</a></dt>
539<dd><p>DissociateHandle(self)</p>
540<p>Dissociate the current native handle from the window</p>
541</dd></dl>
542
543<dl class="method">
544<dt id="sans.guiframe.aboutbox.DialogAbout.DragAcceptFiles">
545<tt class="descname">DragAcceptFiles</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.DragAcceptFiles" title="Permalink to this definition">¶</a></dt>
546<dd><p>DragAcceptFiles(self, bool accept)</p>
547<p>Enables or disables eligibility for drop file events, EVT_DROP_FILES.</p>
548</dd></dl>
549
550<dl class="attribute">
551<dt id="sans.guiframe.aboutbox.DialogAbout.DropTarget">
552<tt class="descname">DropTarget</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.DropTarget" title="Permalink to this definition">¶</a></dt>
553<dd><p>See <cite>GetDropTarget</cite> and <cite>SetDropTarget</cite></p>
554</dd></dl>
555
556<dl class="attribute">
557<dt id="sans.guiframe.aboutbox.DialogAbout.EffectiveMinSize">
558<tt class="descname">EffectiveMinSize</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.EffectiveMinSize" title="Permalink to this definition">¶</a></dt>
559<dd><p>See <cite>GetEffectiveMinSize</cite></p>
560</dd></dl>
561
562<dl class="method">
563<dt id="sans.guiframe.aboutbox.DialogAbout.Enable">
564<tt class="descname">Enable</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Enable" title="Permalink to this definition">¶</a></dt>
565<dd><p>Enable(self, bool enable=True) -&gt; bool</p>
566<p>Enable or disable the window for user input. Note that when a parent
567window is disabled, all of its children are disabled as well and they
568are reenabled again when the parent is.  Returns true if the window
569has been enabled or disabled, false if nothing was done, i.e. if the
570window had already been in the specified state.</p>
571</dd></dl>
572
573<dl class="method">
574<dt id="sans.guiframe.aboutbox.DialogAbout.EnableCloseButton">
575<tt class="descname">EnableCloseButton</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.EnableCloseButton" title="Permalink to this definition">¶</a></dt>
576<dd><p>EnableCloseButton(self, bool enable) -&gt; bool</p>
577</dd></dl>
578
579<dl class="attribute">
580<dt id="sans.guiframe.aboutbox.DialogAbout.Enabled">
581<tt class="descname">Enabled</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Enabled" title="Permalink to this definition">¶</a></dt>
582<dd><p>See <cite>IsEnabled</cite> and <cite>Enable</cite></p>
583</dd></dl>
584
585<dl class="method">
586<dt id="sans.guiframe.aboutbox.DialogAbout.EndModal">
587<tt class="descname">EndModal</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.EndModal" title="Permalink to this definition">¶</a></dt>
588<dd><p>EndModal(self, int retCode)</p>
589</dd></dl>
590
591<dl class="attribute">
592<dt id="sans.guiframe.aboutbox.DialogAbout.EscapeId">
593<tt class="descname">EscapeId</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.EscapeId" title="Permalink to this definition">¶</a></dt>
594<dd><p>See <cite>GetEscapeId</cite> and <cite>SetEscapeId</cite></p>
595</dd></dl>
596
597<dl class="attribute">
598<dt id="sans.guiframe.aboutbox.DialogAbout.EventHandler">
599<tt class="descname">EventHandler</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.EventHandler" title="Permalink to this definition">¶</a></dt>
600<dd><p>See <cite>GetEventHandler</cite> and <cite>SetEventHandler</cite></p>
601</dd></dl>
602
603<dl class="attribute">
604<dt id="sans.guiframe.aboutbox.DialogAbout.EvtHandlerEnabled">
605<tt class="descname">EvtHandlerEnabled</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.EvtHandlerEnabled" title="Permalink to this definition">¶</a></dt>
606<dd><p>See <cite>GetEvtHandlerEnabled</cite> and <cite>SetEvtHandlerEnabled</cite></p>
607</dd></dl>
608
609<dl class="attribute">
610<dt id="sans.guiframe.aboutbox.DialogAbout.ExtraStyle">
611<tt class="descname">ExtraStyle</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ExtraStyle" title="Permalink to this definition">¶</a></dt>
612<dd><p>See <cite>GetExtraStyle</cite> and <cite>SetExtraStyle</cite></p>
613</dd></dl>
614
615<dl class="staticmethod">
616<dt id="sans.guiframe.aboutbox.DialogAbout.FindFocus">
617<em class="property">static </em><tt class="descname">FindFocus</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.FindFocus" title="Permalink to this definition">¶</a></dt>
618<dd><p>FindFocus() -&gt; Window</p>
619<p>Returns the window or control that currently has the keyboard focus,
620or None.</p>
621</dd></dl>
622
623<dl class="method">
624<dt id="sans.guiframe.aboutbox.DialogAbout.FindWindowById">
625<tt class="descname">FindWindowById</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.FindWindowById" title="Permalink to this definition">¶</a></dt>
626<dd><p>FindWindowById(self, long winid) -&gt; Window</p>
627<p>Find a child of this window by window ID</p>
628</dd></dl>
629
630<dl class="method">
631<dt id="sans.guiframe.aboutbox.DialogAbout.FindWindowByLabel">
632<tt class="descname">FindWindowByLabel</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.FindWindowByLabel" title="Permalink to this definition">¶</a></dt>
633<dd><p>FindWindowByLabel(self, String label) -&gt; Window</p>
634<p>Find a child of this window by label</p>
635</dd></dl>
636
637<dl class="method">
638<dt id="sans.guiframe.aboutbox.DialogAbout.FindWindowByName">
639<tt class="descname">FindWindowByName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.FindWindowByName" title="Permalink to this definition">¶</a></dt>
640<dd><p>FindWindowByName(self, String name) -&gt; Window</p>
641<p>Find a child of this window by name</p>
642</dd></dl>
643
644<dl class="method">
645<dt id="sans.guiframe.aboutbox.DialogAbout.Fit">
646<tt class="descname">Fit</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Fit" title="Permalink to this definition">¶</a></dt>
647<dd><p>Fit(self)</p>
648<p>Sizes the window so that it fits around its subwindows. This function
649won&#8217;t do anything if there are no subwindows and will only really work
650correctly if sizers are used for the subwindows layout. Also, if the
651window has exactly one subwindow it is better (faster and the result
652is more precise as Fit adds some margin to account for fuzziness of
653its calculations) to call window.SetClientSize(child.GetSize())
654instead of calling Fit.</p>
655</dd></dl>
656
657<dl class="method">
658<dt id="sans.guiframe.aboutbox.DialogAbout.FitInside">
659<tt class="descname">FitInside</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.FitInside" title="Permalink to this definition">¶</a></dt>
660<dd><p>FitInside(self)</p>
661<p>Similar to Fit, but sizes the interior (virtual) size of a
662window. Mainly useful with scrolled windows to reset scrollbars after
663sizing changes that do not trigger a size event, and/or scrolled
664windows without an interior sizer. This function similarly won&#8217;t do
665anything if there are no subwindows.</p>
666</dd></dl>
667
668<dl class="attribute">
669<dt id="sans.guiframe.aboutbox.DialogAbout.Font">
670<tt class="descname">Font</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Font" title="Permalink to this definition">¶</a></dt>
671<dd><p>See <cite>GetFont</cite> and <cite>SetFont</cite></p>
672</dd></dl>
673
674<dl class="attribute">
675<dt id="sans.guiframe.aboutbox.DialogAbout.ForegroundColour">
676<tt class="descname">ForegroundColour</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ForegroundColour" title="Permalink to this definition">¶</a></dt>
677<dd><p>See <cite>GetForegroundColour</cite> and <cite>SetForegroundColour</cite></p>
678</dd></dl>
679
680<dl class="method">
681<dt id="sans.guiframe.aboutbox.DialogAbout.Freeze">
682<tt class="descname">Freeze</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Freeze" title="Permalink to this definition">¶</a></dt>
683<dd><p>Freeze(self)</p>
684<p>Freezes the window or, in other words, prevents any updates from
685taking place on screen, the window is not redrawn at all. Thaw must be
686called to reenable window redrawing.  Calls to Freeze/Thaw may be
687nested, with the actual Thaw being delayed until all the nesting has
688been undone.</p>
689<p>This method is useful for visual appearance optimization (for example,
690it is a good idea to use it before inserting large amount of text into
691a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
692for all controls so it is mostly just a hint to wxWindows and not a
693mandatory directive.</p>
694</dd></dl>
695
696<dl class="method">
697<dt id="sans.guiframe.aboutbox.DialogAbout.GetAcceleratorTable">
698<tt class="descname">GetAcceleratorTable</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetAcceleratorTable" title="Permalink to this definition">¶</a></dt>
699<dd><p>GetAcceleratorTable(self) -&gt; AcceleratorTable</p>
700<p>Gets the accelerator table for this window.</p>
701</dd></dl>
702
703<dl class="method">
704<dt id="sans.guiframe.aboutbox.DialogAbout.GetAdjustedBestSize">
705<tt class="descname">GetAdjustedBestSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetAdjustedBestSize" title="Permalink to this definition">¶</a></dt>
706<dd><p>Use <cite>GetEffectiveMinSize</cite> instead.</p>
707</dd></dl>
708
709<dl class="method">
710<dt id="sans.guiframe.aboutbox.DialogAbout.GetAffirmativeId">
711<tt class="descname">GetAffirmativeId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetAffirmativeId" title="Permalink to this definition">¶</a></dt>
712<dd><p>GetAffirmativeId(self) -&gt; int</p>
713</dd></dl>
714
715<dl class="method">
716<dt id="sans.guiframe.aboutbox.DialogAbout.GetAutoLayout">
717<tt class="descname">GetAutoLayout</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetAutoLayout" title="Permalink to this definition">¶</a></dt>
718<dd><p>GetAutoLayout(self) -&gt; bool</p>
719<p>Returns the current autoLayout setting</p>
720</dd></dl>
721
722<dl class="method">
723<dt id="sans.guiframe.aboutbox.DialogAbout.GetBackgroundColour">
724<tt class="descname">GetBackgroundColour</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetBackgroundColour" title="Permalink to this definition">¶</a></dt>
725<dd><p>GetBackgroundColour(self) -&gt; Colour</p>
726<p>Returns the background colour of the window.</p>
727</dd></dl>
728
729<dl class="method">
730<dt id="sans.guiframe.aboutbox.DialogAbout.GetBackgroundStyle">
731<tt class="descname">GetBackgroundStyle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetBackgroundStyle" title="Permalink to this definition">¶</a></dt>
732<dd><p>GetBackgroundStyle(self) -&gt; int</p>
733<p>Returns the background style of the window.</p>
734<table class="docutils field-list" frame="void" rules="none">
735<col class="field-name" />
736<col class="field-body" />
737<tbody valign="top">
738<tr class="field"><th class="field-name">See :</th><td class="field-body"><cite>SetBackgroundStyle</cite></td>
739</tr>
740</tbody>
741</table>
742</dd></dl>
743
744<dl class="method">
745<dt id="sans.guiframe.aboutbox.DialogAbout.GetBestFittingSize">
746<tt class="descname">GetBestFittingSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetBestFittingSize" title="Permalink to this definition">¶</a></dt>
747<dd><p>Use <cite>GetEffectiveMinSize</cite> instead.</p>
748</dd></dl>
749
750<dl class="method">
751<dt id="sans.guiframe.aboutbox.DialogAbout.GetBestSize">
752<tt class="descname">GetBestSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetBestSize" title="Permalink to this definition">¶</a></dt>
753<dd><p>GetBestSize(self) -&gt; Size</p>
754<p>This function returns the best acceptable minimal size for the
755window, if applicable. For example, for a static text control, it will
756be the minimal size such that the control label is not truncated. For
757windows containing subwindows (such as wx.Panel), the size returned by
758this function will be the same as the size the window would have had
759after calling Fit.</p>
760</dd></dl>
761
762<dl class="method">
763<dt id="sans.guiframe.aboutbox.DialogAbout.GetBestSizeTuple">
764<tt class="descname">GetBestSizeTuple</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetBestSizeTuple" title="Permalink to this definition">¶</a></dt>
765<dd><p>GetBestSizeTuple() -&gt; (width, height)</p>
766<p>This function returns the best acceptable minimal size for the
767window, if applicable. For example, for a static text control, it will
768be the minimal size such that the control label is not truncated. For
769windows containing subwindows (such as wx.Panel), the size returned by
770this function will be the same as the size the window would have had
771after calling Fit.</p>
772</dd></dl>
773
774<dl class="method">
775<dt id="sans.guiframe.aboutbox.DialogAbout.GetBestVirtualSize">
776<tt class="descname">GetBestVirtualSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetBestVirtualSize" title="Permalink to this definition">¶</a></dt>
777<dd><p>GetBestVirtualSize(self) -&gt; Size</p>
778<p>Return the largest of ClientSize and BestSize (as determined by a
779sizer, interior children, or other means)</p>
780</dd></dl>
781
782<dl class="method">
783<dt id="sans.guiframe.aboutbox.DialogAbout.GetBorder">
784<tt class="descname">GetBorder</tt><big>(</big><em>*args</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetBorder" title="Permalink to this definition">¶</a></dt>
785<dd><p>GetBorder(self, long flags) -&gt; int
786GetBorder(self) -&gt; int</p>
787<p>Get border for the flags of this window</p>
788</dd></dl>
789
790<dl class="staticmethod">
791<dt id="sans.guiframe.aboutbox.DialogAbout.GetCapture">
792<em class="property">static </em><tt class="descname">GetCapture</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetCapture" title="Permalink to this definition">¶</a></dt>
793<dd><p>GetCapture() -&gt; Window</p>
794<p>Returns the window which currently captures the mouse or None</p>
795</dd></dl>
796
797<dl class="method">
798<dt id="sans.guiframe.aboutbox.DialogAbout.GetCaret">
799<tt class="descname">GetCaret</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetCaret" title="Permalink to this definition">¶</a></dt>
800<dd><p>GetCaret(self) -&gt; Caret</p>
801<p>Returns the caret associated with the window.</p>
802</dd></dl>
803
804<dl class="method">
805<dt id="sans.guiframe.aboutbox.DialogAbout.GetCharHeight">
806<tt class="descname">GetCharHeight</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetCharHeight" title="Permalink to this definition">¶</a></dt>
807<dd><p>GetCharHeight(self) -&gt; int</p>
808<p>Get the (average) character size for the current font.</p>
809</dd></dl>
810
811<dl class="method">
812<dt id="sans.guiframe.aboutbox.DialogAbout.GetCharWidth">
813<tt class="descname">GetCharWidth</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetCharWidth" title="Permalink to this definition">¶</a></dt>
814<dd><p>GetCharWidth(self) -&gt; int</p>
815<p>Get the (average) character size for the current font.</p>
816</dd></dl>
817
818<dl class="method">
819<dt id="sans.guiframe.aboutbox.DialogAbout.GetChildren">
820<tt class="descname">GetChildren</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetChildren" title="Permalink to this definition">¶</a></dt>
821<dd><p>GetChildren(self) -&gt; WindowList</p>
822<p>Returns an object containing a list of the window&#8217;s children.  The
823object provides a Python sequence-like interface over the internal
824list maintained by the window..</p>
825</dd></dl>
826
827<dl class="staticmethod">
828<dt id="sans.guiframe.aboutbox.DialogAbout.GetClassDefaultAttributes">
829<em class="property">static </em><tt class="descname">GetClassDefaultAttributes</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetClassDefaultAttributes" title="Permalink to this definition">¶</a></dt>
830<dd><p>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -&gt; VisualAttributes</p>
831<p>Get the default attributes for this class.  This is useful if you want
832to use the same font or colour in your own control as in a standard
833control &#8211; which is a much better idea than hard coding specific
834colours or fonts which might look completely out of place on the
835user&#8217;s system, especially if it uses themes.</p>
836<p>The variant parameter is only relevant under Mac currently and is
837ignore under other platforms. Under Mac, it will change the size of
838the returned font. See <cite>wx.Window.SetWindowVariant</cite> for more about
839this.</p>
840</dd></dl>
841
842<dl class="method">
843<dt id="sans.guiframe.aboutbox.DialogAbout.GetClassName">
844<tt class="descname">GetClassName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetClassName" title="Permalink to this definition">¶</a></dt>
845<dd><p>GetClassName(self) -&gt; String</p>
846<p>Returns the class name of the C++ class using wxRTTI.</p>
847</dd></dl>
848
849<dl class="method">
850<dt id="sans.guiframe.aboutbox.DialogAbout.GetClientAreaOrigin">
851<tt class="descname">GetClientAreaOrigin</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetClientAreaOrigin" title="Permalink to this definition">¶</a></dt>
852<dd><p>GetClientAreaOrigin(self) -&gt; Point</p>
853<p>Get the origin of the client area of the window relative to the
854window&#8217;s top left corner (the client area may be shifted because of
855the borders, scrollbars, other decorations...)</p>
856</dd></dl>
857
858<dl class="method">
859<dt id="sans.guiframe.aboutbox.DialogAbout.GetClientRect">
860<tt class="descname">GetClientRect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetClientRect" title="Permalink to this definition">¶</a></dt>
861<dd><p>GetClientRect(self) -&gt; Rect</p>
862<p>Get the client area position and size as a <cite>wx.Rect</cite> object.</p>
863</dd></dl>
864
865<dl class="method">
866<dt id="sans.guiframe.aboutbox.DialogAbout.GetClientSize">
867<tt class="descname">GetClientSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetClientSize" title="Permalink to this definition">¶</a></dt>
868<dd><p>GetClientSize(self) -&gt; Size</p>
869<p>This gets the size of the window&#8217;s &#8216;client area&#8217; in pixels. The client
870area is the area which may be drawn on by the programmer, excluding
871title bar, border, scrollbars, etc.</p>
872</dd></dl>
873
874<dl class="method">
875<dt id="sans.guiframe.aboutbox.DialogAbout.GetClientSizeTuple">
876<tt class="descname">GetClientSizeTuple</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetClientSizeTuple" title="Permalink to this definition">¶</a></dt>
877<dd><p>GetClientSizeTuple() -&gt; (width, height)</p>
878<p>This gets the size of the window&#8217;s &#8216;client area&#8217; in pixels. The client
879area is the area which may be drawn on by the programmer, excluding
880title bar, border, scrollbars, etc.</p>
881</dd></dl>
882
883<dl class="method">
884<dt id="sans.guiframe.aboutbox.DialogAbout.GetConstraints">
885<tt class="descname">GetConstraints</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetConstraints" title="Permalink to this definition">¶</a></dt>
886<dd><p>GetConstraints(self) -&gt; LayoutConstraints</p>
887<p>Returns a pointer to the window&#8217;s layout constraints, or None if there
888are none.</p>
889</dd></dl>
890
891<dl class="method">
892<dt id="sans.guiframe.aboutbox.DialogAbout.GetContainingSizer">
893<tt class="descname">GetContainingSizer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetContainingSizer" title="Permalink to this definition">¶</a></dt>
894<dd><p>GetContainingSizer(self) -&gt; Sizer</p>
895<p>Return the sizer that this window is a member of, if any, otherwise None.</p>
896</dd></dl>
897
898<dl class="method">
899<dt id="sans.guiframe.aboutbox.DialogAbout.GetCursor">
900<tt class="descname">GetCursor</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetCursor" title="Permalink to this definition">¶</a></dt>
901<dd><p>GetCursor(self) -&gt; Cursor</p>
902<p>Return the cursor associated with this window.</p>
903</dd></dl>
904
905<dl class="method">
906<dt id="sans.guiframe.aboutbox.DialogAbout.GetDefaultAttributes">
907<tt class="descname">GetDefaultAttributes</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetDefaultAttributes" title="Permalink to this definition">¶</a></dt>
908<dd><p>GetDefaultAttributes(self) -&gt; VisualAttributes</p>
909<p>Get the default attributes for an instance of this class.  This is
910useful if you want to use the same font or colour in your own control
911as in a standard control &#8211; which is a much better idea than hard
912coding specific colours or fonts which might look completely out of
913place on the user&#8217;s system, especially if it uses themes.</p>
914</dd></dl>
915
916<dl class="method">
917<dt id="sans.guiframe.aboutbox.DialogAbout.GetDefaultItem">
918<tt class="descname">GetDefaultItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetDefaultItem" title="Permalink to this definition">¶</a></dt>
919<dd><p>GetDefaultItem(self) -&gt; Window</p>
920<p>Get the default child of this parent, i.e. the one which is activated
921by pressing &lt;Enter&gt; such as the OK button on a wx.Dialog.</p>
922</dd></dl>
923
924<dl class="method">
925<dt id="sans.guiframe.aboutbox.DialogAbout.GetDropTarget">
926<tt class="descname">GetDropTarget</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetDropTarget" title="Permalink to this definition">¶</a></dt>
927<dd><p>GetDropTarget(self) -&gt; DropTarget</p>
928<p>Returns the associated drop target, which may be None.</p>
929</dd></dl>
930
931<dl class="method">
932<dt id="sans.guiframe.aboutbox.DialogAbout.GetEffectiveMinSize">
933<tt class="descname">GetEffectiveMinSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetEffectiveMinSize" title="Permalink to this definition">¶</a></dt>
934<dd><p>GetEffectiveMinSize(self) -&gt; Size</p>
935<p>This function will merge the window&#8217;s best size into the window&#8217;s
936minimum size, giving priority to the min size components, and returns
937the results.</p>
938</dd></dl>
939
940<dl class="method">
941<dt id="sans.guiframe.aboutbox.DialogAbout.GetEscapeId">
942<tt class="descname">GetEscapeId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetEscapeId" title="Permalink to this definition">¶</a></dt>
943<dd><p>GetEscapeId(self) -&gt; int</p>
944</dd></dl>
945
946<dl class="method">
947<dt id="sans.guiframe.aboutbox.DialogAbout.GetEventHandler">
948<tt class="descname">GetEventHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetEventHandler" title="Permalink to this definition">¶</a></dt>
949<dd><p>GetEventHandler(self) -&gt; EvtHandler</p>
950<p>Returns the event handler for this window. By default, the window is
951its own event handler.</p>
952</dd></dl>
953
954<dl class="method">
955<dt id="sans.guiframe.aboutbox.DialogAbout.GetEvtHandlerEnabled">
956<tt class="descname">GetEvtHandlerEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt>
957<dd><p>GetEvtHandlerEnabled(self) -&gt; bool</p>
958</dd></dl>
959
960<dl class="method">
961<dt id="sans.guiframe.aboutbox.DialogAbout.GetExtraStyle">
962<tt class="descname">GetExtraStyle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetExtraStyle" title="Permalink to this definition">¶</a></dt>
963<dd><p>GetExtraStyle(self) -&gt; long</p>
964<p>Returns the extra style bits for the window.</p>
965</dd></dl>
966
967<dl class="method">
968<dt id="sans.guiframe.aboutbox.DialogAbout.GetFont">
969<tt class="descname">GetFont</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetFont" title="Permalink to this definition">¶</a></dt>
970<dd><p>GetFont(self) -&gt; Font</p>
971<p>Returns the default font used for this window.</p>
972</dd></dl>
973
974<dl class="method">
975<dt id="sans.guiframe.aboutbox.DialogAbout.GetForegroundColour">
976<tt class="descname">GetForegroundColour</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetForegroundColour" title="Permalink to this definition">¶</a></dt>
977<dd><p>GetForegroundColour(self) -&gt; Colour</p>
978<p>Returns the foreground colour of the window.  The interpretation of
979foreground colour is dependent on the window class; it may be the text
980colour or other colour, or it may not be used at all.</p>
981</dd></dl>
982
983<dl class="method">
984<dt id="sans.guiframe.aboutbox.DialogAbout.GetFullTextExtent">
985<tt class="descname">GetFullTextExtent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetFullTextExtent" title="Permalink to this definition">¶</a></dt>
986<dd><dl class="docutils">
987<dt>GetFullTextExtent(String string, Font font=None) -&gt;</dt>
988<dd>(width, height, descent, externalLeading)</dd>
989</dl>
990<p>Get the width, height, decent and leading of the text using the
991current or specified font.</p>
992</dd></dl>
993
994<dl class="method">
995<dt id="sans.guiframe.aboutbox.DialogAbout.GetGrandParent">
996<tt class="descname">GetGrandParent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetGrandParent" title="Permalink to this definition">¶</a></dt>
997<dd><p>GetGrandParent(self) -&gt; Window</p>
998<p>Returns the parent of the parent of this window, or None if there
999isn&#8217;t one.</p>
1000</dd></dl>
1001
1002<dl class="method">
1003<dt id="sans.guiframe.aboutbox.DialogAbout.GetGtkWidget">
1004<tt class="descname">GetGtkWidget</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetGtkWidget" title="Permalink to this definition">¶</a></dt>
1005<dd><p>GetGtkWidget(self) -&gt; long</p>
1006<p>On wxGTK returns a pointer to the GtkWidget for this window as a long
1007integer.  On the other platforms this method returns zero.</p>
1008</dd></dl>
1009
1010<dl class="method">
1011<dt id="sans.guiframe.aboutbox.DialogAbout.GetHandle">
1012<tt class="descname">GetHandle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetHandle" title="Permalink to this definition">¶</a></dt>
1013<dd><p>GetHandle(self) -&gt; long</p>
1014<p>Returns the platform-specific handle (as a long integer) of the
1015physical window.  On wxMSW this is the win32 window handle, on wxGTK
1016it is the XWindow ID, and on wxMac it is the ControlRef.</p>
1017</dd></dl>
1018
1019<dl class="method">
1020<dt id="sans.guiframe.aboutbox.DialogAbout.GetHelpText">
1021<tt class="descname">GetHelpText</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetHelpText" title="Permalink to this definition">¶</a></dt>
1022<dd><p>GetHelpText(self) -&gt; String</p>
1023<p>Gets the help text to be used as context-sensitive help for this
1024window.  Note that the text is actually stored by the current
1025<cite>wx.HelpProvider</cite> implementation, and not in the window object itself.</p>
1026</dd></dl>
1027
1028<dl class="method">
1029<dt id="sans.guiframe.aboutbox.DialogAbout.GetHelpTextAtPoint">
1030<tt class="descname">GetHelpTextAtPoint</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetHelpTextAtPoint" title="Permalink to this definition">¶</a></dt>
1031<dd><p>GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -&gt; String</p>
1032<p>Get the help string associated with the given position in this window.</p>
1033<p>Notice that pt may be invalid if event origin is keyboard or unknown
1034and this method should return the global window help text then</p>
1035</dd></dl>
1036
1037<dl class="method">
1038<dt id="sans.guiframe.aboutbox.DialogAbout.GetIcon">
1039<tt class="descname">GetIcon</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetIcon" title="Permalink to this definition">¶</a></dt>
1040<dd><p>GetIcon(self) -&gt; Icon</p>
1041</dd></dl>
1042
1043<dl class="method">
1044<dt id="sans.guiframe.aboutbox.DialogAbout.GetId">
1045<tt class="descname">GetId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetId" title="Permalink to this definition">¶</a></dt>
1046<dd><p>GetId(self) -&gt; int</p>
1047<p>Returns the identifier of the window.  Each window has an integer
1048identifier. If the application has not provided one (or the default Id
1049-1 is used) then an unique identifier with a negative value will be
1050generated.</p>
1051</dd></dl>
1052
1053<dl class="method">
1054<dt id="sans.guiframe.aboutbox.DialogAbout.GetLabel">
1055<tt class="descname">GetLabel</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetLabel" title="Permalink to this definition">¶</a></dt>
1056<dd><p>GetLabel(self) -&gt; String</p>
1057<p>Generic way of getting a label from any window, for identification
1058purposes.  The interpretation of this function differs from class to
1059class. For frames and dialogs, the value returned is the title. For
1060buttons or static text controls, it is the button text. This function
1061can be useful for meta-programs such as testing tools or special-needs
1062access programs)which need to identify windows by name.</p>
1063</dd></dl>
1064
1065<dl class="method">
1066<dt id="sans.guiframe.aboutbox.DialogAbout.GetLayoutDirection">
1067<tt class="descname">GetLayoutDirection</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetLayoutDirection" title="Permalink to this definition">¶</a></dt>
1068<dd><p>GetLayoutDirection(self) -&gt; int</p>
1069<p>Get the layout direction (LTR or RTL) for this window.  Returns
1070<tt class="docutils literal"><span class="pre">wx.Layout_Default</span></tt> if layout direction is not supported.</p>
1071</dd></dl>
1072
1073<dl class="method">
1074<dt id="sans.guiframe.aboutbox.DialogAbout.GetMaxHeight">
1075<tt class="descname">GetMaxHeight</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetMaxHeight" title="Permalink to this definition">¶</a></dt>
1076<dd><p>GetMaxHeight(self) -&gt; int</p>
1077</dd></dl>
1078
1079<dl class="method">
1080<dt id="sans.guiframe.aboutbox.DialogAbout.GetMaxSize">
1081<tt class="descname">GetMaxSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetMaxSize" title="Permalink to this definition">¶</a></dt>
1082<dd><p>GetMaxSize(self) -&gt; Size</p>
1083</dd></dl>
1084
1085<dl class="method">
1086<dt id="sans.guiframe.aboutbox.DialogAbout.GetMaxWidth">
1087<tt class="descname">GetMaxWidth</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetMaxWidth" title="Permalink to this definition">¶</a></dt>
1088<dd><p>GetMaxWidth(self) -&gt; int</p>
1089</dd></dl>
1090
1091<dl class="method">
1092<dt id="sans.guiframe.aboutbox.DialogAbout.GetMinHeight">
1093<tt class="descname">GetMinHeight</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetMinHeight" title="Permalink to this definition">¶</a></dt>
1094<dd><p>GetMinHeight(self) -&gt; int</p>
1095</dd></dl>
1096
1097<dl class="method">
1098<dt id="sans.guiframe.aboutbox.DialogAbout.GetMinSize">
1099<tt class="descname">GetMinSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetMinSize" title="Permalink to this definition">¶</a></dt>
1100<dd><p>GetMinSize(self) -&gt; Size</p>
1101</dd></dl>
1102
1103<dl class="method">
1104<dt id="sans.guiframe.aboutbox.DialogAbout.GetMinWidth">
1105<tt class="descname">GetMinWidth</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetMinWidth" title="Permalink to this definition">¶</a></dt>
1106<dd><p>GetMinWidth(self) -&gt; int</p>
1107</dd></dl>
1108
1109<dl class="method">
1110<dt id="sans.guiframe.aboutbox.DialogAbout.GetName">
1111<tt class="descname">GetName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetName" title="Permalink to this definition">¶</a></dt>
1112<dd><p>GetName(self) -&gt; String</p>
1113<p>Returns the windows name.  This name is not guaranteed to be unique;
1114it is up to the programmer to supply an appropriate name in the window
1115constructor or via wx.Window.SetName.</p>
1116</dd></dl>
1117
1118<dl class="method">
1119<dt id="sans.guiframe.aboutbox.DialogAbout.GetNextHandler">
1120<tt class="descname">GetNextHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetNextHandler" title="Permalink to this definition">¶</a></dt>
1121<dd><p>GetNextHandler(self) -&gt; EvtHandler</p>
1122</dd></dl>
1123
1124<dl class="method">
1125<dt id="sans.guiframe.aboutbox.DialogAbout.GetParent">
1126<tt class="descname">GetParent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetParent" title="Permalink to this definition">¶</a></dt>
1127<dd><p>GetParent(self) -&gt; Window</p>
1128<p>Returns the parent window of this window, or None if there isn&#8217;t one.</p>
1129</dd></dl>
1130
1131<dl class="method">
1132<dt id="sans.guiframe.aboutbox.DialogAbout.GetPosition">
1133<tt class="descname">GetPosition</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetPosition" title="Permalink to this definition">¶</a></dt>
1134<dd><p>GetPosition(self) -&gt; Point</p>
1135<p>Get the window&#8217;s position.  Notice that the position is in client
1136coordinates for child windows and screen coordinates for the top level
1137ones, use <cite>GetScreenPosition</cite> if you need screen coordinates for all
1138kinds of windows.</p>
1139</dd></dl>
1140
1141<dl class="method">
1142<dt id="sans.guiframe.aboutbox.DialogAbout.GetPositionTuple">
1143<tt class="descname">GetPositionTuple</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetPositionTuple" title="Permalink to this definition">¶</a></dt>
1144<dd><p>GetPositionTuple() -&gt; (x,y)</p>
1145<p>Get the window&#8217;s position.  Notice that the position is in client
1146coordinates for child windows and screen coordinates for the top level
1147ones, use <cite>GetScreenPosition</cite> if you need screen coordinates for all
1148kinds of windows.</p>
1149</dd></dl>
1150
1151<dl class="method">
1152<dt id="sans.guiframe.aboutbox.DialogAbout.GetPreviousHandler">
1153<tt class="descname">GetPreviousHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetPreviousHandler" title="Permalink to this definition">¶</a></dt>
1154<dd><p>GetPreviousHandler(self) -&gt; EvtHandler</p>
1155</dd></dl>
1156
1157<dl class="method">
1158<dt id="sans.guiframe.aboutbox.DialogAbout.GetRect">
1159<tt class="descname">GetRect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetRect" title="Permalink to this definition">¶</a></dt>
1160<dd><p>GetRect(self) -&gt; Rect</p>
1161<p>Returns the size and position of the window as a <cite>wx.Rect</cite> object.</p>
1162</dd></dl>
1163
1164<dl class="method">
1165<dt id="sans.guiframe.aboutbox.DialogAbout.GetReturnCode">
1166<tt class="descname">GetReturnCode</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetReturnCode" title="Permalink to this definition">¶</a></dt>
1167<dd><p>GetReturnCode(self) -&gt; int</p>
1168</dd></dl>
1169
1170<dl class="method">
1171<dt id="sans.guiframe.aboutbox.DialogAbout.GetScreenPosition">
1172<tt class="descname">GetScreenPosition</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetScreenPosition" title="Permalink to this definition">¶</a></dt>
1173<dd><p>GetScreenPosition(self) -&gt; Point</p>
1174<p>Get the position of the window in screen coordinantes.</p>
1175</dd></dl>
1176
1177<dl class="method">
1178<dt id="sans.guiframe.aboutbox.DialogAbout.GetScreenPositionTuple">
1179<tt class="descname">GetScreenPositionTuple</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetScreenPositionTuple" title="Permalink to this definition">¶</a></dt>
1180<dd><p>GetScreenPositionTuple() -&gt; (x,y)</p>
1181<p>Get the position of the window in screen coordinantes.</p>
1182</dd></dl>
1183
1184<dl class="method">
1185<dt id="sans.guiframe.aboutbox.DialogAbout.GetScreenRect">
1186<tt class="descname">GetScreenRect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetScreenRect" title="Permalink to this definition">¶</a></dt>
1187<dd><p>GetScreenRect(self) -&gt; Rect</p>
1188<p>Returns the size and position of the window in screen coordinantes as
1189a <cite>wx.Rect</cite> object.</p>
1190</dd></dl>
1191
1192<dl class="method">
1193<dt id="sans.guiframe.aboutbox.DialogAbout.GetScrollPos">
1194<tt class="descname">GetScrollPos</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetScrollPos" title="Permalink to this definition">¶</a></dt>
1195<dd><p>GetScrollPos(self, int orientation) -&gt; int</p>
1196<p>Returns the built-in scrollbar position.</p>
1197</dd></dl>
1198
1199<dl class="method">
1200<dt id="sans.guiframe.aboutbox.DialogAbout.GetScrollRange">
1201<tt class="descname">GetScrollRange</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetScrollRange" title="Permalink to this definition">¶</a></dt>
1202<dd><p>GetScrollRange(self, int orientation) -&gt; int</p>
1203<p>Returns the built-in scrollbar range.</p>
1204</dd></dl>
1205
1206<dl class="method">
1207<dt id="sans.guiframe.aboutbox.DialogAbout.GetScrollThumb">
1208<tt class="descname">GetScrollThumb</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetScrollThumb" title="Permalink to this definition">¶</a></dt>
1209<dd><p>GetScrollThumb(self, int orientation) -&gt; int</p>
1210<p>Returns the built-in scrollbar thumb size.</p>
1211</dd></dl>
1212
1213<dl class="method">
1214<dt id="sans.guiframe.aboutbox.DialogAbout.GetSize">
1215<tt class="descname">GetSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetSize" title="Permalink to this definition">¶</a></dt>
1216<dd><p>GetSize(self) -&gt; Size</p>
1217<p>Get the window size.</p>
1218</dd></dl>
1219
1220<dl class="method">
1221<dt id="sans.guiframe.aboutbox.DialogAbout.GetSizeTuple">
1222<tt class="descname">GetSizeTuple</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetSizeTuple" title="Permalink to this definition">¶</a></dt>
1223<dd><p>GetSizeTuple() -&gt; (width, height)</p>
1224<p>Get the window size.</p>
1225</dd></dl>
1226
1227<dl class="method">
1228<dt id="sans.guiframe.aboutbox.DialogAbout.GetSizer">
1229<tt class="descname">GetSizer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetSizer" title="Permalink to this definition">¶</a></dt>
1230<dd><p>GetSizer(self) -&gt; Sizer</p>
1231<p>Return the sizer associated with the window by a previous call to
1232SetSizer or None if there isn&#8217;t one.</p>
1233</dd></dl>
1234
1235<dl class="method">
1236<dt id="sans.guiframe.aboutbox.DialogAbout.GetTextExtent">
1237<tt class="descname">GetTextExtent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetTextExtent" title="Permalink to this definition">¶</a></dt>
1238<dd><p>GetTextExtent(String string) -&gt; (width, height)</p>
1239<p>Get the width and height of the text using the current font.</p>
1240</dd></dl>
1241
1242<dl class="method">
1243<dt id="sans.guiframe.aboutbox.DialogAbout.GetThemeEnabled">
1244<tt class="descname">GetThemeEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetThemeEnabled" title="Permalink to this definition">¶</a></dt>
1245<dd><p>GetThemeEnabled(self) -&gt; bool</p>
1246<p>Return the themeEnabled flag.</p>
1247</dd></dl>
1248
1249<dl class="method">
1250<dt id="sans.guiframe.aboutbox.DialogAbout.GetTitle">
1251<tt class="descname">GetTitle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetTitle" title="Permalink to this definition">¶</a></dt>
1252<dd><p>GetTitle(self) -&gt; String</p>
1253</dd></dl>
1254
1255<dl class="method">
1256<dt id="sans.guiframe.aboutbox.DialogAbout.GetTmpDefaultItem">
1257<tt class="descname">GetTmpDefaultItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetTmpDefaultItem" title="Permalink to this definition">¶</a></dt>
1258<dd><p>GetTmpDefaultItem(self) -&gt; Window</p>
1259<p>Return the temporary default item, which can be None.</p>
1260</dd></dl>
1261
1262<dl class="method">
1263<dt id="sans.guiframe.aboutbox.DialogAbout.GetToolTip">
1264<tt class="descname">GetToolTip</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetToolTip" title="Permalink to this definition">¶</a></dt>
1265<dd><p>GetToolTip(self) -&gt; ToolTip</p>
1266<p>get the associated tooltip or None if none</p>
1267</dd></dl>
1268
1269<dl class="method">
1270<dt id="sans.guiframe.aboutbox.DialogAbout.GetTopLevelParent">
1271<tt class="descname">GetTopLevelParent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetTopLevelParent" title="Permalink to this definition">¶</a></dt>
1272<dd><p>GetTopLevelParent(self) -&gt; Window</p>
1273<p>Returns the first frame or dialog in this window&#8217;s parental hierarchy.</p>
1274</dd></dl>
1275
1276<dl class="method">
1277<dt id="sans.guiframe.aboutbox.DialogAbout.GetUpdateClientRect">
1278<tt class="descname">GetUpdateClientRect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetUpdateClientRect" title="Permalink to this definition">¶</a></dt>
1279<dd><p>GetUpdateClientRect(self) -&gt; Rect</p>
1280<p>Get the update rectangle region bounding box in client coords.</p>
1281</dd></dl>
1282
1283<dl class="method">
1284<dt id="sans.guiframe.aboutbox.DialogAbout.GetUpdateRegion">
1285<tt class="descname">GetUpdateRegion</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetUpdateRegion" title="Permalink to this definition">¶</a></dt>
1286<dd><p>GetUpdateRegion(self) -&gt; Region</p>
1287<p>Returns the region specifying which parts of the window have been
1288damaged. Should only be called within an EVT_PAINT handler.</p>
1289</dd></dl>
1290
1291<dl class="method">
1292<dt id="sans.guiframe.aboutbox.DialogAbout.GetValidator">
1293<tt class="descname">GetValidator</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetValidator" title="Permalink to this definition">¶</a></dt>
1294<dd><p>GetValidator(self) -&gt; Validator</p>
1295<p>Returns a pointer to the current validator for the window, or None if
1296there is none.</p>
1297</dd></dl>
1298
1299<dl class="method">
1300<dt id="sans.guiframe.aboutbox.DialogAbout.GetVirtualSize">
1301<tt class="descname">GetVirtualSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetVirtualSize" title="Permalink to this definition">¶</a></dt>
1302<dd><p>GetVirtualSize(self) -&gt; Size</p>
1303<p>Get the the virtual size of the window in pixels.  For most windows
1304this is just the client area of the window, but for some like scrolled
1305windows it is more or less independent of the screen window size.</p>
1306</dd></dl>
1307
1308<dl class="method">
1309<dt id="sans.guiframe.aboutbox.DialogAbout.GetVirtualSizeTuple">
1310<tt class="descname">GetVirtualSizeTuple</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetVirtualSizeTuple" title="Permalink to this definition">¶</a></dt>
1311<dd><p>GetVirtualSizeTuple() -&gt; (width, height)</p>
1312<p>Get the the virtual size of the window in pixels.  For most windows
1313this is just the client area of the window, but for some like scrolled
1314windows it is more or less independent of the screen window size.</p>
1315</dd></dl>
1316
1317<dl class="method">
1318<dt id="sans.guiframe.aboutbox.DialogAbout.GetWindowBorderSize">
1319<tt class="descname">GetWindowBorderSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetWindowBorderSize" title="Permalink to this definition">¶</a></dt>
1320<dd><p>GetWindowBorderSize(self) -&gt; Size</p>
1321<p>Return the size of the left/right and top/bottom borders.</p>
1322</dd></dl>
1323
1324<dl class="method">
1325<dt id="sans.guiframe.aboutbox.DialogAbout.GetWindowStyle">
1326<tt class="descname">GetWindowStyle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetWindowStyle" title="Permalink to this definition">¶</a></dt>
1327<dd><p>GetWindowStyleFlag(self) -&gt; long</p>
1328<p>Gets the window style that was passed to the constructor or Create
1329method.</p>
1330</dd></dl>
1331
1332<dl class="method">
1333<dt id="sans.guiframe.aboutbox.DialogAbout.GetWindowStyleFlag">
1334<tt class="descname">GetWindowStyleFlag</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetWindowStyleFlag" title="Permalink to this definition">¶</a></dt>
1335<dd><p>GetWindowStyleFlag(self) -&gt; long</p>
1336<p>Gets the window style that was passed to the constructor or Create
1337method.</p>
1338</dd></dl>
1339
1340<dl class="method">
1341<dt id="sans.guiframe.aboutbox.DialogAbout.GetWindowVariant">
1342<tt class="descname">GetWindowVariant</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GetWindowVariant" title="Permalink to this definition">¶</a></dt>
1343<dd><p>GetWindowVariant(self) -&gt; int</p>
1344</dd></dl>
1345
1346<dl class="attribute">
1347<dt id="sans.guiframe.aboutbox.DialogAbout.GrandParent">
1348<tt class="descname">GrandParent</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GrandParent" title="Permalink to this definition">¶</a></dt>
1349<dd><p>See <cite>GetGrandParent</cite></p>
1350</dd></dl>
1351
1352<dl class="attribute">
1353<dt id="sans.guiframe.aboutbox.DialogAbout.GtkWidget">
1354<tt class="descname">GtkWidget</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.GtkWidget" title="Permalink to this definition">¶</a></dt>
1355<dd><p>GetGtkWidget(self) -&gt; long</p>
1356<p>On wxGTK returns a pointer to the GtkWidget for this window as a long
1357integer.  On the other platforms this method returns zero.</p>
1358</dd></dl>
1359
1360<dl class="attribute">
1361<dt id="sans.guiframe.aboutbox.DialogAbout.Handle">
1362<tt class="descname">Handle</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Handle" title="Permalink to this definition">¶</a></dt>
1363<dd><p>See <cite>GetHandle</cite></p>
1364</dd></dl>
1365
1366<dl class="method">
1367<dt id="sans.guiframe.aboutbox.DialogAbout.HasCapture">
1368<tt class="descname">HasCapture</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.HasCapture" title="Permalink to this definition">¶</a></dt>
1369<dd><p>HasCapture(self) -&gt; bool</p>
1370<p>Returns true if this window has the current mouse capture.</p>
1371</dd></dl>
1372
1373<dl class="method">
1374<dt id="sans.guiframe.aboutbox.DialogAbout.HasFlag">
1375<tt class="descname">HasFlag</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.HasFlag" title="Permalink to this definition">¶</a></dt>
1376<dd><p>HasFlag(self, int flag) -&gt; bool</p>
1377<p>Test if the given style is set for this window.</p>
1378</dd></dl>
1379
1380<dl class="method">
1381<dt id="sans.guiframe.aboutbox.DialogAbout.HasMultiplePages">
1382<tt class="descname">HasMultiplePages</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.HasMultiplePages" title="Permalink to this definition">¶</a></dt>
1383<dd><p>HasMultiplePages(self) -&gt; bool</p>
1384</dd></dl>
1385
1386<dl class="method">
1387<dt id="sans.guiframe.aboutbox.DialogAbout.HasScrollbar">
1388<tt class="descname">HasScrollbar</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.HasScrollbar" title="Permalink to this definition">¶</a></dt>
1389<dd><p>HasScrollbar(self, int orient) -&gt; bool</p>
1390<p>Does the window have the scrollbar for this orientation?</p>
1391</dd></dl>
1392
1393<dl class="method">
1394<dt id="sans.guiframe.aboutbox.DialogAbout.HasTransparentBackground">
1395<tt class="descname">HasTransparentBackground</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.HasTransparentBackground" title="Permalink to this definition">¶</a></dt>
1396<dd><p>HasTransparentBackground(self) -&gt; bool</p>
1397<p>Returns True if this window&#8217;s background is transparent (as, for
1398example, for <cite>wx.StaticText</cite>) and should show the parent window&#8217;s
1399background.</p>
1400<p>This method is mostly used internally by the library itself and you
1401normally shouldn&#8217;t have to call it. You may, however, have to override
1402it in your custom control classes to ensure that background is painted
1403correctly.</p>
1404</dd></dl>
1405
1406<dl class="attribute">
1407<dt id="sans.guiframe.aboutbox.DialogAbout.HelpText">
1408<tt class="descname">HelpText</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.HelpText" title="Permalink to this definition">¶</a></dt>
1409<dd><p>See <cite>GetHelpText</cite> and <cite>SetHelpText</cite></p>
1410</dd></dl>
1411
1412<dl class="method">
1413<dt id="sans.guiframe.aboutbox.DialogAbout.Hide">
1414<tt class="descname">Hide</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Hide" title="Permalink to this definition">¶</a></dt>
1415<dd><p>Hide(self) -&gt; bool</p>
1416<p>Equivalent to calling Show(False).</p>
1417</dd></dl>
1418
1419<dl class="method">
1420<dt id="sans.guiframe.aboutbox.DialogAbout.HitTest">
1421<tt class="descname">HitTest</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.HitTest" title="Permalink to this definition">¶</a></dt>
1422<dd><p>HitTest(self, Point pt) -&gt; int</p>
1423<p>Test where the given (in client coords) point lies</p>
1424</dd></dl>
1425
1426<dl class="method">
1427<dt id="sans.guiframe.aboutbox.DialogAbout.HitTestXY">
1428<tt class="descname">HitTestXY</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.HitTestXY" title="Permalink to this definition">¶</a></dt>
1429<dd><p>HitTestXY(self, int x, int y) -&gt; int</p>
1430<p>Test where the given (in client coords) point lies</p>
1431</dd></dl>
1432
1433<dl class="attribute">
1434<dt id="sans.guiframe.aboutbox.DialogAbout.Icon">
1435<tt class="descname">Icon</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Icon" title="Permalink to this definition">¶</a></dt>
1436<dd><p>See <cite>GetIcon</cite> and <cite>SetIcon</cite></p>
1437</dd></dl>
1438
1439<dl class="method">
1440<dt id="sans.guiframe.aboutbox.DialogAbout.Iconize">
1441<tt class="descname">Iconize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Iconize" title="Permalink to this definition">¶</a></dt>
1442<dd><p>Iconize(self, bool iconize=True)</p>
1443</dd></dl>
1444
1445<dl class="attribute">
1446<dt id="sans.guiframe.aboutbox.DialogAbout.Id">
1447<tt class="descname">Id</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Id" title="Permalink to this definition">¶</a></dt>
1448<dd><p>See <cite>GetId</cite> and <cite>SetId</cite></p>
1449</dd></dl>
1450
1451<dl class="method">
1452<dt id="sans.guiframe.aboutbox.DialogAbout.InheritAttributes">
1453<tt class="descname">InheritAttributes</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.InheritAttributes" title="Permalink to this definition">¶</a></dt>
1454<dd><p>InheritAttributes(self)</p>
1455<p>This function is (or should be, in case of custom controls) called
1456during window creation to intelligently set up the window visual
1457attributes, that is the font and the foreground and background
1458colours.</p>
1459<p>By &#8216;intelligently&#8217; the following is meant: by default, all windows use
1460their own default attributes. However if some of the parent&#8217;s
1461attributes are explicitly changed (that is, using SetFont and not
1462SetOwnFont) and if the corresponding attribute hadn&#8217;t been
1463explicitly set for this window itself, then this window takes the same
1464value as used by the parent. In addition, if the window overrides
1465ShouldInheritColours to return false, the colours will not be changed
1466no matter what and only the font might.</p>
1467<p>This rather complicated logic is necessary in order to accommodate the
1468different usage scenarios. The most common one is when all default
1469attributes are used and in this case, nothing should be inherited as
1470in modern GUIs different controls use different fonts (and colours)
1471than their siblings so they can&#8217;t inherit the same value from the
1472parent. However it was also deemed desirable to allow to simply change
1473the attributes of all children at once by just changing the font or
1474colour of their common parent, hence in this case we do inherit the
1475parents attributes.</p>
1476</dd></dl>
1477
1478<dl class="method">
1479<dt id="sans.guiframe.aboutbox.DialogAbout.InheritsBackgroundColour">
1480<tt class="descname">InheritsBackgroundColour</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.InheritsBackgroundColour" title="Permalink to this definition">¶</a></dt>
1481<dd><p>InheritsBackgroundColour(self) -&gt; bool</p>
1482</dd></dl>
1483
1484<dl class="method">
1485<dt id="sans.guiframe.aboutbox.DialogAbout.InitDialog">
1486<tt class="descname">InitDialog</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.InitDialog" title="Permalink to this definition">¶</a></dt>
1487<dd><p>InitDialog(self)</p>
1488<p>Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1489to the dialog via validators.</p>
1490</dd></dl>
1491
1492<dl class="method">
1493<dt id="sans.guiframe.aboutbox.DialogAbout.InvalidateBestSize">
1494<tt class="descname">InvalidateBestSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.InvalidateBestSize" title="Permalink to this definition">¶</a></dt>
1495<dd><p>InvalidateBestSize(self)</p>
1496<p>Reset the cached best size value so it will be recalculated the next
1497time it is needed.</p>
1498</dd></dl>
1499
1500<dl class="method">
1501<dt id="sans.guiframe.aboutbox.DialogAbout.IsActive">
1502<tt class="descname">IsActive</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsActive" title="Permalink to this definition">¶</a></dt>
1503<dd><p>IsActive(self) -&gt; bool</p>
1504</dd></dl>
1505
1506<dl class="method">
1507<dt id="sans.guiframe.aboutbox.DialogAbout.IsAlwaysMaximized">
1508<tt class="descname">IsAlwaysMaximized</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsAlwaysMaximized" title="Permalink to this definition">¶</a></dt>
1509<dd><p>IsAlwaysMaximized(self) -&gt; bool</p>
1510</dd></dl>
1511
1512<dl class="method">
1513<dt id="sans.guiframe.aboutbox.DialogAbout.IsBeingDeleted">
1514<tt class="descname">IsBeingDeleted</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsBeingDeleted" title="Permalink to this definition">¶</a></dt>
1515<dd><p>IsBeingDeleted(self) -&gt; bool</p>
1516<p>Is the window in the process of being deleted?</p>
1517</dd></dl>
1518
1519<dl class="method">
1520<dt id="sans.guiframe.aboutbox.DialogAbout.IsDoubleBuffered">
1521<tt class="descname">IsDoubleBuffered</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsDoubleBuffered" title="Permalink to this definition">¶</a></dt>
1522<dd><p>IsDoubleBuffered(self) -&gt; bool</p>
1523<p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the window contents is double-buffered by the
1524system, i.e. if any drawing done on the window is really done on a
1525temporary backing surface and transferred to the screen all at once
1526later.</p>
1527</dd></dl>
1528
1529<dl class="method">
1530<dt id="sans.guiframe.aboutbox.DialogAbout.IsEnabled">
1531<tt class="descname">IsEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsEnabled" title="Permalink to this definition">¶</a></dt>
1532<dd><p>IsEnabled(self) -&gt; bool</p>
1533<p>Returns true if the window is enabled for input, false otherwise.</p>
1534</dd></dl>
1535
1536<dl class="method">
1537<dt id="sans.guiframe.aboutbox.DialogAbout.IsExposed">
1538<tt class="descname">IsExposed</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsExposed" title="Permalink to this definition">¶</a></dt>
1539<dd><p>IsExposed(self, int x, int y, int w=1, int h=1) -&gt; bool</p>
1540<p>Returns true if the given point or rectangle area has been exposed
1541since the last repaint. Call this in an paint event handler to
1542optimize redrawing by only redrawing those areas, which have been
1543exposed.</p>
1544</dd></dl>
1545
1546<dl class="method">
1547<dt id="sans.guiframe.aboutbox.DialogAbout.IsExposedPoint">
1548<tt class="descname">IsExposedPoint</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsExposedPoint" title="Permalink to this definition">¶</a></dt>
1549<dd><p>IsExposedPoint(self, Point pt) -&gt; bool</p>
1550<p>Returns true if the given point or rectangle area has been exposed
1551since the last repaint. Call this in an paint event handler to
1552optimize redrawing by only redrawing those areas, which have been
1553exposed.</p>
1554</dd></dl>
1555
1556<dl class="method">
1557<dt id="sans.guiframe.aboutbox.DialogAbout.IsExposedRect">
1558<tt class="descname">IsExposedRect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsExposedRect" title="Permalink to this definition">¶</a></dt>
1559<dd><p>IsExposedRect(self, Rect rect) -&gt; bool</p>
1560<p>Returns true if the given point or rectangle area has been exposed
1561since the last repaint. Call this in an paint event handler to
1562optimize redrawing by only redrawing those areas, which have been
1563exposed.</p>
1564</dd></dl>
1565
1566<dl class="method">
1567<dt id="sans.guiframe.aboutbox.DialogAbout.IsFrozen">
1568<tt class="descname">IsFrozen</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsFrozen" title="Permalink to this definition">¶</a></dt>
1569<dd><p>IsFrozen(self) -&gt; bool</p>
1570<p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the window has been frozen and not thawed yet.</p>
1571<table class="docutils field-list" frame="void" rules="none">
1572<col class="field-name" />
1573<col class="field-body" />
1574<tbody valign="top">
1575<tr class="field"><th class="field-name">See :</th><td class="field-body"><cite>Freeze</cite> and <cite>Thaw</cite></td>
1576</tr>
1577</tbody>
1578</table>
1579</dd></dl>
1580
1581<dl class="method">
1582<dt id="sans.guiframe.aboutbox.DialogAbout.IsFullScreen">
1583<tt class="descname">IsFullScreen</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsFullScreen" title="Permalink to this definition">¶</a></dt>
1584<dd><p>IsFullScreen(self) -&gt; bool</p>
1585</dd></dl>
1586
1587<dl class="method">
1588<dt id="sans.guiframe.aboutbox.DialogAbout.IsIconized">
1589<tt class="descname">IsIconized</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsIconized" title="Permalink to this definition">¶</a></dt>
1590<dd><p>IsIconized(self) -&gt; bool</p>
1591</dd></dl>
1592
1593<dl class="method">
1594<dt id="sans.guiframe.aboutbox.DialogAbout.IsMaximized">
1595<tt class="descname">IsMaximized</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsMaximized" title="Permalink to this definition">¶</a></dt>
1596<dd><p>IsMaximized(self) -&gt; bool</p>
1597</dd></dl>
1598
1599<dl class="method">
1600<dt id="sans.guiframe.aboutbox.DialogAbout.IsModal">
1601<tt class="descname">IsModal</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsModal" title="Permalink to this definition">¶</a></dt>
1602<dd><p>IsModal(self) -&gt; bool</p>
1603</dd></dl>
1604
1605<dl class="method">
1606<dt id="sans.guiframe.aboutbox.DialogAbout.IsRetained">
1607<tt class="descname">IsRetained</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsRetained" title="Permalink to this definition">¶</a></dt>
1608<dd><p>IsRetained(self) -&gt; bool</p>
1609<p>Returns true if the window is retained, false otherwise.  Retained
1610windows are only available on X platforms.</p>
1611</dd></dl>
1612
1613<dl class="method">
1614<dt id="sans.guiframe.aboutbox.DialogAbout.IsSameAs">
1615<tt class="descname">IsSameAs</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsSameAs" title="Permalink to this definition">¶</a></dt>
1616<dd><p>IsSameAs(self, Object p) -&gt; bool</p>
1617<p>For wx.Objects that use C++ reference counting internally, this method
1618can be used to determine if two objects are referencing the same data
1619object.</p>
1620</dd></dl>
1621
1622<dl class="method">
1623<dt id="sans.guiframe.aboutbox.DialogAbout.IsShown">
1624<tt class="descname">IsShown</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsShown" title="Permalink to this definition">¶</a></dt>
1625<dd><p>IsShown(self) -&gt; bool</p>
1626<p>Returns true if the window is shown, false if it has been hidden.</p>
1627</dd></dl>
1628
1629<dl class="method">
1630<dt id="sans.guiframe.aboutbox.DialogAbout.IsShownOnScreen">
1631<tt class="descname">IsShownOnScreen</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsShownOnScreen" title="Permalink to this definition">¶</a></dt>
1632<dd><p>IsShownOnScreen(self) -&gt; bool</p>
1633<p>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the window is physically visible on the screen,
1634i.e. it is shown and all its parents up to the toplevel window are
1635shown as well.</p>
1636</dd></dl>
1637
1638<dl class="method">
1639<dt id="sans.guiframe.aboutbox.DialogAbout.IsTopLevel">
1640<tt class="descname">IsTopLevel</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.IsTopLevel" title="Permalink to this definition">¶</a></dt>
1641<dd><p>IsTopLevel(self) -&gt; bool</p>
1642<p>Returns true if the given window is a top-level one. Currently all
1643frames and dialogs are always considered to be top-level windows (even
1644if they have a parent window).</p>
1645</dd></dl>
1646
1647<dl class="attribute">
1648<dt id="sans.guiframe.aboutbox.DialogAbout.Label">
1649<tt class="descname">Label</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Label" title="Permalink to this definition">¶</a></dt>
1650<dd><p>See <cite>GetLabel</cite> and <cite>SetLabel</cite></p>
1651</dd></dl>
1652
1653<dl class="method">
1654<dt id="sans.guiframe.aboutbox.DialogAbout.Layout">
1655<tt class="descname">Layout</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Layout" title="Permalink to this definition">¶</a></dt>
1656<dd><p>Layout(self) -&gt; bool</p>
1657<p>Invokes the constraint-based layout algorithm or the sizer-based
1658algorithm for this window.  See SetAutoLayout: when auto layout is on,
1659this function gets called automatically by the default EVT_SIZE
1660handler when the window is resized.</p>
1661</dd></dl>
1662
1663<dl class="attribute">
1664<dt id="sans.guiframe.aboutbox.DialogAbout.LayoutDirection">
1665<tt class="descname">LayoutDirection</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.LayoutDirection" title="Permalink to this definition">¶</a></dt>
1666<dd><p>See <cite>GetLayoutDirection</cite> and <cite>SetLayoutDirection</cite></p>
1667</dd></dl>
1668
1669<dl class="method">
1670<dt id="sans.guiframe.aboutbox.DialogAbout.LineDown">
1671<tt class="descname">LineDown</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.LineDown" title="Permalink to this definition">¶</a></dt>
1672<dd><p>LineDown(self) -&gt; bool</p>
1673<p>This is just a wrapper for ScrollLines(1).</p>
1674</dd></dl>
1675
1676<dl class="method">
1677<dt id="sans.guiframe.aboutbox.DialogAbout.LineUp">
1678<tt class="descname">LineUp</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.LineUp" title="Permalink to this definition">¶</a></dt>
1679<dd><p>LineUp(self) -&gt; bool</p>
1680<p>This is just a wrapper for ScrollLines(-1).</p>
1681</dd></dl>
1682
1683<dl class="method">
1684<dt id="sans.guiframe.aboutbox.DialogAbout.Lower">
1685<tt class="descname">Lower</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Lower" title="Permalink to this definition">¶</a></dt>
1686<dd><p>Lower(self)</p>
1687<p>Lowers the window to the bottom of the window hierarchy.  In current
1688version of wxWidgets this works both for managed and child windows.</p>
1689</dd></dl>
1690
1691<dl class="method">
1692<dt id="sans.guiframe.aboutbox.DialogAbout.MacGetMetalAppearance">
1693<tt class="descname">MacGetMetalAppearance</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MacGetMetalAppearance" title="Permalink to this definition">¶</a></dt>
1694<dd><p>MacGetMetalAppearance(self) -&gt; bool</p>
1695</dd></dl>
1696
1697<dl class="method">
1698<dt id="sans.guiframe.aboutbox.DialogAbout.MacGetTopLevelWindowRef">
1699<tt class="descname">MacGetTopLevelWindowRef</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MacGetTopLevelWindowRef" title="Permalink to this definition">¶</a></dt>
1700<dd><p>MacGetTopLevelWindowRef(self) -&gt; long</p>
1701</dd></dl>
1702
1703<dl class="method">
1704<dt id="sans.guiframe.aboutbox.DialogAbout.MacGetUnifiedAppearance">
1705<tt class="descname">MacGetUnifiedAppearance</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MacGetUnifiedAppearance" title="Permalink to this definition">¶</a></dt>
1706<dd><p>MacGetUnifiedAppearance(self) -&gt; bool</p>
1707</dd></dl>
1708
1709<dl class="method">
1710<dt id="sans.guiframe.aboutbox.DialogAbout.MacSetMetalAppearance">
1711<tt class="descname">MacSetMetalAppearance</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MacSetMetalAppearance" title="Permalink to this definition">¶</a></dt>
1712<dd><p>MacSetMetalAppearance(self, bool on)</p>
1713</dd></dl>
1714
1715<dl class="method">
1716<dt id="sans.guiframe.aboutbox.DialogAbout.MakeModal">
1717<tt class="descname">MakeModal</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MakeModal" title="Permalink to this definition">¶</a></dt>
1718<dd><p>MakeModal(self, bool modal=True)</p>
1719<p>Disables all other windows in the application so that the user can
1720only interact with this window.  Passing False will reverse this
1721effect.</p>
1722</dd></dl>
1723
1724<dl class="attribute">
1725<dt id="sans.guiframe.aboutbox.DialogAbout.MaxHeight">
1726<tt class="descname">MaxHeight</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MaxHeight" title="Permalink to this definition">¶</a></dt>
1727<dd><p>See <cite>GetMaxHeight</cite></p>
1728</dd></dl>
1729
1730<dl class="attribute">
1731<dt id="sans.guiframe.aboutbox.DialogAbout.MaxSize">
1732<tt class="descname">MaxSize</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MaxSize" title="Permalink to this definition">¶</a></dt>
1733<dd><p>See <cite>GetMaxSize</cite> and <cite>SetMaxSize</cite></p>
1734</dd></dl>
1735
1736<dl class="attribute">
1737<dt id="sans.guiframe.aboutbox.DialogAbout.MaxWidth">
1738<tt class="descname">MaxWidth</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MaxWidth" title="Permalink to this definition">¶</a></dt>
1739<dd><p>See <cite>GetMaxWidth</cite></p>
1740</dd></dl>
1741
1742<dl class="method">
1743<dt id="sans.guiframe.aboutbox.DialogAbout.Maximize">
1744<tt class="descname">Maximize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Maximize" title="Permalink to this definition">¶</a></dt>
1745<dd><p>Maximize(self, bool maximize=True)</p>
1746</dd></dl>
1747
1748<dl class="attribute">
1749<dt id="sans.guiframe.aboutbox.DialogAbout.MinHeight">
1750<tt class="descname">MinHeight</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MinHeight" title="Permalink to this definition">¶</a></dt>
1751<dd><p>See <cite>GetMinHeight</cite></p>
1752</dd></dl>
1753
1754<dl class="attribute">
1755<dt id="sans.guiframe.aboutbox.DialogAbout.MinSize">
1756<tt class="descname">MinSize</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MinSize" title="Permalink to this definition">¶</a></dt>
1757<dd><p>See <cite>GetMinSize</cite> and <cite>SetMinSize</cite></p>
1758</dd></dl>
1759
1760<dl class="attribute">
1761<dt id="sans.guiframe.aboutbox.DialogAbout.MinWidth">
1762<tt class="descname">MinWidth</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MinWidth" title="Permalink to this definition">¶</a></dt>
1763<dd><p>See <cite>GetMinWidth</cite></p>
1764</dd></dl>
1765
1766<dl class="method">
1767<dt id="sans.guiframe.aboutbox.DialogAbout.Move">
1768<tt class="descname">Move</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Move" title="Permalink to this definition">¶</a></dt>
1769<dd><p>Move(self, Point pt, int flags=SIZE_USE_EXISTING)</p>
1770<p>Moves the window to the given position.</p>
1771</dd></dl>
1772
1773<dl class="method">
1774<dt id="sans.guiframe.aboutbox.DialogAbout.MoveAfterInTabOrder">
1775<tt class="descname">MoveAfterInTabOrder</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MoveAfterInTabOrder" title="Permalink to this definition">¶</a></dt>
1776<dd><p>MoveAfterInTabOrder(self, Window win)</p>
1777<p>Moves this window in the tab navigation order after the specified
1778sibling window.  This means that when the user presses the TAB key on
1779that other window, the focus switches to this window.</p>
1780<p>The default tab order is the same as creation order.  This function
1781and <cite>MoveBeforeInTabOrder</cite> allow to change it after creating all the
1782windows.</p>
1783</dd></dl>
1784
1785<dl class="method">
1786<dt id="sans.guiframe.aboutbox.DialogAbout.MoveBeforeInTabOrder">
1787<tt class="descname">MoveBeforeInTabOrder</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MoveBeforeInTabOrder" title="Permalink to this definition">¶</a></dt>
1788<dd><p>MoveBeforeInTabOrder(self, Window win)</p>
1789<p>Same as <cite>MoveAfterInTabOrder</cite> except that it inserts this window just
1790before win instead of putting it right after it.</p>
1791</dd></dl>
1792
1793<dl class="method">
1794<dt id="sans.guiframe.aboutbox.DialogAbout.MoveXY">
1795<tt class="descname">MoveXY</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.MoveXY" title="Permalink to this definition">¶</a></dt>
1796<dd><p>MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)</p>
1797<p>Moves the window to the given position.</p>
1798</dd></dl>
1799
1800<dl class="attribute">
1801<dt id="sans.guiframe.aboutbox.DialogAbout.Name">
1802<tt class="descname">Name</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Name" title="Permalink to this definition">¶</a></dt>
1803<dd><p>See <cite>GetName</cite> and <cite>SetName</cite></p>
1804</dd></dl>
1805
1806<dl class="method">
1807<dt id="sans.guiframe.aboutbox.DialogAbout.Navigate">
1808<tt class="descname">Navigate</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Navigate" title="Permalink to this definition">¶</a></dt>
1809<dd><p>Navigate(self, int flags=NavigationKeyEvent.IsForward) -&gt; bool</p>
1810<p>Does keyboard navigation from this window to another, by sending a
1811<cite>wx.NavigationKeyEvent</cite>.</p>
1812</dd></dl>
1813
1814<dl class="staticmethod">
1815<dt id="sans.guiframe.aboutbox.DialogAbout.NewControlId">
1816<em class="property">static </em><tt class="descname">NewControlId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.NewControlId" title="Permalink to this definition">¶</a></dt>
1817<dd><p>NewControlId() -&gt; int</p>
1818<p>Generate a control id for the controls which were not given one.</p>
1819</dd></dl>
1820
1821<dl class="staticmethod">
1822<dt id="sans.guiframe.aboutbox.DialogAbout.NextControlId">
1823<em class="property">static </em><tt class="descname">NextControlId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.NextControlId" title="Permalink to this definition">¶</a></dt>
1824<dd><p>NextControlId(int winid) -&gt; int</p>
1825<p>Get the id of the control following the one with the given
1826autogenerated) id</p>
1827</dd></dl>
1828
1829<dl class="attribute">
1830<dt id="sans.guiframe.aboutbox.DialogAbout.NextHandler">
1831<tt class="descname">NextHandler</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.NextHandler" title="Permalink to this definition">¶</a></dt>
1832<dd><p>See <cite>GetNextHandler</cite> and <cite>SetNextHandler</cite></p>
1833</dd></dl>
1834
1835<dl class="method">
1836<dt id="sans.guiframe.aboutbox.DialogAbout.OnPaint">
1837<tt class="descname">OnPaint</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.OnPaint" title="Permalink to this definition">¶</a></dt>
1838<dd><p>OnPaint(self, PaintEvent event)</p>
1839</dd></dl>
1840
1841<dl class="method">
1842<dt id="sans.guiframe.aboutbox.DialogAbout.PageDown">
1843<tt class="descname">PageDown</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PageDown" title="Permalink to this definition">¶</a></dt>
1844<dd><p>PageDown(self) -&gt; bool</p>
1845<p>This is just a wrapper for ScrollPages(1).</p>
1846</dd></dl>
1847
1848<dl class="method">
1849<dt id="sans.guiframe.aboutbox.DialogAbout.PageUp">
1850<tt class="descname">PageUp</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PageUp" title="Permalink to this definition">¶</a></dt>
1851<dd><p>PageUp(self) -&gt; bool</p>
1852<p>This is just a wrapper for ScrollPages(-1).</p>
1853</dd></dl>
1854
1855<dl class="attribute">
1856<dt id="sans.guiframe.aboutbox.DialogAbout.Parent">
1857<tt class="descname">Parent</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Parent" title="Permalink to this definition">¶</a></dt>
1858<dd><p>See <cite>GetParent</cite></p>
1859</dd></dl>
1860
1861<dl class="method">
1862<dt id="sans.guiframe.aboutbox.DialogAbout.PopEventHandler">
1863<tt class="descname">PopEventHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PopEventHandler" title="Permalink to this definition">¶</a></dt>
1864<dd><p>PopEventHandler(self, bool deleteHandler=False) -&gt; EvtHandler</p>
1865<p>Removes and returns the top-most event handler on the event handler
1866stack.  If deleteHandler is True then the wx.EvtHandler object will be
1867destroyed after it is popped, and <tt class="xref docutils literal"><span class="pre">None</span></tt> will be returned instead.</p>
1868</dd></dl>
1869
1870<dl class="method">
1871<dt id="sans.guiframe.aboutbox.DialogAbout.PopupMenu">
1872<tt class="descname">PopupMenu</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PopupMenu" title="Permalink to this definition">¶</a></dt>
1873<dd><p>PopupMenu(self, Menu menu, Point pos=DefaultPosition) -&gt; bool</p>
1874<p>Pops up the given menu at the specified coordinates, relative to this window,
1875and returns control when the user has dismissed the menu. If a menu item is
1876selected, the corresponding menu event is generated and will be processed as
1877usual.  If the default position is given then the current position of the
1878mouse cursor will be used.</p>
1879</dd></dl>
1880
1881<dl class="method">
1882<dt id="sans.guiframe.aboutbox.DialogAbout.PopupMenuXY">
1883<tt class="descname">PopupMenuXY</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PopupMenuXY" title="Permalink to this definition">¶</a></dt>
1884<dd><p>PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -&gt; bool</p>
1885<p>Pops up the given menu at the specified coordinates, relative to this window,
1886and returns control when the user has dismissed the menu. If a menu item is
1887selected, the corresponding menu event is generated and will be processed as
1888usual.  If the default position is given then the current position of the
1889mouse cursor will be used.</p>
1890</dd></dl>
1891
1892<dl class="attribute">
1893<dt id="sans.guiframe.aboutbox.DialogAbout.Position">
1894<tt class="descname">Position</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Position" title="Permalink to this definition">¶</a></dt>
1895<dd><p>See <cite>GetPosition</cite> and <cite>SetPosition</cite></p>
1896</dd></dl>
1897
1898<dl class="method">
1899<dt id="sans.guiframe.aboutbox.DialogAbout.PostCreate">
1900<tt class="descname">PostCreate</tt><big>(</big><em>pre</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PostCreate" title="Permalink to this definition">¶</a></dt>
1901<dd><p>Phase 3 of the 2-phase create &lt;wink!&gt;
1902Call this method after precreating the window with the 2-phase create method.</p>
1903</dd></dl>
1904
1905<dl class="method">
1906<dt id="sans.guiframe.aboutbox.DialogAbout.PrepareDC">
1907<tt class="descname">PrepareDC</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PrepareDC" title="Permalink to this definition">¶</a></dt>
1908<dd><p>PrepareDC(self, DC dc)</p>
1909<p>Call this function to prepare the device context for drawing a
1910scrolled image. It sets the device origin according to the current
1911scroll position.</p>
1912</dd></dl>
1913
1914<dl class="staticmethod">
1915<dt id="sans.guiframe.aboutbox.DialogAbout.PrevControlId">
1916<em class="property">static </em><tt class="descname">PrevControlId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PrevControlId" title="Permalink to this definition">¶</a></dt>
1917<dd><p>PrevControlId(int winid) -&gt; int</p>
1918<p>Get the id of the control preceding the one with the given
1919autogenerated) id</p>
1920</dd></dl>
1921
1922<dl class="attribute">
1923<dt id="sans.guiframe.aboutbox.DialogAbout.PreviousHandler">
1924<tt class="descname">PreviousHandler</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PreviousHandler" title="Permalink to this definition">¶</a></dt>
1925<dd><p>See <cite>GetPreviousHandler</cite> and <cite>SetPreviousHandler</cite></p>
1926</dd></dl>
1927
1928<dl class="method">
1929<dt id="sans.guiframe.aboutbox.DialogAbout.ProcessEvent">
1930<tt class="descname">ProcessEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ProcessEvent" title="Permalink to this definition">¶</a></dt>
1931<dd><p>ProcessEvent(self, Event event) -&gt; bool</p>
1932</dd></dl>
1933
1934<dl class="method">
1935<dt id="sans.guiframe.aboutbox.DialogAbout.ProcessPendingEvents">
1936<tt class="descname">ProcessPendingEvents</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ProcessPendingEvents" title="Permalink to this definition">¶</a></dt>
1937<dd><p>ProcessPendingEvents(self)</p>
1938</dd></dl>
1939
1940<dl class="method">
1941<dt id="sans.guiframe.aboutbox.DialogAbout.PushEventHandler">
1942<tt class="descname">PushEventHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.PushEventHandler" title="Permalink to this definition">¶</a></dt>
1943<dd><p>PushEventHandler(self, EvtHandler handler)</p>
1944<p>Pushes this event handler onto the event handler stack for the window.
1945An event handler is an object that is capable of processing the events
1946sent to a window.  (In other words, is able to dispatch the events to a
1947handler function.)  By default, the window is its own event handler,
1948but an application may wish to substitute another, for example to
1949allow central implementation of event-handling for a variety of
1950different window classes.</p>
1951<p>wx.Window.PushEventHandler allows an application to set up a chain of
1952event handlers, where an event not handled by one event handler is
1953handed to the next one in the chain.  Use <cite>wx.Window.PopEventHandler</cite>
1954to remove the event handler.  Ownership of the handler is <em>not</em> given
1955to the window, so you should be sure to pop the handler before the
1956window is destroyed and either let PopEventHandler destroy it, or call
1957its Destroy method yourself.</p>
1958</dd></dl>
1959
1960<dl class="method">
1961<dt id="sans.guiframe.aboutbox.DialogAbout.Raise">
1962<tt class="descname">Raise</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Raise" title="Permalink to this definition">¶</a></dt>
1963<dd><p>Raise(self)</p>
1964<p>Raises the window to the top of the window hierarchy.  In current
1965version of wxWidgets this works both for managed and child windows.</p>
1966</dd></dl>
1967
1968<dl class="attribute">
1969<dt id="sans.guiframe.aboutbox.DialogAbout.Rect">
1970<tt class="descname">Rect</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Rect" title="Permalink to this definition">¶</a></dt>
1971<dd><p>See <cite>GetRect</cite> and <cite>SetRect</cite></p>
1972</dd></dl>
1973
1974<dl class="method">
1975<dt id="sans.guiframe.aboutbox.DialogAbout.Refresh">
1976<tt class="descname">Refresh</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Refresh" title="Permalink to this definition">¶</a></dt>
1977<dd><p>Refresh(self, bool eraseBackground=True, Rect rect=None)</p>
1978<p>Mark the specified rectangle (or the whole window) as &#8220;dirty&#8221; so it
1979will be repainted.  Causes an EVT_PAINT event to be generated and sent
1980to the window.</p>
1981</dd></dl>
1982
1983<dl class="method">
1984<dt id="sans.guiframe.aboutbox.DialogAbout.RefreshRect">
1985<tt class="descname">RefreshRect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.RefreshRect" title="Permalink to this definition">¶</a></dt>
1986<dd><p>RefreshRect(self, Rect rect, bool eraseBackground=True)</p>
1987<p>Redraws the contents of the given rectangle: the area inside it will
1988be repainted.  This is the same as Refresh but has a nicer syntax.</p>
1989</dd></dl>
1990
1991<dl class="method">
1992<dt id="sans.guiframe.aboutbox.DialogAbout.RegisterHotKey">
1993<tt class="descname">RegisterHotKey</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.RegisterHotKey" title="Permalink to this definition">¶</a></dt>
1994<dd><p>RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -&gt; bool</p>
1995<p>Registers a system wide hotkey. Every time the user presses the hotkey
1996registered here, this window will receive a hotkey event. It will
1997receive the event even if the application is in the background and
1998does not have the input focus because the user is working with some
1999other application.  To bind an event handler function to this hotkey
2000use EVT_HOTKEY with an id equal to hotkeyId.  Returns True if the
2001hotkey was registered successfully.</p>
2002</dd></dl>
2003
2004<dl class="method">
2005<dt id="sans.guiframe.aboutbox.DialogAbout.ReleaseMouse">
2006<tt class="descname">ReleaseMouse</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ReleaseMouse" title="Permalink to this definition">¶</a></dt>
2007<dd><p>ReleaseMouse(self)</p>
2008<p>Releases mouse input captured with wx.Window.CaptureMouse.</p>
2009</dd></dl>
2010
2011<dl class="method">
2012<dt id="sans.guiframe.aboutbox.DialogAbout.RemoveChild">
2013<tt class="descname">RemoveChild</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.RemoveChild" title="Permalink to this definition">¶</a></dt>
2014<dd><p>RemoveChild(self, Window child)</p>
2015<p>Removes a child window. This is called automatically by window
2016deletion functions so should not be required by the application
2017programmer.</p>
2018</dd></dl>
2019
2020<dl class="method">
2021<dt id="sans.guiframe.aboutbox.DialogAbout.RemoveEventHandler">
2022<tt class="descname">RemoveEventHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.RemoveEventHandler" title="Permalink to this definition">¶</a></dt>
2023<dd><p>RemoveEventHandler(self, EvtHandler handler) -&gt; bool</p>
2024<p>Find the given handler in the event handler chain and remove (but not
2025delete) it from the event handler chain, returns True if it was found
2026and False otherwise (this also results in an assert failure so this
2027function should only be called when the handler is supposed to be
2028there.)</p>
2029</dd></dl>
2030
2031<dl class="method">
2032<dt id="sans.guiframe.aboutbox.DialogAbout.Reparent">
2033<tt class="descname">Reparent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Reparent" title="Permalink to this definition">¶</a></dt>
2034<dd><p>Reparent(self, Window newParent) -&gt; bool</p>
2035<p>Reparents the window, i.e the window will be removed from its current
2036parent window (e.g. a non-standard toolbar in a wxFrame) and then
2037re-inserted into another. Available on Windows and GTK.  Returns True
2038if the parent was changed, False otherwise (error or newParent ==
2039oldParent)</p>
2040</dd></dl>
2041
2042<dl class="method">
2043<dt id="sans.guiframe.aboutbox.DialogAbout.RequestUserAttention">
2044<tt class="descname">RequestUserAttention</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.RequestUserAttention" title="Permalink to this definition">¶</a></dt>
2045<dd><p>RequestUserAttention(self, int flags=USER_ATTENTION_INFO)</p>
2046</dd></dl>
2047
2048<dl class="method">
2049<dt id="sans.guiframe.aboutbox.DialogAbout.Restore">
2050<tt class="descname">Restore</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Restore" title="Permalink to this definition">¶</a></dt>
2051<dd><p>Restore(self)</p>
2052</dd></dl>
2053
2054<dl class="attribute">
2055<dt id="sans.guiframe.aboutbox.DialogAbout.ReturnCode">
2056<tt class="descname">ReturnCode</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ReturnCode" title="Permalink to this definition">¶</a></dt>
2057<dd><p>See <cite>GetReturnCode</cite> and <cite>SetReturnCode</cite></p>
2058</dd></dl>
2059
2060<dl class="attribute">
2061<dt id="sans.guiframe.aboutbox.DialogAbout.ScreenPosition">
2062<tt class="descname">ScreenPosition</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ScreenPosition" title="Permalink to this definition">¶</a></dt>
2063<dd><p>See <cite>GetScreenPosition</cite></p>
2064</dd></dl>
2065
2066<dl class="attribute">
2067<dt id="sans.guiframe.aboutbox.DialogAbout.ScreenRect">
2068<tt class="descname">ScreenRect</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ScreenRect" title="Permalink to this definition">¶</a></dt>
2069<dd><p>See <cite>GetScreenRect</cite></p>
2070</dd></dl>
2071
2072<dl class="method">
2073<dt id="sans.guiframe.aboutbox.DialogAbout.ScreenToClient">
2074<tt class="descname">ScreenToClient</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ScreenToClient" title="Permalink to this definition">¶</a></dt>
2075<dd><p>ScreenToClient(self, Point pt) -&gt; Point</p>
2076<p>Converts from screen to client window coordinates.</p>
2077</dd></dl>
2078
2079<dl class="method">
2080<dt id="sans.guiframe.aboutbox.DialogAbout.ScreenToClientXY">
2081<tt class="descname">ScreenToClientXY</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ScreenToClientXY" title="Permalink to this definition">¶</a></dt>
2082<dd><p>ScreenToClientXY(int x, int y) -&gt; (x,y)</p>
2083<p>Converts from screen to client window coordinates.</p>
2084</dd></dl>
2085
2086<dl class="method">
2087<dt id="sans.guiframe.aboutbox.DialogAbout.ScrollLines">
2088<tt class="descname">ScrollLines</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ScrollLines" title="Permalink to this definition">¶</a></dt>
2089<dd><p>ScrollLines(self, int lines) -&gt; bool</p>
2090<p>If the platform and window class supports it, scrolls the window by
2091the given number of lines down, if lines is positive, or up if lines
2092is negative.  Returns True if the window was scrolled, False if it was
2093already on top/bottom and nothing was done.</p>
2094</dd></dl>
2095
2096<dl class="method">
2097<dt id="sans.guiframe.aboutbox.DialogAbout.ScrollPages">
2098<tt class="descname">ScrollPages</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ScrollPages" title="Permalink to this definition">¶</a></dt>
2099<dd><p>ScrollPages(self, int pages) -&gt; bool</p>
2100<p>If the platform and window class supports it, scrolls the window by
2101the given number of pages down, if pages is positive, or up if pages
2102is negative.  Returns True if the window was scrolled, False if it was
2103already on top/bottom and nothing was done.</p>
2104</dd></dl>
2105
2106<dl class="method">
2107<dt id="sans.guiframe.aboutbox.DialogAbout.ScrollWindow">
2108<tt class="descname">ScrollWindow</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ScrollWindow" title="Permalink to this definition">¶</a></dt>
2109<dd><p>ScrollWindow(self, int dx, int dy, Rect rect=None)</p>
2110<p>Physically scrolls the pixels in the window and move child windows
2111accordingly.  Use this function to optimise your scrolling
2112implementations, to minimise the area that must be redrawn. Note that
2113it is rarely required to call this function from a user program.</p>
2114</dd></dl>
2115
2116<dl class="method">
2117<dt id="sans.guiframe.aboutbox.DialogAbout.SendSizeEvent">
2118<tt class="descname">SendSizeEvent</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SendSizeEvent" title="Permalink to this definition">¶</a></dt>
2119<dd></dd></dl>
2120
2121<dl class="method">
2122<dt id="sans.guiframe.aboutbox.DialogAbout.SetAcceleratorTable">
2123<tt class="descname">SetAcceleratorTable</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetAcceleratorTable" title="Permalink to this definition">¶</a></dt>
2124<dd><p>SetAcceleratorTable(self, AcceleratorTable accel)</p>
2125<p>Sets the accelerator table for this window.</p>
2126</dd></dl>
2127
2128<dl class="method">
2129<dt id="sans.guiframe.aboutbox.DialogAbout.SetAffirmativeId">
2130<tt class="descname">SetAffirmativeId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetAffirmativeId" title="Permalink to this definition">¶</a></dt>
2131<dd><p>SetAffirmativeId(self, int affirmativeId)</p>
2132</dd></dl>
2133
2134<dl class="method">
2135<dt id="sans.guiframe.aboutbox.DialogAbout.SetAutoLayout">
2136<tt class="descname">SetAutoLayout</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetAutoLayout" title="Permalink to this definition">¶</a></dt>
2137<dd><p>SetAutoLayout(self, bool autoLayout)</p>
2138<p>Determines whether the Layout function will be called automatically
2139when the window is resized.  lease note that this only happens for the
2140windows usually used to contain children, namely <cite>wx.Panel</cite> and
2141<cite>wx.TopLevelWindow</cite> (and the classes deriving from them).</p>
2142<p>This method is called implicitly by <cite>SetSizer</cite> but if you use
2143<cite>SetConstraints</cite> you should call it manually or otherwise the window
2144layout won&#8217;t be correctly updated when its size changes.</p>
2145</dd></dl>
2146
2147<dl class="method">
2148<dt id="sans.guiframe.aboutbox.DialogAbout.SetBackgroundColour">
2149<tt class="descname">SetBackgroundColour</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetBackgroundColour" title="Permalink to this definition">¶</a></dt>
2150<dd><p>SetBackgroundColour(self, Colour colour) -&gt; bool</p>
2151<p>Sets the background colour of the window.  Returns True if the colour
2152was changed.  The background colour is usually painted by the default
2153EVT_ERASE_BACKGROUND event handler function under Windows and
2154automatically under GTK.  Using <cite>wx.NullColour</cite> will reset the window
2155to the default background colour.</p>
2156<p>Note that setting the background colour may not cause an immediate
2157refresh, so you may wish to call <cite>ClearBackground</cite> or <cite>Refresh</cite> after
2158calling this function.</p>
2159<p>Using this function will disable attempts to use themes for this
2160window, if the system supports them.  Use with care since usually the
2161themes represent the appearance chosen by the user to be used for all
2162applications on the system.</p>
2163</dd></dl>
2164
2165<dl class="method">
2166<dt id="sans.guiframe.aboutbox.DialogAbout.SetBackgroundStyle">
2167<tt class="descname">SetBackgroundStyle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetBackgroundStyle" title="Permalink to this definition">¶</a></dt>
2168<dd><p>SetBackgroundStyle(self, int style) -&gt; bool</p>
2169<p>Returns the background style of the window. The background style
2170indicates how the background of the window is drawn.</p>
2171<blockquote>
2172<div><table border="1" class="docutils">
2173<colgroup>
2174<col width="35%" />
2175<col width="65%" />
2176</colgroup>
2177<tbody valign="top">
2178<tr><td>wx.BG_STYLE_SYSTEM</td>
2179<td>The background colour or pattern should
2180be determined by the system</td>
2181</tr>
2182<tr><td>wx.BG_STYLE_COLOUR</td>
2183<td>The background should be a solid colour</td>
2184</tr>
2185<tr><td>wx.BG_STYLE_CUSTOM</td>
2186<td>The background will be implemented by the
2187application.</td>
2188</tr>
2189</tbody>
2190</table>
2191</div></blockquote>
2192<p>On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
2193a custom background, such as a tiled bitmap. Currently the style has
2194no effect on other platforms.</p>
2195<table class="docutils field-list" frame="void" rules="none">
2196<col class="field-name" />
2197<col class="field-body" />
2198<tbody valign="top">
2199<tr class="field"><th class="field-name">See :</th><td class="field-body"><cite>GetBackgroundStyle</cite>, <cite>SetBackgroundColour</cite></td>
2200</tr>
2201</tbody>
2202</table>
2203</dd></dl>
2204
2205<dl class="method">
2206<dt id="sans.guiframe.aboutbox.DialogAbout.SetBestFittingSize">
2207<tt class="descname">SetBestFittingSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetBestFittingSize" title="Permalink to this definition">¶</a></dt>
2208<dd><p>Use <cite>SetInitialSize</cite></p>
2209</dd></dl>
2210
2211<dl class="method">
2212<dt id="sans.guiframe.aboutbox.DialogAbout.SetCaret">
2213<tt class="descname">SetCaret</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetCaret" title="Permalink to this definition">¶</a></dt>
2214<dd><p>SetCaret(self, Caret caret)</p>
2215<p>Sets the caret associated with the window.</p>
2216</dd></dl>
2217
2218<dl class="method">
2219<dt id="sans.guiframe.aboutbox.DialogAbout.SetClientRect">
2220<tt class="descname">SetClientRect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetClientRect" title="Permalink to this definition">¶</a></dt>
2221<dd><p>SetClientRect(self, Rect rect)</p>
2222<p>This sets the size of the window client area in pixels. Using this
2223function to size a window tends to be more device-independent than
2224wx.Window.SetSize, since the application need not worry about what
2225dimensions the border or title bar have when trying to fit the window
2226around panel items, for example.</p>
2227</dd></dl>
2228
2229<dl class="method">
2230<dt id="sans.guiframe.aboutbox.DialogAbout.SetClientSize">
2231<tt class="descname">SetClientSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetClientSize" title="Permalink to this definition">¶</a></dt>
2232<dd><p>SetClientSize(self, Size size)</p>
2233<p>This sets the size of the window client area in pixels. Using this
2234function to size a window tends to be more device-independent than
2235wx.Window.SetSize, since the application need not worry about what
2236dimensions the border or title bar have when trying to fit the window
2237around panel items, for example.</p>
2238</dd></dl>
2239
2240<dl class="method">
2241<dt id="sans.guiframe.aboutbox.DialogAbout.SetClientSizeWH">
2242<tt class="descname">SetClientSizeWH</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetClientSizeWH" title="Permalink to this definition">¶</a></dt>
2243<dd><p>SetClientSizeWH(self, int width, int height)</p>
2244<p>This sets the size of the window client area in pixels. Using this
2245function to size a window tends to be more device-independent than
2246wx.Window.SetSize, since the application need not worry about what
2247dimensions the border or title bar have when trying to fit the window
2248around panel items, for example.</p>
2249</dd></dl>
2250
2251<dl class="method">
2252<dt id="sans.guiframe.aboutbox.DialogAbout.SetConstraints">
2253<tt class="descname">SetConstraints</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetConstraints" title="Permalink to this definition">¶</a></dt>
2254<dd><p>SetConstraints(self, LayoutConstraints constraints)</p>
2255<p>Sets the window to have the given layout constraints. If an existing
2256layout constraints object is already owned by the window, it will be
2257deleted.  Pass None to disassociate and delete the window&#8217;s current
2258constraints.</p>
2259<p>You must call SetAutoLayout to tell a window to use the constraints
2260automatically in its default EVT_SIZE handler; otherwise, you must
2261handle EVT_SIZE yourself and call Layout() explicitly. When setting
2262both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
2263effect.</p>
2264</dd></dl>
2265
2266<dl class="method">
2267<dt id="sans.guiframe.aboutbox.DialogAbout.SetContainingSizer">
2268<tt class="descname">SetContainingSizer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetContainingSizer" title="Permalink to this definition">¶</a></dt>
2269<dd><p>SetContainingSizer(self, Sizer sizer)</p>
2270<p>This normally does not need to be called by application code. It is
2271called internally when a window is added to a sizer, and is used so
2272the window can remove itself from the sizer when it is destroyed.</p>
2273</dd></dl>
2274
2275<dl class="method">
2276<dt id="sans.guiframe.aboutbox.DialogAbout.SetCursor">
2277<tt class="descname">SetCursor</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetCursor" title="Permalink to this definition">¶</a></dt>
2278<dd><p>SetCursor(self, Cursor cursor) -&gt; bool</p>
2279<p>Sets the window&#8217;s cursor. Notice that the window cursor also sets it
2280for the children of the window implicitly.</p>
2281<p>The cursor may be wx.NullCursor in which case the window cursor will
2282be reset back to default.</p>
2283</dd></dl>
2284
2285<dl class="method">
2286<dt id="sans.guiframe.aboutbox.DialogAbout.SetDefaultItem">
2287<tt class="descname">SetDefaultItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetDefaultItem" title="Permalink to this definition">¶</a></dt>
2288<dd><p>SetDefaultItem(self, Window child) -&gt; Window</p>
2289<p>Set this child as default, return the old default.</p>
2290</dd></dl>
2291
2292<dl class="method">
2293<dt id="sans.guiframe.aboutbox.DialogAbout.SetDimensions">
2294<tt class="descname">SetDimensions</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetDimensions" title="Permalink to this definition">¶</a></dt>
2295<dd><p>SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</p>
2296<p>Sets the position and size of the window in pixels.  The sizeFlags
2297parameter indicates the interpretation of the other params if they are
2298equal to -1.</p>
2299<blockquote>
2300<div><table border="1" class="docutils">
2301<colgroup>
2302<col width="39%" />
2303<col width="61%" />
2304</colgroup>
2305<tbody valign="top">
2306<tr><td>wx.SIZE_AUTO</td>
2307<td>A -1 indicates that a class-specific
2308default should be used.</td>
2309</tr>
2310<tr><td>wx.SIZE_USE_EXISTING</td>
2311<td>Existing dimensions should be used if
2312-1 values are supplied.</td>
2313</tr>
2314<tr><td>wxSIZE_ALLOW_MINUS_ONE</td>
2315<td>Allow dimensions of -1 and less to be
2316interpreted as real dimensions, not
2317default values.</td>
2318</tr>
2319</tbody>
2320</table>
2321</div></blockquote>
2322</dd></dl>
2323
2324<dl class="method">
2325<dt id="sans.guiframe.aboutbox.DialogAbout.SetDoubleBuffered">
2326<tt class="descname">SetDoubleBuffered</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetDoubleBuffered" title="Permalink to this definition">¶</a></dt>
2327<dd><p>SetDoubleBuffered(self, bool on)</p>
2328<p>Put the native window into double buffered or composited mode.</p>
2329</dd></dl>
2330
2331<dl class="method">
2332<dt id="sans.guiframe.aboutbox.DialogAbout.SetDropTarget">
2333<tt class="descname">SetDropTarget</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetDropTarget" title="Permalink to this definition">¶</a></dt>
2334<dd><p>SetDropTarget(self, DropTarget dropTarget)</p>
2335<p>Associates a drop target with this window.  If the window already has
2336a drop target, it is deleted.</p>
2337</dd></dl>
2338
2339<dl class="method">
2340<dt id="sans.guiframe.aboutbox.DialogAbout.SetEscapeId">
2341<tt class="descname">SetEscapeId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetEscapeId" title="Permalink to this definition">¶</a></dt>
2342<dd><p>SetEscapeId(self, int escapeId)</p>
2343</dd></dl>
2344
2345<dl class="method">
2346<dt id="sans.guiframe.aboutbox.DialogAbout.SetEventHandler">
2347<tt class="descname">SetEventHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetEventHandler" title="Permalink to this definition">¶</a></dt>
2348<dd><p>SetEventHandler(self, EvtHandler handler)</p>
2349<p>Sets the event handler for this window.  An event handler is an object
2350that is capable of processing the events sent to a window.  (In other
2351words, is able to dispatch the events to handler function.)  By
2352default, the window is its own event handler, but an application may
2353wish to substitute another, for example to allow central
2354implementation of event-handling for a variety of different window
2355classes.</p>
2356<p>It is usually better to use <cite>wx.Window.PushEventHandler</cite> since this sets
2357up a chain of event handlers, where an event not handled by one event
2358handler is handed off to the next one in the chain.</p>
2359</dd></dl>
2360
2361<dl class="method">
2362<dt id="sans.guiframe.aboutbox.DialogAbout.SetEvtHandlerEnabled">
2363<tt class="descname">SetEvtHandlerEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt>
2364<dd><p>SetEvtHandlerEnabled(self, bool enabled)</p>
2365</dd></dl>
2366
2367<dl class="method">
2368<dt id="sans.guiframe.aboutbox.DialogAbout.SetExtraStyle">
2369<tt class="descname">SetExtraStyle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetExtraStyle" title="Permalink to this definition">¶</a></dt>
2370<dd><p>SetExtraStyle(self, long exStyle)</p>
2371<p>Sets the extra style bits for the window.  Extra styles are the less
2372often used style bits which can&#8217;t be set with the constructor or with
2373SetWindowStyleFlag()</p>
2374</dd></dl>
2375
2376<dl class="method">
2377<dt id="sans.guiframe.aboutbox.DialogAbout.SetFocus">
2378<tt class="descname">SetFocus</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetFocus" title="Permalink to this definition">¶</a></dt>
2379<dd><p>SetFocus(self)</p>
2380<p>Set&#8217;s the focus to this window, allowing it to receive keyboard input.</p>
2381</dd></dl>
2382
2383<dl class="method">
2384<dt id="sans.guiframe.aboutbox.DialogAbout.SetFocusFromKbd">
2385<tt class="descname">SetFocusFromKbd</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetFocusFromKbd" title="Permalink to this definition">¶</a></dt>
2386<dd><p>SetFocusFromKbd(self)</p>
2387<p>Set focus to this window as the result of a keyboard action.  Normally
2388only called internally.</p>
2389</dd></dl>
2390
2391<dl class="method">
2392<dt id="sans.guiframe.aboutbox.DialogAbout.SetFont">
2393<tt class="descname">SetFont</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetFont" title="Permalink to this definition">¶</a></dt>
2394<dd><p>SetFont(self, Font font) -&gt; bool</p>
2395<p>Sets the font for this window.</p>
2396</dd></dl>
2397
2398<dl class="method">
2399<dt id="sans.guiframe.aboutbox.DialogAbout.SetForegroundColour">
2400<tt class="descname">SetForegroundColour</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetForegroundColour" title="Permalink to this definition">¶</a></dt>
2401<dd><p>SetForegroundColour(self, Colour colour) -&gt; bool</p>
2402<p>Sets the foreground colour of the window.  Returns True is the colour
2403was changed.  The interpretation of foreground colour is dependent on
2404the window class; it may be the text colour or other colour, or it may
2405not be used at all.</p>
2406</dd></dl>
2407
2408<dl class="method">
2409<dt id="sans.guiframe.aboutbox.DialogAbout.SetHelpText">
2410<tt class="descname">SetHelpText</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetHelpText" title="Permalink to this definition">¶</a></dt>
2411<dd><p>SetHelpText(self, String text)</p>
2412<p>Sets the help text to be used as context-sensitive help for this
2413window.  Note that the text is actually stored by the current
2414<cite>wx.HelpProvider</cite> implementation, and not in the window object itself.</p>
2415</dd></dl>
2416
2417<dl class="method">
2418<dt id="sans.guiframe.aboutbox.DialogAbout.SetHelpTextForId">
2419<tt class="descname">SetHelpTextForId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetHelpTextForId" title="Permalink to this definition">¶</a></dt>
2420<dd><p>SetHelpTextForId(self, String text)</p>
2421<p>Associate this help text with all windows with the same id as this
2422one.</p>
2423</dd></dl>
2424
2425<dl class="method">
2426<dt id="sans.guiframe.aboutbox.DialogAbout.SetIcon">
2427<tt class="descname">SetIcon</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetIcon" title="Permalink to this definition">¶</a></dt>
2428<dd><p>SetIcon(self, Icon icon)</p>
2429</dd></dl>
2430
2431<dl class="method">
2432<dt id="sans.guiframe.aboutbox.DialogAbout.SetIcons">
2433<tt class="descname">SetIcons</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetIcons" title="Permalink to this definition">¶</a></dt>
2434<dd><p>SetIcons(self, wxIconBundle icons)</p>
2435</dd></dl>
2436
2437<dl class="method">
2438<dt id="sans.guiframe.aboutbox.DialogAbout.SetId">
2439<tt class="descname">SetId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetId" title="Permalink to this definition">¶</a></dt>
2440<dd><p>SetId(self, int winid)</p>
2441<p>Sets the identifier of the window.  Each window has an integer
2442identifier. If the application has not provided one, an identifier
2443will be generated. Normally, the identifier should be provided on
2444creation and should not be modified subsequently.</p>
2445</dd></dl>
2446
2447<dl class="method">
2448<dt id="sans.guiframe.aboutbox.DialogAbout.SetInitialSize">
2449<tt class="descname">SetInitialSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetInitialSize" title="Permalink to this definition">¶</a></dt>
2450<dd><p>SetInitialSize(self, Size size=DefaultSize)</p>
2451<p>A &#8216;Smart&#8217; SetSize that will fill in default size components with the
2452window&#8217;s <em>best size</em> values.  Also set&#8217;s the minsize for use with sizers.</p>
2453</dd></dl>
2454
2455<dl class="method">
2456<dt id="sans.guiframe.aboutbox.DialogAbout.SetLabel">
2457<tt class="descname">SetLabel</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetLabel" title="Permalink to this definition">¶</a></dt>
2458<dd><p>SetLabel(self, String label)</p>
2459<p>Set the text which the window shows in its label if applicable.</p>
2460</dd></dl>
2461
2462<dl class="method">
2463<dt id="sans.guiframe.aboutbox.DialogAbout.SetLayoutDirection">
2464<tt class="descname">SetLayoutDirection</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetLayoutDirection" title="Permalink to this definition">¶</a></dt>
2465<dd><p>SetLayoutDirection(self, int dir)</p>
2466<p>Set the layout direction (LTR or RTL) for this window.</p>
2467</dd></dl>
2468
2469<dl class="method">
2470<dt id="sans.guiframe.aboutbox.DialogAbout.SetMaxSize">
2471<tt class="descname">SetMaxSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetMaxSize" title="Permalink to this definition">¶</a></dt>
2472<dd><p>SetMaxSize(self, Size maxSize)</p>
2473<p>A more convenient method than <cite>SetSizeHints</cite> for setting just the
2474max size.</p>
2475</dd></dl>
2476
2477<dl class="method">
2478<dt id="sans.guiframe.aboutbox.DialogAbout.SetMinSize">
2479<tt class="descname">SetMinSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetMinSize" title="Permalink to this definition">¶</a></dt>
2480<dd><p>SetMinSize(self, Size minSize)</p>
2481<p>A more convenient method than <cite>SetSizeHints</cite> for setting just the
2482min size.</p>
2483</dd></dl>
2484
2485<dl class="method">
2486<dt id="sans.guiframe.aboutbox.DialogAbout.SetName">
2487<tt class="descname">SetName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetName" title="Permalink to this definition">¶</a></dt>
2488<dd><p>SetName(self, String name)</p>
2489<p>Sets the window&#8217;s name.  The window name is used for ressource setting
2490in X, it is not the same as the window title/label</p>
2491</dd></dl>
2492
2493<dl class="method">
2494<dt id="sans.guiframe.aboutbox.DialogAbout.SetNextHandler">
2495<tt class="descname">SetNextHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetNextHandler" title="Permalink to this definition">¶</a></dt>
2496<dd><p>SetNextHandler(self, EvtHandler handler)</p>
2497</dd></dl>
2498
2499<dl class="method">
2500<dt id="sans.guiframe.aboutbox.DialogAbout.SetOwnBackgroundColour">
2501<tt class="descname">SetOwnBackgroundColour</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetOwnBackgroundColour" title="Permalink to this definition">¶</a></dt>
2502<dd><p>SetOwnBackgroundColour(self, Colour colour)</p>
2503</dd></dl>
2504
2505<dl class="method">
2506<dt id="sans.guiframe.aboutbox.DialogAbout.SetOwnFont">
2507<tt class="descname">SetOwnFont</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetOwnFont" title="Permalink to this definition">¶</a></dt>
2508<dd><p>SetOwnFont(self, Font font)</p>
2509</dd></dl>
2510
2511<dl class="method">
2512<dt id="sans.guiframe.aboutbox.DialogAbout.SetOwnForegroundColour">
2513<tt class="descname">SetOwnForegroundColour</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetOwnForegroundColour" title="Permalink to this definition">¶</a></dt>
2514<dd><p>SetOwnForegroundColour(self, Colour colour)</p>
2515</dd></dl>
2516
2517<dl class="method">
2518<dt id="sans.guiframe.aboutbox.DialogAbout.SetPosition">
2519<tt class="descname">SetPosition</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetPosition" title="Permalink to this definition">¶</a></dt>
2520<dd><p>Move(self, Point pt, int flags=SIZE_USE_EXISTING)</p>
2521<p>Moves the window to the given position.</p>
2522</dd></dl>
2523
2524<dl class="method">
2525<dt id="sans.guiframe.aboutbox.DialogAbout.SetPreviousHandler">
2526<tt class="descname">SetPreviousHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetPreviousHandler" title="Permalink to this definition">¶</a></dt>
2527<dd><p>SetPreviousHandler(self, EvtHandler handler)</p>
2528</dd></dl>
2529
2530<dl class="method">
2531<dt id="sans.guiframe.aboutbox.DialogAbout.SetRect">
2532<tt class="descname">SetRect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetRect" title="Permalink to this definition">¶</a></dt>
2533<dd><p>SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)</p>
2534<p>Sets the position and size of the window in pixels using a wx.Rect.</p>
2535</dd></dl>
2536
2537<dl class="method">
2538<dt id="sans.guiframe.aboutbox.DialogAbout.SetReturnCode">
2539<tt class="descname">SetReturnCode</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetReturnCode" title="Permalink to this definition">¶</a></dt>
2540<dd><p>SetReturnCode(self, int returnCode)</p>
2541</dd></dl>
2542
2543<dl class="method">
2544<dt id="sans.guiframe.aboutbox.DialogAbout.SetScrollPos">
2545<tt class="descname">SetScrollPos</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetScrollPos" title="Permalink to this definition">¶</a></dt>
2546<dd><p>SetScrollPos(self, int orientation, int pos, bool refresh=True)</p>
2547<p>Sets the position of one of the built-in scrollbars.</p>
2548</dd></dl>
2549
2550<dl class="method">
2551<dt id="sans.guiframe.aboutbox.DialogAbout.SetScrollbar">
2552<tt class="descname">SetScrollbar</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetScrollbar" title="Permalink to this definition">¶</a></dt>
2553<dd><dl class="docutils">
2554<dt>SetScrollbar(self, int orientation, int position, int thumbSize, int range, </dt>
2555<dd>bool refresh=True)</dd>
2556</dl>
2557<p>Sets the scrollbar properties of a built-in scrollbar.</p>
2558</dd></dl>
2559
2560<dl class="method">
2561<dt id="sans.guiframe.aboutbox.DialogAbout.SetShape">
2562<tt class="descname">SetShape</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetShape" title="Permalink to this definition">¶</a></dt>
2563<dd><p>SetShape(self, Region region) -&gt; bool</p>
2564</dd></dl>
2565
2566<dl class="method">
2567<dt id="sans.guiframe.aboutbox.DialogAbout.SetSize">
2568<tt class="descname">SetSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetSize" title="Permalink to this definition">¶</a></dt>
2569<dd><p>SetSize(self, Size size)</p>
2570<p>Sets the size of the window in pixels.</p>
2571</dd></dl>
2572
2573<dl class="method">
2574<dt id="sans.guiframe.aboutbox.DialogAbout.SetSizeHints">
2575<tt class="descname">SetSizeHints</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetSizeHints" title="Permalink to this definition">¶</a></dt>
2576<dd><dl class="docutils">
2577<dt>SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, </dt>
2578<dd>int incH=-1)</dd>
2579</dl>
2580<p>Allows specification of minimum and maximum window sizes, and window
2581size increments. If a pair of values is not set (or set to -1), the
2582default values will be used.  If this function is called, the user
2583will not be able to size the window outside the given bounds (if it is
2584a top-level window.)  Sizers will also inspect the minimum window size
2585and will use that value if set when calculating layout.</p>
2586<p>The resizing increments are only significant under Motif or Xt.</p>
2587</dd></dl>
2588
2589<dl class="method">
2590<dt id="sans.guiframe.aboutbox.DialogAbout.SetSizeHintsSz">
2591<tt class="descname">SetSizeHintsSz</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetSizeHintsSz" title="Permalink to this definition">¶</a></dt>
2592<dd><p>SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)</p>
2593<p>Allows specification of minimum and maximum window sizes, and window
2594size increments. If a pair of values is not set (or set to -1), the
2595default values will be used.  If this function is called, the user
2596will not be able to size the window outside the given bounds (if it is
2597a top-level window.)  Sizers will also inspect the minimum window size
2598and will use that value if set when calculating layout.</p>
2599<p>The resizing increments are only significant under Motif or Xt.</p>
2600</dd></dl>
2601
2602<dl class="method">
2603<dt id="sans.guiframe.aboutbox.DialogAbout.SetSizeWH">
2604<tt class="descname">SetSizeWH</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetSizeWH" title="Permalink to this definition">¶</a></dt>
2605<dd><p>SetSizeWH(self, int width, int height)</p>
2606<p>Sets the size of the window in pixels.</p>
2607</dd></dl>
2608
2609<dl class="method">
2610<dt id="sans.guiframe.aboutbox.DialogAbout.SetSizer">
2611<tt class="descname">SetSizer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetSizer" title="Permalink to this definition">¶</a></dt>
2612<dd><p>SetSizer(self, Sizer sizer, bool deleteOld=True)</p>
2613<p>Sets the window to have the given layout sizer. The window will then
2614own the object, and will take care of its deletion. If an existing
2615layout sizer object is already owned by the window, it will be deleted
2616if the deleteOld parameter is true. Note that this function will also
2617call SetAutoLayout implicitly with a True parameter if the sizer is
2618non-None, and False otherwise.</p>
2619</dd></dl>
2620
2621<dl class="method">
2622<dt id="sans.guiframe.aboutbox.DialogAbout.SetSizerAndFit">
2623<tt class="descname">SetSizerAndFit</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetSizerAndFit" title="Permalink to this definition">¶</a></dt>
2624<dd><p>SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)</p>
2625<p>The same as SetSizer, except it also sets the size hints for the
2626window based on the sizer&#8217;s minimum size.</p>
2627</dd></dl>
2628
2629<dl class="method">
2630<dt id="sans.guiframe.aboutbox.DialogAbout.SetThemeEnabled">
2631<tt class="descname">SetThemeEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetThemeEnabled" title="Permalink to this definition">¶</a></dt>
2632<dd><p>SetThemeEnabled(self, bool enableTheme)</p>
2633<dl class="docutils">
2634<dt>This function tells a window if it should use the system&#8217;s &#8220;theme&#8221;</dt>
2635<dd>code to draw the windows&#8217; background instead if its own background
2636drawing code. This will only have an effect on platforms that support
2637the notion of themes in user defined windows. One such platform is
2638GTK+ where windows can have (very colourful) backgrounds defined by a
2639user&#8217;s selected theme.</dd>
2640</dl>
2641<p>Dialogs, notebook pages and the status bar have this flag set to true
2642by default so that the default look and feel is simulated best.</p>
2643</dd></dl>
2644
2645<dl class="method">
2646<dt id="sans.guiframe.aboutbox.DialogAbout.SetTitle">
2647<tt class="descname">SetTitle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetTitle" title="Permalink to this definition">¶</a></dt>
2648<dd><p>SetTitle(self, String title)</p>
2649</dd></dl>
2650
2651<dl class="method">
2652<dt id="sans.guiframe.aboutbox.DialogAbout.SetTmpDefaultItem">
2653<tt class="descname">SetTmpDefaultItem</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetTmpDefaultItem" title="Permalink to this definition">¶</a></dt>
2654<dd><p>SetTmpDefaultItem(self, Window win)</p>
2655<p>Set this child as temporary default</p>
2656</dd></dl>
2657
2658<dl class="method">
2659<dt id="sans.guiframe.aboutbox.DialogAbout.SetToolTip">
2660<tt class="descname">SetToolTip</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetToolTip" title="Permalink to this definition">¶</a></dt>
2661<dd><p>SetToolTip(self, ToolTip tip)</p>
2662<p>Attach a tooltip to the window.</p>
2663</dd></dl>
2664
2665<dl class="method">
2666<dt id="sans.guiframe.aboutbox.DialogAbout.SetToolTipString">
2667<tt class="descname">SetToolTipString</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetToolTipString" title="Permalink to this definition">¶</a></dt>
2668<dd><p>SetToolTipString(self, String tip)</p>
2669<p>Attach a tooltip to the window.</p>
2670</dd></dl>
2671
2672<dl class="method">
2673<dt id="sans.guiframe.aboutbox.DialogAbout.SetTransparent">
2674<tt class="descname">SetTransparent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetTransparent" title="Permalink to this definition">¶</a></dt>
2675<dd><p>SetTransparent(self, byte alpha) -&gt; bool</p>
2676<p>Attempt to set the transparency of this window to the <tt class="docutils literal"><span class="pre">alpha</span></tt> value,
2677returns True on success.  The <tt class="docutils literal"><span class="pre">alpha</span></tt> value is an integer in the
2678range of 0 to 255, where 0 is fully transparent and 255 is fully
2679opaque.</p>
2680</dd></dl>
2681
2682<dl class="method">
2683<dt id="sans.guiframe.aboutbox.DialogAbout.SetValidator">
2684<tt class="descname">SetValidator</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetValidator" title="Permalink to this definition">¶</a></dt>
2685<dd><p>SetValidator(self, Validator validator)</p>
2686<p>Deletes the current validator (if any) and sets the window validator,
2687having called wx.Validator.Clone to create a new validator of this
2688type.</p>
2689</dd></dl>
2690
2691<dl class="method">
2692<dt id="sans.guiframe.aboutbox.DialogAbout.SetVirtualSize">
2693<tt class="descname">SetVirtualSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetVirtualSize" title="Permalink to this definition">¶</a></dt>
2694<dd><p>SetVirtualSize(self, Size size)</p>
2695<p>Set the the virtual size of a window in pixels.  For most windows this
2696is just the client area of the window, but for some like scrolled
2697windows it is more or less independent of the screen window size.</p>
2698</dd></dl>
2699
2700<dl class="method">
2701<dt id="sans.guiframe.aboutbox.DialogAbout.SetVirtualSizeHints">
2702<tt class="descname">SetVirtualSizeHints</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetVirtualSizeHints" title="Permalink to this definition">¶</a></dt>
2703<dd><p>SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)</p>
2704<p>Allows specification of minimum and maximum virtual window sizes. If a
2705pair of values is not set (or set to -1), the default values will be
2706used.  If this function is called, the user will not be able to size
2707the virtual area of the window outside the given bounds.</p>
2708</dd></dl>
2709
2710<dl class="method">
2711<dt id="sans.guiframe.aboutbox.DialogAbout.SetVirtualSizeHintsSz">
2712<tt class="descname">SetVirtualSizeHintsSz</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetVirtualSizeHintsSz" title="Permalink to this definition">¶</a></dt>
2713<dd><p>SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)</p>
2714<p>Allows specification of minimum and maximum virtual window sizes. If a
2715pair of values is not set (or set to -1), the default values will be
2716used.  If this function is called, the user will not be able to size
2717the virtual area of the window outside the given bounds.</p>
2718</dd></dl>
2719
2720<dl class="method">
2721<dt id="sans.guiframe.aboutbox.DialogAbout.SetVirtualSizeWH">
2722<tt class="descname">SetVirtualSizeWH</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetVirtualSizeWH" title="Permalink to this definition">¶</a></dt>
2723<dd><p>SetVirtualSizeWH(self, int w, int h)</p>
2724<p>Set the the virtual size of a window in pixels.  For most windows this
2725is just the client area of the window, but for some like scrolled
2726windows it is more or less independent of the screen window size.</p>
2727</dd></dl>
2728
2729<dl class="method">
2730<dt id="sans.guiframe.aboutbox.DialogAbout.SetWindowStyle">
2731<tt class="descname">SetWindowStyle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetWindowStyle" title="Permalink to this definition">¶</a></dt>
2732<dd><p>SetWindowStyleFlag(self, long style)</p>
2733<p>Sets the style of the window. Please note that some styles cannot be
2734changed after the window creation and that Refresh() might need to be
2735called after changing the others for the change to take place
2736immediately.</p>
2737</dd></dl>
2738
2739<dl class="method">
2740<dt id="sans.guiframe.aboutbox.DialogAbout.SetWindowStyleFlag">
2741<tt class="descname">SetWindowStyleFlag</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetWindowStyleFlag" title="Permalink to this definition">¶</a></dt>
2742<dd><p>SetWindowStyleFlag(self, long style)</p>
2743<p>Sets the style of the window. Please note that some styles cannot be
2744changed after the window creation and that Refresh() might need to be
2745called after changing the others for the change to take place
2746immediately.</p>
2747</dd></dl>
2748
2749<dl class="method">
2750<dt id="sans.guiframe.aboutbox.DialogAbout.SetWindowVariant">
2751<tt class="descname">SetWindowVariant</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.SetWindowVariant" title="Permalink to this definition">¶</a></dt>
2752<dd><p>SetWindowVariant(self, int variant)</p>
2753<p>Sets the variant of the window/font size to use for this window, if
2754the platform supports variants, for example, wxMac.</p>
2755</dd></dl>
2756
2757<dl class="method">
2758<dt id="sans.guiframe.aboutbox.DialogAbout.ShouldInheritColours">
2759<tt class="descname">ShouldInheritColours</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ShouldInheritColours" title="Permalink to this definition">¶</a></dt>
2760<dd><p>ShouldInheritColours(self) -&gt; bool</p>
2761<p>Return true from here to allow the colours of this window to be
2762changed by InheritAttributes, returning false forbids inheriting them
2763from the parent window.</p>
2764<p>The base class version returns false, but this method is overridden in
2765wxControl where it returns true.</p>
2766</dd></dl>
2767
2768<dl class="method">
2769<dt id="sans.guiframe.aboutbox.DialogAbout.Show">
2770<tt class="descname">Show</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Show" title="Permalink to this definition">¶</a></dt>
2771<dd><p>Show(self, bool show=True) -&gt; bool</p>
2772<p>Shows or hides the window. You may need to call Raise for a top level
2773window if you want to bring it to top, although this is not needed if
2774Show is called immediately after the frame creation.  Returns True if
2775the window has been shown or hidden or False if nothing was done
2776because it already was in the requested state.</p>
2777</dd></dl>
2778
2779<dl class="method">
2780<dt id="sans.guiframe.aboutbox.DialogAbout.ShowFullScreen">
2781<tt class="descname">ShowFullScreen</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ShowFullScreen" title="Permalink to this definition">¶</a></dt>
2782<dd><p>ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -&gt; bool</p>
2783</dd></dl>
2784
2785<dl class="method">
2786<dt id="sans.guiframe.aboutbox.DialogAbout.ShowModal">
2787<tt class="descname">ShowModal</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ShowModal" title="Permalink to this definition">¶</a></dt>
2788<dd><p>ShowModal(self) -&gt; int</p>
2789</dd></dl>
2790
2791<dl class="attribute">
2792<dt id="sans.guiframe.aboutbox.DialogAbout.Shown">
2793<tt class="descname">Shown</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Shown" title="Permalink to this definition">¶</a></dt>
2794<dd><p>See <cite>IsShown</cite> and <cite>Show</cite></p>
2795</dd></dl>
2796
2797<dl class="attribute">
2798<dt id="sans.guiframe.aboutbox.DialogAbout.Size">
2799<tt class="descname">Size</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Size" title="Permalink to this definition">¶</a></dt>
2800<dd><p>See <cite>GetSize</cite> and <cite>SetSize</cite></p>
2801</dd></dl>
2802
2803<dl class="attribute">
2804<dt id="sans.guiframe.aboutbox.DialogAbout.Sizer">
2805<tt class="descname">Sizer</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Sizer" title="Permalink to this definition">¶</a></dt>
2806<dd><p>See <cite>GetSizer</cite> and <cite>SetSizer</cite></p>
2807</dd></dl>
2808
2809<dl class="method">
2810<dt id="sans.guiframe.aboutbox.DialogAbout.Thaw">
2811<tt class="descname">Thaw</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Thaw" title="Permalink to this definition">¶</a></dt>
2812<dd><p>Thaw(self)</p>
2813<p>Reenables window updating after a previous call to Freeze.  Calls to
2814Freeze/Thaw may be nested, so Thaw must be called the same number of
2815times that Freeze was before the window will be updated.</p>
2816</dd></dl>
2817
2818<dl class="attribute">
2819<dt id="sans.guiframe.aboutbox.DialogAbout.ThemeEnabled">
2820<tt class="descname">ThemeEnabled</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ThemeEnabled" title="Permalink to this definition">¶</a></dt>
2821<dd><p>See <cite>GetThemeEnabled</cite> and <cite>SetThemeEnabled</cite></p>
2822</dd></dl>
2823
2824<dl class="attribute">
2825<dt id="sans.guiframe.aboutbox.DialogAbout.Title">
2826<tt class="descname">Title</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Title" title="Permalink to this definition">¶</a></dt>
2827<dd><p>See <cite>GetTitle</cite> and <cite>SetTitle</cite></p>
2828</dd></dl>
2829
2830<dl class="attribute">
2831<dt id="sans.guiframe.aboutbox.DialogAbout.TmpDefaultItem">
2832<tt class="descname">TmpDefaultItem</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.TmpDefaultItem" title="Permalink to this definition">¶</a></dt>
2833<dd><p>See <cite>GetTmpDefaultItem</cite> and <cite>SetTmpDefaultItem</cite></p>
2834</dd></dl>
2835
2836<dl class="method">
2837<dt id="sans.guiframe.aboutbox.DialogAbout.ToggleWindowStyle">
2838<tt class="descname">ToggleWindowStyle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ToggleWindowStyle" title="Permalink to this definition">¶</a></dt>
2839<dd><p>ToggleWindowStyle(self, int flag) -&gt; bool</p>
2840<p>Turn the flag on if it had been turned off before and vice versa,
2841returns True if the flag is turned on by this function call.</p>
2842</dd></dl>
2843
2844<dl class="attribute">
2845<dt id="sans.guiframe.aboutbox.DialogAbout.ToolTip">
2846<tt class="descname">ToolTip</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.ToolTip" title="Permalink to this definition">¶</a></dt>
2847<dd><p>See <cite>GetToolTip</cite> and <cite>SetToolTip</cite></p>
2848</dd></dl>
2849
2850<dl class="attribute">
2851<dt id="sans.guiframe.aboutbox.DialogAbout.TopLevel">
2852<tt class="descname">TopLevel</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.TopLevel" title="Permalink to this definition">¶</a></dt>
2853<dd><p>See <cite>IsTopLevel</cite></p>
2854</dd></dl>
2855
2856<dl class="attribute">
2857<dt id="sans.guiframe.aboutbox.DialogAbout.TopLevelParent">
2858<tt class="descname">TopLevelParent</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.TopLevelParent" title="Permalink to this definition">¶</a></dt>
2859<dd><p>See <cite>GetTopLevelParent</cite></p>
2860</dd></dl>
2861
2862<dl class="method">
2863<dt id="sans.guiframe.aboutbox.DialogAbout.TransferDataFromWindow">
2864<tt class="descname">TransferDataFromWindow</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.TransferDataFromWindow" title="Permalink to this definition">¶</a></dt>
2865<dd><p>TransferDataFromWindow(self) -&gt; bool</p>
2866<p>Transfers values from child controls to data areas specified by their
2867validators. Returns false if a transfer failed.  If the window has
2868wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
2869also call TransferDataFromWindow() of all child windows.</p>
2870</dd></dl>
2871
2872<dl class="method">
2873<dt id="sans.guiframe.aboutbox.DialogAbout.TransferDataToWindow">
2874<tt class="descname">TransferDataToWindow</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.TransferDataToWindow" title="Permalink to this definition">¶</a></dt>
2875<dd><p>TransferDataToWindow(self) -&gt; bool</p>
2876<p>Transfers values to child controls from data areas specified by their
2877validators.  If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
2878style flag set, the method will also call TransferDataToWindow() of
2879all child windows.</p>
2880</dd></dl>
2881
2882<dl class="method">
2883<dt id="sans.guiframe.aboutbox.DialogAbout.Unbind">
2884<tt class="descname">Unbind</tt><big>(</big><em>event</em>, <em>source=None</em>, <em>id=-1</em>, <em>id2=-1</em>, <em>handler=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Unbind" title="Permalink to this definition">¶</a></dt>
2885<dd><p>Disconnects the event handler binding for event from self.
2886Returns True if successful.</p>
2887</dd></dl>
2888
2889<dl class="method">
2890<dt id="sans.guiframe.aboutbox.DialogAbout.UnregisterHotKey">
2891<tt class="descname">UnregisterHotKey</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.UnregisterHotKey" title="Permalink to this definition">¶</a></dt>
2892<dd><p>UnregisterHotKey(self, int hotkeyId) -&gt; bool</p>
2893<p>Unregisters a system wide hotkey.</p>
2894</dd></dl>
2895
2896<dl class="method">
2897<dt id="sans.guiframe.aboutbox.DialogAbout.Update">
2898<tt class="descname">Update</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Update" title="Permalink to this definition">¶</a></dt>
2899<dd><p>Update(self)</p>
2900<p>Calling this method immediately repaints the invalidated area of the
2901window instead of waiting for the EVT_PAINT event to happen, (normally
2902this would usually only happen when the flow of control returns to the
2903event loop.)  Notice that this function doesn&#8217;t refresh the window and
2904does nothing if the window has been already repainted.  Use <cite>Refresh</cite>
2905first if you want to immediately redraw the window (or some portion of
2906it) unconditionally.</p>
2907</dd></dl>
2908
2909<dl class="attribute">
2910<dt id="sans.guiframe.aboutbox.DialogAbout.UpdateClientRect">
2911<tt class="descname">UpdateClientRect</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.UpdateClientRect" title="Permalink to this definition">¶</a></dt>
2912<dd><p>See <cite>GetUpdateClientRect</cite></p>
2913</dd></dl>
2914
2915<dl class="attribute">
2916<dt id="sans.guiframe.aboutbox.DialogAbout.UpdateRegion">
2917<tt class="descname">UpdateRegion</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.UpdateRegion" title="Permalink to this definition">¶</a></dt>
2918<dd><p>See <cite>GetUpdateRegion</cite></p>
2919</dd></dl>
2920
2921<dl class="method">
2922<dt id="sans.guiframe.aboutbox.DialogAbout.UpdateWindowUI">
2923<tt class="descname">UpdateWindowUI</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.UpdateWindowUI" title="Permalink to this definition">¶</a></dt>
2924<dd><p>UpdateWindowUI(self, long flags=UPDATE_UI_NONE)</p>
2925<p>This function sends EVT_UPDATE_UI events to the window. The particular
2926implementation depends on the window; for example a wx.ToolBar will
2927send an update UI event for each toolbar button, and a wx.Frame will
2928send an update UI event for each menubar menu item. You can call this
2929function from your application to ensure that your UI is up-to-date at
2930a particular point in time (as far as your EVT_UPDATE_UI handlers are
2931concerned). This may be necessary if you have called
2932<cite>wx.UpdateUIEvent.SetMode</cite> or <cite>wx.UpdateUIEvent.SetUpdateInterval</cite> to
2933limit the overhead that wxWindows incurs by sending update UI events
2934in idle time.</p>
2935</dd></dl>
2936
2937<dl class="method">
2938<dt id="sans.guiframe.aboutbox.DialogAbout.UseBgCol">
2939<tt class="descname">UseBgCol</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.UseBgCol" title="Permalink to this definition">¶</a></dt>
2940<dd><p>UseBgCol(self) -&gt; bool</p>
2941</dd></dl>
2942
2943<dl class="method">
2944<dt id="sans.guiframe.aboutbox.DialogAbout.Validate">
2945<tt class="descname">Validate</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Validate" title="Permalink to this definition">¶</a></dt>
2946<dd><p>Validate(self) -&gt; bool</p>
2947<p>Validates the current values of the child controls using their
2948validators.  If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
2949style flag set, the method will also call Validate() of all child
2950windows.  Returns false if any of the validations failed.</p>
2951</dd></dl>
2952
2953<dl class="attribute">
2954<dt id="sans.guiframe.aboutbox.DialogAbout.Validator">
2955<tt class="descname">Validator</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.Validator" title="Permalink to this definition">¶</a></dt>
2956<dd><p>See <cite>GetValidator</cite> and <cite>SetValidator</cite></p>
2957</dd></dl>
2958
2959<dl class="attribute">
2960<dt id="sans.guiframe.aboutbox.DialogAbout.VirtualSize">
2961<tt class="descname">VirtualSize</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.VirtualSize" title="Permalink to this definition">¶</a></dt>
2962<dd><p>See <cite>GetVirtualSize</cite> and <cite>SetVirtualSize</cite></p>
2963</dd></dl>
2964
2965<dl class="method">
2966<dt id="sans.guiframe.aboutbox.DialogAbout.WarpPointer">
2967<tt class="descname">WarpPointer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.WarpPointer" title="Permalink to this definition">¶</a></dt>
2968<dd><p>WarpPointer(self, int x, int y)</p>
2969<p>Moves the pointer to the given position on the window.</p>
2970<p>NOTE: This function is not supported under Mac because Apple Human
2971Interface Guidelines forbid moving the mouse cursor programmatically.</p>
2972</dd></dl>
2973
2974<dl class="attribute">
2975<dt id="sans.guiframe.aboutbox.DialogAbout.WindowStyle">
2976<tt class="descname">WindowStyle</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.WindowStyle" title="Permalink to this definition">¶</a></dt>
2977<dd><p>See <cite>GetWindowStyle</cite> and <cite>SetWindowStyle</cite></p>
2978</dd></dl>
2979
2980<dl class="attribute">
2981<dt id="sans.guiframe.aboutbox.DialogAbout.WindowStyleFlag">
2982<tt class="descname">WindowStyleFlag</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.WindowStyleFlag" title="Permalink to this definition">¶</a></dt>
2983<dd><p>See <cite>GetWindowStyleFlag</cite> and <cite>SetWindowStyleFlag</cite></p>
2984</dd></dl>
2985
2986<dl class="method">
2987<dt id="sans.guiframe.aboutbox.DialogAbout.WindowToClientSize">
2988<tt class="descname">WindowToClientSize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.WindowToClientSize" title="Permalink to this definition">¶</a></dt>
2989<dd><p>WindowToClientSize(self, Size size) -&gt; Size</p>
2990</dd></dl>
2991
2992<dl class="attribute">
2993<dt id="sans.guiframe.aboutbox.DialogAbout.WindowVariant">
2994<tt class="descname">WindowVariant</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.WindowVariant" title="Permalink to this definition">¶</a></dt>
2995<dd><p>See <cite>GetWindowVariant</cite> and <cite>SetWindowVariant</cite></p>
2996</dd></dl>
2997
2998<dl class="method">
2999<dt id="sans.guiframe.aboutbox.DialogAbout.onDanseLogo">
3000<tt class="descname">onDanseLogo</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.onDanseLogo" title="Permalink to this definition">¶</a></dt>
3001<dd></dd></dl>
3002
3003<dl class="method">
3004<dt id="sans.guiframe.aboutbox.DialogAbout.onNsfLogo">
3005<tt class="descname">onNsfLogo</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.onNsfLogo" title="Permalink to this definition">¶</a></dt>
3006<dd></dd></dl>
3007
3008<dl class="method">
3009<dt id="sans.guiframe.aboutbox.DialogAbout.onUTLogo">
3010<tt class="descname">onUTLogo</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.onUTLogo" title="Permalink to this definition">¶</a></dt>
3011<dd></dd></dl>
3012
3013<dl class="attribute">
3014<dt id="sans.guiframe.aboutbox.DialogAbout.thisown">
3015<tt class="descname">thisown</tt><a class="headerlink" href="#sans.guiframe.aboutbox.DialogAbout.thisown" title="Permalink to this definition">¶</a></dt>
3016<dd><p>The membership flag</p>
3017</dd></dl>
3018
3019</dd></dl>
3020
3021<dl class="class">
3022<dt id="sans.guiframe.aboutbox.MyApp">
3023<em class="property">class </em><tt class="descclassname">sans.guiframe.aboutbox.</tt><tt class="descname">MyApp</tt><big>(</big><em>redirect=True</em>, <em>filename=None</em>, <em>useBestVisual=False</em>, <em>clearSigInt=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp" title="Permalink to this definition">¶</a></dt>
3024<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.App</span></tt></p>
3025<dl class="attribute">
3026<dt id="sans.guiframe.aboutbox.MyApp.Active">
3027<tt class="descname">Active</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Active" title="Permalink to this definition">¶</a></dt>
3028<dd><p>IsActive(self) -&gt; bool</p>
3029<p>Return True if our app has focus.</p>
3030</dd></dl>
3031
3032<dl class="method">
3033<dt id="sans.guiframe.aboutbox.MyApp.AddPendingEvent">
3034<tt class="descname">AddPendingEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.AddPendingEvent" title="Permalink to this definition">¶</a></dt>
3035<dd><p>AddPendingEvent(self, Event event)</p>
3036</dd></dl>
3037
3038<dl class="attribute">
3039<dt id="sans.guiframe.aboutbox.MyApp.AppName">
3040<tt class="descname">AppName</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.AppName" title="Permalink to this definition">¶</a></dt>
3041<dd><p>See <cite>GetAppName</cite> and <cite>SetAppName</cite></p>
3042</dd></dl>
3043
3044<dl class="attribute">
3045<dt id="sans.guiframe.aboutbox.MyApp.AssertMode">
3046<tt class="descname">AssertMode</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.AssertMode" title="Permalink to this definition">¶</a></dt>
3047<dd><p>See <cite>GetAssertMode</cite> and <cite>SetAssertMode</cite></p>
3048</dd></dl>
3049
3050<dl class="method">
3051<dt id="sans.guiframe.aboutbox.MyApp.Bind">
3052<tt class="descname">Bind</tt><big>(</big><em>event</em>, <em>handler</em>, <em>source=None</em>, <em>id=-1</em>, <em>id2=-1</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Bind" title="Permalink to this definition">¶</a></dt>
3053<dd><p>Bind an event to an event handler.</p>
3054<table class="docutils field-list" frame="void" rules="none">
3055<col class="field-name" />
3056<col class="field-body" />
3057<tbody valign="top">
3058<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
3059<li><strong>event</strong> &#8211; One of the EVT_* objects that specifies the
3060type of event to bind,</li>
3061<li><strong>handler</strong> &#8211; A callable object to be invoked when the
3062event is delivered to self.  Pass None to
3063disconnect an event handler.</li>
3064<li><strong>source</strong> &#8211; Sometimes the event originates from a
3065different window than self, but you still
3066want to catch it in self.  (For example, a
3067button event delivered to a frame.)  By
3068passing the source of the event, the event
3069handling system is able to differentiate
3070between the same event type from different
3071controls.</li>
3072<li><strong>id</strong> &#8211; Used to spcify the event source by ID instead
3073of instance.</li>
3074<li><strong>id2</strong> &#8211; Used when it is desirable to bind a handler
3075to a range of IDs, such as with EVT_MENU_RANGE.</li>
3076</ul>
3077</td>
3078</tr>
3079</tbody>
3080</table>
3081</dd></dl>
3082
3083<dl class="attribute">
3084<dt id="sans.guiframe.aboutbox.MyApp.ClassName">
3085<tt class="descname">ClassName</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.ClassName" title="Permalink to this definition">¶</a></dt>
3086<dd><p>See <cite>GetClassName</cite> and <cite>SetClassName</cite></p>
3087</dd></dl>
3088
3089<dl class="method">
3090<dt id="sans.guiframe.aboutbox.MyApp.Connect">
3091<tt class="descname">Connect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Connect" title="Permalink to this definition">¶</a></dt>
3092<dd><p>Connect(self, int id, int lastId, int eventType, PyObject func)</p>
3093</dd></dl>
3094
3095<dl class="method">
3096<dt id="sans.guiframe.aboutbox.MyApp.Destroy">
3097<tt class="descname">Destroy</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Destroy" title="Permalink to this definition">¶</a></dt>
3098<dd></dd></dl>
3099
3100<dl class="method">
3101<dt id="sans.guiframe.aboutbox.MyApp.Disconnect">
3102<tt class="descname">Disconnect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Disconnect" title="Permalink to this definition">¶</a></dt>
3103<dd><dl class="docutils">
3104<dt>Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, </dt>
3105<dd>PyObject func=None) -&gt; bool</dd>
3106</dl>
3107</dd></dl>
3108
3109<dl class="method">
3110<dt id="sans.guiframe.aboutbox.MyApp.Dispatch">
3111<tt class="descname">Dispatch</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Dispatch" title="Permalink to this definition">¶</a></dt>
3112<dd><p>Dispatch(self) -&gt; bool</p>
3113<p>Process the first event in the event queue (blocks until an event
3114appears if there are none currently)</p>
3115</dd></dl>
3116
3117<dl class="attribute">
3118<dt id="sans.guiframe.aboutbox.MyApp.EvtHandlerEnabled">
3119<tt class="descname">EvtHandlerEnabled</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.EvtHandlerEnabled" title="Permalink to this definition">¶</a></dt>
3120<dd><p>See <cite>GetEvtHandlerEnabled</cite> and <cite>SetEvtHandlerEnabled</cite></p>
3121</dd></dl>
3122
3123<dl class="method">
3124<dt id="sans.guiframe.aboutbox.MyApp.Exit">
3125<tt class="descname">Exit</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Exit" title="Permalink to this definition">¶</a></dt>
3126<dd><p>Exit(self)</p>
3127<p>Exit the main loop thus terminating the application.
3128:see: <cite>wx.Exit</cite></p>
3129</dd></dl>
3130
3131<dl class="method">
3132<dt id="sans.guiframe.aboutbox.MyApp.ExitMainLoop">
3133<tt class="descname">ExitMainLoop</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.ExitMainLoop" title="Permalink to this definition">¶</a></dt>
3134<dd><p>ExitMainLoop(self)</p>
3135<p>Exit the main GUI loop during the next iteration of the main
3136loop, (i.e. it does not stop the program immediately!)</p>
3137</dd></dl>
3138
3139<dl class="attribute">
3140<dt id="sans.guiframe.aboutbox.MyApp.ExitOnFrameDelete">
3141<tt class="descname">ExitOnFrameDelete</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.ExitOnFrameDelete" title="Permalink to this definition">¶</a></dt>
3142<dd><p>See <cite>GetExitOnFrameDelete</cite> and <cite>SetExitOnFrameDelete</cite></p>
3143</dd></dl>
3144
3145<dl class="method">
3146<dt id="sans.guiframe.aboutbox.MyApp.FilterEvent">
3147<tt class="descname">FilterEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.FilterEvent" title="Permalink to this definition">¶</a></dt>
3148<dd><p>FilterEvent(self, Event event) -&gt; int</p>
3149<p>Filters all events. <cite>SetCallFilterEvent</cite> controls whether or not your
3150override is called.</p>
3151</dd></dl>
3152
3153<dl class="method">
3154<dt id="sans.guiframe.aboutbox.MyApp.GetAppName">
3155<tt class="descname">GetAppName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetAppName" title="Permalink to this definition">¶</a></dt>
3156<dd><p>GetAppName(self) -&gt; String</p>
3157<p>Get the application name.</p>
3158</dd></dl>
3159
3160<dl class="method">
3161<dt id="sans.guiframe.aboutbox.MyApp.GetAssertMode">
3162<tt class="descname">GetAssertMode</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetAssertMode" title="Permalink to this definition">¶</a></dt>
3163<dd><p>GetAssertMode(self) -&gt; int</p>
3164<p>Get the current OnAssert behaviour setting.</p>
3165</dd></dl>
3166
3167<dl class="method">
3168<dt id="sans.guiframe.aboutbox.MyApp.GetCallFilterEvent">
3169<tt class="descname">GetCallFilterEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetCallFilterEvent" title="Permalink to this definition">¶</a></dt>
3170<dd><p>GetCallFilterEvent(self) -&gt; bool</p>
3171<p>Returns the state of the Call FilterEvent flag.</p>
3172</dd></dl>
3173
3174<dl class="method">
3175<dt id="sans.guiframe.aboutbox.MyApp.GetClassName">
3176<tt class="descname">GetClassName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetClassName" title="Permalink to this definition">¶</a></dt>
3177<dd><p>GetClassName(self) -&gt; String</p>
3178<p>Get the application&#8217;s class name.</p>
3179</dd></dl>
3180
3181<dl class="staticmethod">
3182<dt id="sans.guiframe.aboutbox.MyApp.GetComCtl32Version">
3183<em class="property">static </em><tt class="descname">GetComCtl32Version</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetComCtl32Version" title="Permalink to this definition">¶</a></dt>
3184<dd><p>GetComCtl32Version() -&gt; int</p>
3185<p>Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
3186it wasn&#8217;t found at all.  Raises an exception on non-Windows platforms.</p>
3187</dd></dl>
3188
3189<dl class="method">
3190<dt id="sans.guiframe.aboutbox.MyApp.GetEvtHandlerEnabled">
3191<tt class="descname">GetEvtHandlerEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt>
3192<dd><p>GetEvtHandlerEnabled(self) -&gt; bool</p>
3193</dd></dl>
3194
3195<dl class="method">
3196<dt id="sans.guiframe.aboutbox.MyApp.GetExitOnFrameDelete">
3197<tt class="descname">GetExitOnFrameDelete</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetExitOnFrameDelete" title="Permalink to this definition">¶</a></dt>
3198<dd><p>GetExitOnFrameDelete(self) -&gt; bool</p>
3199<p>Get the current exit behaviour setting.</p>
3200</dd></dl>
3201
3202<dl class="method">
3203<dt id="sans.guiframe.aboutbox.MyApp.GetLayoutDirection">
3204<tt class="descname">GetLayoutDirection</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetLayoutDirection" title="Permalink to this definition">¶</a></dt>
3205<dd><p>GetLayoutDirection(self) -&gt; int</p>
3206<p>Return the layout direction for the current locale.</p>
3207</dd></dl>
3208
3209<dl class="staticmethod">
3210<dt id="sans.guiframe.aboutbox.MyApp.GetMacAboutMenuItemId">
3211<em class="property">static </em><tt class="descname">GetMacAboutMenuItemId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetMacAboutMenuItemId" title="Permalink to this definition">¶</a></dt>
3212<dd><p>GetMacAboutMenuItemId() -&gt; long</p>
3213</dd></dl>
3214
3215<dl class="staticmethod">
3216<dt id="sans.guiframe.aboutbox.MyApp.GetMacExitMenuItemId">
3217<em class="property">static </em><tt class="descname">GetMacExitMenuItemId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetMacExitMenuItemId" title="Permalink to this definition">¶</a></dt>
3218<dd><p>GetMacExitMenuItemId() -&gt; long</p>
3219</dd></dl>
3220
3221<dl class="staticmethod">
3222<dt id="sans.guiframe.aboutbox.MyApp.GetMacHelpMenuTitleName">
3223<em class="property">static </em><tt class="descname">GetMacHelpMenuTitleName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetMacHelpMenuTitleName" title="Permalink to this definition">¶</a></dt>
3224<dd><p>GetMacHelpMenuTitleName() -&gt; String</p>
3225</dd></dl>
3226
3227<dl class="staticmethod">
3228<dt id="sans.guiframe.aboutbox.MyApp.GetMacPreferencesMenuItemId">
3229<em class="property">static </em><tt class="descname">GetMacPreferencesMenuItemId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetMacPreferencesMenuItemId" title="Permalink to this definition">¶</a></dt>
3230<dd><p>GetMacPreferencesMenuItemId() -&gt; long</p>
3231</dd></dl>
3232
3233<dl class="staticmethod">
3234<dt id="sans.guiframe.aboutbox.MyApp.GetMacSupportPCMenuShortcuts">
3235<em class="property">static </em><tt class="descname">GetMacSupportPCMenuShortcuts</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetMacSupportPCMenuShortcuts" title="Permalink to this definition">¶</a></dt>
3236<dd><p>GetMacSupportPCMenuShortcuts() -&gt; bool</p>
3237</dd></dl>
3238
3239<dl class="method">
3240<dt id="sans.guiframe.aboutbox.MyApp.GetNextHandler">
3241<tt class="descname">GetNextHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetNextHandler" title="Permalink to this definition">¶</a></dt>
3242<dd><p>GetNextHandler(self) -&gt; EvtHandler</p>
3243</dd></dl>
3244
3245<dl class="method">
3246<dt id="sans.guiframe.aboutbox.MyApp.GetPreviousHandler">
3247<tt class="descname">GetPreviousHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetPreviousHandler" title="Permalink to this definition">¶</a></dt>
3248<dd><p>GetPreviousHandler(self) -&gt; EvtHandler</p>
3249</dd></dl>
3250
3251<dl class="method">
3252<dt id="sans.guiframe.aboutbox.MyApp.GetPrintMode">
3253<tt class="descname">GetPrintMode</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetPrintMode" title="Permalink to this definition">¶</a></dt>
3254<dd><p>GetPrintMode(self) -&gt; int</p>
3255</dd></dl>
3256
3257<dl class="method">
3258<dt id="sans.guiframe.aboutbox.MyApp.GetTopWindow">
3259<tt class="descname">GetTopWindow</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetTopWindow" title="Permalink to this definition">¶</a></dt>
3260<dd><p>GetTopWindow(self) -&gt; Window</p>
3261<p>Return the <em>main</em> top level window (if it hadn&#8217;t been set previously
3262with SetTopWindow(), will return just some top level window and, if
3263there not any, will return None)</p>
3264</dd></dl>
3265
3266<dl class="method">
3267<dt id="sans.guiframe.aboutbox.MyApp.GetTraits">
3268<tt class="descname">GetTraits</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetTraits" title="Permalink to this definition">¶</a></dt>
3269<dd><p>GetTraits(self) -&gt; wxAppTraits</p>
3270<p>Return (and create if necessary) the app traits object to which we
3271delegate for everything which either should be configurable by the
3272user (then he can change the default behaviour simply by overriding
3273CreateTraits() and returning his own traits object) or which is
3274GUI/console dependent as then wx.AppTraits allows us to abstract the
3275differences behind the common facade.</p>
3276<table class="docutils field-list" frame="void" rules="none">
3277<col class="field-name" />
3278<col class="field-body" />
3279<tbody valign="top">
3280<tr class="field"><th class="field-name">Todo :</th><td class="field-body">Add support for overriding CreateAppTraits in wxPython.</td>
3281</tr>
3282</tbody>
3283</table>
3284</dd></dl>
3285
3286<dl class="method">
3287<dt id="sans.guiframe.aboutbox.MyApp.GetUseBestVisual">
3288<tt class="descname">GetUseBestVisual</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetUseBestVisual" title="Permalink to this definition">¶</a></dt>
3289<dd><p>GetUseBestVisual(self) -&gt; bool</p>
3290<p>Get current UseBestVisual setting.</p>
3291</dd></dl>
3292
3293<dl class="method">
3294<dt id="sans.guiframe.aboutbox.MyApp.GetVendorName">
3295<tt class="descname">GetVendorName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.GetVendorName" title="Permalink to this definition">¶</a></dt>
3296<dd><p>GetVendorName(self) -&gt; String</p>
3297<p>Get the application&#8217;s vendor name.</p>
3298</dd></dl>
3299
3300<dl class="method">
3301<dt id="sans.guiframe.aboutbox.MyApp.IsActive">
3302<tt class="descname">IsActive</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.IsActive" title="Permalink to this definition">¶</a></dt>
3303<dd><p>IsActive(self) -&gt; bool</p>
3304<p>Return True if our app has focus.</p>
3305</dd></dl>
3306
3307<dl class="staticmethod">
3308<dt id="sans.guiframe.aboutbox.MyApp.IsDisplayAvailable">
3309<em class="property">static </em><tt class="descname">IsDisplayAvailable</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.IsDisplayAvailable" title="Permalink to this definition">¶</a></dt>
3310<dd><p>IsDisplayAvailable() -&gt; bool</p>
3311<p>Tests if it is possible to create a GUI in the current environment.
3312This will mean different things on the different platforms.</p>
3313<blockquote>
3314<div><ul class="simple">
3315<li>On X Windows systems this function will return <tt class="xref docutils literal"><span class="pre">False</span></tt> if it is
3316not able to open a connection to the X display, which can happen
3317if $DISPLAY is not set, or is not set correctly.</li>
3318<li>On Mac OS X a <tt class="xref docutils literal"><span class="pre">False</span></tt> return value will mean that wx is not
3319able to access the window manager, which can happen if logged in
3320remotely or if running from the normal version of python instead
3321of the framework version, (i.e., pythonw.)</li>
3322<li>On MS Windows...</li>
3323</ul>
3324</div></blockquote>
3325</dd></dl>
3326
3327<dl class="staticmethod">
3328<dt id="sans.guiframe.aboutbox.MyApp.IsMainLoopRunning">
3329<em class="property">static </em><tt class="descname">IsMainLoopRunning</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.IsMainLoopRunning" title="Permalink to this definition">¶</a></dt>
3330<dd><p>IsMainLoopRunning() -&gt; bool</p>
3331<p>Returns True if we&#8217;re running the main loop, i.e. if the events can
3332currently be dispatched.</p>
3333</dd></dl>
3334
3335<dl class="method">
3336<dt id="sans.guiframe.aboutbox.MyApp.IsSameAs">
3337<tt class="descname">IsSameAs</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.IsSameAs" title="Permalink to this definition">¶</a></dt>
3338<dd><p>IsSameAs(self, Object p) -&gt; bool</p>
3339<p>For wx.Objects that use C++ reference counting internally, this method
3340can be used to determine if two objects are referencing the same data
3341object.</p>
3342</dd></dl>
3343
3344<dl class="attribute">
3345<dt id="sans.guiframe.aboutbox.MyApp.LayoutDirection">
3346<tt class="descname">LayoutDirection</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.LayoutDirection" title="Permalink to this definition">¶</a></dt>
3347<dd><p>See <cite>GetLayoutDirection</cite></p>
3348</dd></dl>
3349
3350<dl class="method">
3351<dt id="sans.guiframe.aboutbox.MyApp.MacHideApp">
3352<tt class="descname">MacHideApp</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.MacHideApp" title="Permalink to this definition">¶</a></dt>
3353<dd><p>MacHideApp(self)</p>
3354<p>Hide all application windows just as the user can do with the system
3355Hide command.  Mac only.</p>
3356</dd></dl>
3357
3358<dl class="method">
3359<dt id="sans.guiframe.aboutbox.MyApp.MacRequestUserAttention">
3360<tt class="descname">MacRequestUserAttention</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.MacRequestUserAttention" title="Permalink to this definition">¶</a></dt>
3361<dd><p>MacRequestUserAttention(self, int ?)</p>
3362</dd></dl>
3363
3364<dl class="method">
3365<dt id="sans.guiframe.aboutbox.MyApp.MainLoop">
3366<tt class="descname">MainLoop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.MainLoop" title="Permalink to this definition">¶</a></dt>
3367<dd><p>Execute the main GUI event loop</p>
3368</dd></dl>
3369
3370<dl class="attribute">
3371<dt id="sans.guiframe.aboutbox.MyApp.NextHandler">
3372<tt class="descname">NextHandler</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.NextHandler" title="Permalink to this definition">¶</a></dt>
3373<dd><p>See <cite>GetNextHandler</cite> and <cite>SetNextHandler</cite></p>
3374</dd></dl>
3375
3376<dl class="method">
3377<dt id="sans.guiframe.aboutbox.MyApp.OnInit">
3378<tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.OnInit" title="Permalink to this definition">¶</a></dt>
3379<dd></dd></dl>
3380
3381<dl class="method">
3382<dt id="sans.guiframe.aboutbox.MyApp.OnPreInit">
3383<tt class="descname">OnPreInit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.OnPreInit" title="Permalink to this definition">¶</a></dt>
3384<dd><p>Things that must be done after _BootstrapApp has done its
3385thing, but would be nice if they were already done by the time
3386that OnInit is called.</p>
3387</dd></dl>
3388
3389<dl class="method">
3390<dt id="sans.guiframe.aboutbox.MyApp.Pending">
3391<tt class="descname">Pending</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Pending" title="Permalink to this definition">¶</a></dt>
3392<dd><p>Pending(self) -&gt; bool</p>
3393<p>Returns True if there are unprocessed events in the event queue.</p>
3394</dd></dl>
3395
3396<dl class="attribute">
3397<dt id="sans.guiframe.aboutbox.MyApp.PreviousHandler">
3398<tt class="descname">PreviousHandler</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.PreviousHandler" title="Permalink to this definition">¶</a></dt>
3399<dd><p>See <cite>GetPreviousHandler</cite> and <cite>SetPreviousHandler</cite></p>
3400</dd></dl>
3401
3402<dl class="attribute">
3403<dt id="sans.guiframe.aboutbox.MyApp.PrintMode">
3404<tt class="descname">PrintMode</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.PrintMode" title="Permalink to this definition">¶</a></dt>
3405<dd><p>See <cite>GetPrintMode</cite> and <cite>SetPrintMode</cite></p>
3406</dd></dl>
3407
3408<dl class="method">
3409<dt id="sans.guiframe.aboutbox.MyApp.ProcessEvent">
3410<tt class="descname">ProcessEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.ProcessEvent" title="Permalink to this definition">¶</a></dt>
3411<dd><p>ProcessEvent(self, Event event) -&gt; bool</p>
3412</dd></dl>
3413
3414<dl class="method">
3415<dt id="sans.guiframe.aboutbox.MyApp.ProcessIdle">
3416<tt class="descname">ProcessIdle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.ProcessIdle" title="Permalink to this definition">¶</a></dt>
3417<dd><p>ProcessIdle(self) -&gt; bool</p>
3418<p>Called from the MainLoop when the application becomes idle (there are
3419no pending events) and sends a <cite>wx.IdleEvent</cite> to all interested
3420parties.  Returns True if more idle events are needed, False if not.</p>
3421</dd></dl>
3422
3423<dl class="method">
3424<dt id="sans.guiframe.aboutbox.MyApp.ProcessPendingEvents">
3425<tt class="descname">ProcessPendingEvents</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.ProcessPendingEvents" title="Permalink to this definition">¶</a></dt>
3426<dd><p>ProcessPendingEvents(self)</p>
3427<p>Process all events in the Pending Events list &#8211; it is necessary to
3428call this function to process posted events. This normally happens
3429during each event loop iteration.</p>
3430</dd></dl>
3431
3432<dl class="method">
3433<dt id="sans.guiframe.aboutbox.MyApp.RedirectStdio">
3434<tt class="descname">RedirectStdio</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.RedirectStdio" title="Permalink to this definition">¶</a></dt>
3435<dd><p>Redirect sys.stdout and sys.stderr to a file or a popup window.</p>
3436</dd></dl>
3437
3438<dl class="method">
3439<dt id="sans.guiframe.aboutbox.MyApp.RestoreStdio">
3440<tt class="descname">RestoreStdio</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.RestoreStdio" title="Permalink to this definition">¶</a></dt>
3441<dd></dd></dl>
3442
3443<dl class="method">
3444<dt id="sans.guiframe.aboutbox.MyApp.SendIdleEvents">
3445<tt class="descname">SendIdleEvents</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SendIdleEvents" title="Permalink to this definition">¶</a></dt>
3446<dd><p>SendIdleEvents(self, Window win, IdleEvent event) -&gt; bool</p>
3447<p>Send idle event to window and all subwindows.  Returns True if more
3448idle time is requested.</p>
3449</dd></dl>
3450
3451<dl class="method">
3452<dt id="sans.guiframe.aboutbox.MyApp.SetAppName">
3453<tt class="descname">SetAppName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetAppName" title="Permalink to this definition">¶</a></dt>
3454<dd><p>SetAppName(self, String name)</p>
3455<p>Set the application name. This value may be used automatically by
3456<cite>wx.Config</cite> and such.</p>
3457</dd></dl>
3458
3459<dl class="method">
3460<dt id="sans.guiframe.aboutbox.MyApp.SetAssertMode">
3461<tt class="descname">SetAssertMode</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetAssertMode" title="Permalink to this definition">¶</a></dt>
3462<dd><p>SetAssertMode(self, int mode)</p>
3463<p>Set the OnAssert behaviour for debug and hybrid builds.</p>
3464</dd></dl>
3465
3466<dl class="method">
3467<dt id="sans.guiframe.aboutbox.MyApp.SetCallFilterEvent">
3468<tt class="descname">SetCallFilterEvent</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetCallFilterEvent" title="Permalink to this definition">¶</a></dt>
3469<dd><p>SetCallFilterEvent(self, bool callFilterEvent=True)</p>
3470<p>Set the Call FilterEvent flag. When set your override of FilterEvent
3471will be called.  SetCallFilterEvent&#8217;s purpose is to avoid any
3472performance penalty when you have overriden FilterEvent, but don&#8217;t
3473want it to be called, and also to reduce the runtime overhead when it
3474is not overridden.</p>
3475</dd></dl>
3476
3477<dl class="method">
3478<dt id="sans.guiframe.aboutbox.MyApp.SetClassName">
3479<tt class="descname">SetClassName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetClassName" title="Permalink to this definition">¶</a></dt>
3480<dd><p>SetClassName(self, String name)</p>
3481<p>Set the application&#8217;s class name. This value may be used for
3482X-resources if applicable for the platform</p>
3483</dd></dl>
3484
3485<dl class="method">
3486<dt id="sans.guiframe.aboutbox.MyApp.SetEvtHandlerEnabled">
3487<tt class="descname">SetEvtHandlerEnabled</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt>
3488<dd><p>SetEvtHandlerEnabled(self, bool enabled)</p>
3489</dd></dl>
3490
3491<dl class="method">
3492<dt id="sans.guiframe.aboutbox.MyApp.SetExitOnFrameDelete">
3493<tt class="descname">SetExitOnFrameDelete</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetExitOnFrameDelete" title="Permalink to this definition">¶</a></dt>
3494<dd><p>SetExitOnFrameDelete(self, bool flag)</p>
3495<p>Control the exit behaviour: by default, the program will exit the main
3496loop (and so, usually, terminate) when the last top-level program
3497window is deleted.  Beware that if you disable this behaviour (with
3498SetExitOnFrameDelete(False)), you&#8217;ll have to call ExitMainLoop()
3499explicitly from somewhere.</p>
3500</dd></dl>
3501
3502<dl class="staticmethod">
3503<dt id="sans.guiframe.aboutbox.MyApp.SetMacAboutMenuItemId">
3504<em class="property">static </em><tt class="descname">SetMacAboutMenuItemId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetMacAboutMenuItemId" title="Permalink to this definition">¶</a></dt>
3505<dd><p>SetMacAboutMenuItemId(long val)</p>
3506</dd></dl>
3507
3508<dl class="staticmethod">
3509<dt id="sans.guiframe.aboutbox.MyApp.SetMacExitMenuItemId">
3510<em class="property">static </em><tt class="descname">SetMacExitMenuItemId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetMacExitMenuItemId" title="Permalink to this definition">¶</a></dt>
3511<dd><p>SetMacExitMenuItemId(long val)</p>
3512</dd></dl>
3513
3514<dl class="staticmethod">
3515<dt id="sans.guiframe.aboutbox.MyApp.SetMacHelpMenuTitleName">
3516<em class="property">static </em><tt class="descname">SetMacHelpMenuTitleName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetMacHelpMenuTitleName" title="Permalink to this definition">¶</a></dt>
3517<dd><p>SetMacHelpMenuTitleName(String val)</p>
3518</dd></dl>
3519
3520<dl class="staticmethod">
3521<dt id="sans.guiframe.aboutbox.MyApp.SetMacPreferencesMenuItemId">
3522<em class="property">static </em><tt class="descname">SetMacPreferencesMenuItemId</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetMacPreferencesMenuItemId" title="Permalink to this definition">¶</a></dt>
3523<dd><p>SetMacPreferencesMenuItemId(long val)</p>
3524</dd></dl>
3525
3526<dl class="staticmethod">
3527<dt id="sans.guiframe.aboutbox.MyApp.SetMacSupportPCMenuShortcuts">
3528<em class="property">static </em><tt class="descname">SetMacSupportPCMenuShortcuts</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetMacSupportPCMenuShortcuts" title="Permalink to this definition">¶</a></dt>
3529<dd><p>SetMacSupportPCMenuShortcuts(bool val)</p>
3530</dd></dl>
3531
3532<dl class="method">
3533<dt id="sans.guiframe.aboutbox.MyApp.SetNextHandler">
3534<tt class="descname">SetNextHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetNextHandler" title="Permalink to this definition">¶</a></dt>
3535<dd><p>SetNextHandler(self, EvtHandler handler)</p>
3536</dd></dl>
3537
3538<dl class="method">
3539<dt id="sans.guiframe.aboutbox.MyApp.SetOutputWindowAttributes">
3540<tt class="descname">SetOutputWindowAttributes</tt><big>(</big><em>title=None</em>, <em>pos=None</em>, <em>size=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetOutputWindowAttributes" title="Permalink to this definition">¶</a></dt>
3541<dd><p>Set the title, position and/or size of the output window if
3542the stdio has been redirected.  This should be called before
3543any output would cause the output window to be created.</p>
3544</dd></dl>
3545
3546<dl class="method">
3547<dt id="sans.guiframe.aboutbox.MyApp.SetPreviousHandler">
3548<tt class="descname">SetPreviousHandler</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetPreviousHandler" title="Permalink to this definition">¶</a></dt>
3549<dd><p>SetPreviousHandler(self, EvtHandler handler)</p>
3550</dd></dl>
3551
3552<dl class="method">
3553<dt id="sans.guiframe.aboutbox.MyApp.SetPrintMode">
3554<tt class="descname">SetPrintMode</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetPrintMode" title="Permalink to this definition">¶</a></dt>
3555<dd><p>SetPrintMode(self, int mode)</p>
3556</dd></dl>
3557
3558<dl class="method">
3559<dt id="sans.guiframe.aboutbox.MyApp.SetTopWindow">
3560<tt class="descname">SetTopWindow</tt><big>(</big><em>frame</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetTopWindow" title="Permalink to this definition">¶</a></dt>
3561<dd><p>Set the &#8220;main&#8221; top level window</p>
3562</dd></dl>
3563
3564<dl class="method">
3565<dt id="sans.guiframe.aboutbox.MyApp.SetUseBestVisual">
3566<tt class="descname">SetUseBestVisual</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetUseBestVisual" title="Permalink to this definition">¶</a></dt>
3567<dd><p>SetUseBestVisual(self, bool flag, bool forceTrueColour=False)</p>
3568<p>Set whether the app should try to use the best available visual on
3569systems where more than one is available, (Sun, SGI, XFree86 4, etc.)</p>
3570</dd></dl>
3571
3572<dl class="method">
3573<dt id="sans.guiframe.aboutbox.MyApp.SetVendorName">
3574<tt class="descname">SetVendorName</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.SetVendorName" title="Permalink to this definition">¶</a></dt>
3575<dd><p>SetVendorName(self, String name)</p>
3576<p>Set the application&#8217;s vendor name. This value may be used
3577automatically by <cite>wx.Config</cite> and such.</p>
3578</dd></dl>
3579
3580<dl class="attribute">
3581<dt id="sans.guiframe.aboutbox.MyApp.TopWindow">
3582<tt class="descname">TopWindow</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.TopWindow" title="Permalink to this definition">¶</a></dt>
3583<dd><p>See <cite>GetTopWindow</cite> and <cite>SetTopWindow</cite></p>
3584</dd></dl>
3585
3586<dl class="attribute">
3587<dt id="sans.guiframe.aboutbox.MyApp.Traits">
3588<tt class="descname">Traits</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Traits" title="Permalink to this definition">¶</a></dt>
3589<dd><p>See <cite>GetTraits</cite></p>
3590</dd></dl>
3591
3592<dl class="method">
3593<dt id="sans.guiframe.aboutbox.MyApp.Unbind">
3594<tt class="descname">Unbind</tt><big>(</big><em>event</em>, <em>source=None</em>, <em>id=-1</em>, <em>id2=-1</em>, <em>handler=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Unbind" title="Permalink to this definition">¶</a></dt>
3595<dd><p>Disconnects the event handler binding for event from self.
3596Returns True if successful.</p>
3597</dd></dl>
3598
3599<dl class="attribute">
3600<dt id="sans.guiframe.aboutbox.MyApp.UseBestVisual">
3601<tt class="descname">UseBestVisual</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.UseBestVisual" title="Permalink to this definition">¶</a></dt>
3602<dd><p>See <cite>GetUseBestVisual</cite> and <cite>SetUseBestVisual</cite></p>
3603</dd></dl>
3604
3605<dl class="attribute">
3606<dt id="sans.guiframe.aboutbox.MyApp.VendorName">
3607<tt class="descname">VendorName</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.VendorName" title="Permalink to this definition">¶</a></dt>
3608<dd><p>See <cite>GetVendorName</cite> and <cite>SetVendorName</cite></p>
3609</dd></dl>
3610
3611<dl class="method">
3612<dt id="sans.guiframe.aboutbox.MyApp.WakeUpIdle">
3613<tt class="descname">WakeUpIdle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.WakeUpIdle" title="Permalink to this definition">¶</a></dt>
3614<dd><p>WakeUpIdle(self)</p>
3615<p>Make sure that idle events are sent again.
3616:see: <cite>wx.WakeUpIdle</cite></p>
3617</dd></dl>
3618
3619<dl class="method">
3620<dt id="sans.guiframe.aboutbox.MyApp.Yield">
3621<tt class="descname">Yield</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.Yield" title="Permalink to this definition">¶</a></dt>
3622<dd><p>Yield(self, bool onlyIfNeeded=False) -&gt; bool</p>
3623<p>Process all currently pending events right now, instead of waiting
3624until return to the event loop.  It is an error to call <tt class="docutils literal"><span class="pre">Yield</span></tt>
3625recursively unless the value of <tt class="docutils literal"><span class="pre">onlyIfNeeded</span></tt> is True.</p>
3626<table class="docutils field-list" frame="void" rules="none">
3627<col class="field-name" />
3628<col class="field-body" />
3629<tbody valign="top">
3630<tr class="field"><th class="field-name">Warning :</th><td class="field-body">This function is dangerous as it can lead to unexpected
3631reentrancies (i.e. when called from an event handler it may
3632result in calling the same event handler again), use with
3633extreme care or, better, don&#8217;t use at all!</td>
3634</tr>
3635<tr class="field"><th class="field-name">See :</th><td class="field-body"><cite>wx.Yield</cite>, <cite>wx.YieldIfNeeded</cite>, <cite>wx.SafeYield</cite></td>
3636</tr>
3637</tbody>
3638</table>
3639</dd></dl>
3640
3641<dl class="attribute">
3642<dt id="sans.guiframe.aboutbox.MyApp.outputWindowClass">
3643<tt class="descname">outputWindowClass</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.outputWindowClass" title="Permalink to this definition">¶</a></dt>
3644<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">PyOnDemandOutputWindow</span></tt></p>
3645</dd></dl>
3646
3647<dl class="attribute">
3648<dt id="sans.guiframe.aboutbox.MyApp.thisown">
3649<tt class="descname">thisown</tt><a class="headerlink" href="#sans.guiframe.aboutbox.MyApp.thisown" title="Permalink to this definition">¶</a></dt>
3650<dd><p>The membership flag</p>
3651</dd></dl>
3652
3653</dd></dl>
3654
3655<dl class="function">
3656<dt id="sans.guiframe.aboutbox.launchBrowser">
3657<tt class="descclassname">sans.guiframe.aboutbox.</tt><tt class="descname">launchBrowser</tt><big>(</big><em>url</em><big>)</big><a class="headerlink" href="#sans.guiframe.aboutbox.launchBrowser" title="Permalink to this definition">¶</a></dt>
3658<dd><p>Launches browser and opens specified url</p>
3659<p>In some cases may require BROWSER environment variable to be set up.</p>
3660<table class="docutils field-list" frame="void" rules="none">
3661<col class="field-name" />
3662<col class="field-body" />
3663<tbody valign="top">
3664<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>url</strong> &#8211; URL to open</td>
3665</tr>
3666</tbody>
3667</table>
3668</dd></dl>
3669
3670</div>
3671</div>
3672
3673
3674          </div>
3675        </div>
3676      </div>
3677      <div class="sphinxsidebar">
3678        <div class="sphinxsidebarwrapper">
3679  <h3><a href="../index.html">Table Of Contents</a></h3>
3680  <ul>
3681<li><a class="reference internal" href="#">aboutbox</a><ul>
3682<li><a class="reference internal" href="#module-sans.guiframe.aboutbox"><tt class="docutils literal"><span class="pre">sans.guiframe.aboutbox</span></tt></a></li>
3683</ul>
3684</li>
3685</ul>
3686
3687  <h4>Previous topic</h4>
3688  <p class="topless"><a href="index.html"
3689                        title="previous chapter">Reference</a></p>
3690  <h4>Next topic</h4>
3691  <p class="topless"><a href="config.html"
3692                        title="next chapter">config</a></p>
3693  <h3>This Page</h3>
3694  <ul class="this-page-menu">
3695    <li><a href="../_sources/api/aboutbox.txt"
3696           rel="nofollow">Show Source</a></li>
3697  </ul>
3698<div id="searchbox" style="display: none">
3699  <h3>Quick search</h3>
3700    <form class="search" action="../search.html" method="get">
3701      <input type="text" name="q" size="18" />
3702      <input type="submit" value="Go" />
3703      <input type="hidden" name="check_keywords" value="yes" />
3704      <input type="hidden" name="area" value="default" />
3705    </form>
3706    <p class="searchtip" style="font-size: 90%">
3707    Enter search terms or a module, class or function name.
3708    </p>
3709</div>
3710<script type="text/javascript">$('#searchbox').show(0);</script>
3711        </div>
3712      </div>
3713      <div class="clearer"></div>
3714    </div>
3715    <div class="related">
3716      <h3>Navigation</h3>
3717      <ul>
3718        <li class="right" style="margin-right: 10px">
3719          <a href="../genindex.html" title="General Index"
3720             >index</a></li>
3721        <li class="right" >
3722          <a href="../py-modindex.html" title="Python Module Index"
3723             >modules</a> |</li>
3724        <li class="right" >
3725          <a href="config.html" title="config"
3726             >next</a> |</li>
3727        <li class="right" >
3728          <a href="index.html" title="Reference"
3729             >previous</a> |</li>
3730        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
3731          <li><a href="index.html" >Reference</a> &raquo;</li> 
3732      </ul>
3733    </div>
3734    <div class="footer">
3735        &copy; Copyright 2010, sans group.
3736      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
3737    </div>
3738  </body>
3739</html>
Note: See TracBrowser for help on using the repository browser.