source: sasview/sansguiframe/docs/sphinx/html/api/local_perspectives/plotting/help_panel.html @ 96cbb53

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

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