source: sasview/guiframe/docs/sphinx/_build/html/api/aboutbox.html @ d955bf19

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 d955bf19 was d955bf19, checked in by Gervaise Alina <gervyh@…>, 14 years ago

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