source: sasview/plottools/docs/sphinx/html/api/canvas.html @ 6232a6f

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 6232a6f was 82a54b8, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

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