source: sasview/sansguiframe/docs/sphinx/html/api/gui_toolbar.html @ 8d27cac

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 8d27cac was bce8148, checked in by Gervaise Alina <gervyh@…>, 13 years ago

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