Changeset bce8148 in sasview for sansguiframe/docs/sphinx/html/api/gui_manager.html
- Timestamp:
- Oct 24, 2011 2:43:40 PM (13 years ago)
- Branches:
- master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
- Children:
- 67cd7c0
- Parents:
- 70ecd530
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
sansguiframe/docs/sphinx/html/api/gui_manager.html
r96cbb53 rbce8148 3 3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 5 6 6 7 <html xmlns="http://www.w3.org/1999/xhtml"> … … 8 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 10 <title>gui_manager — guiframe v0.1.0 documentation</title> 11 <title>gui_manager — guiframe 0.1.0 documentation</title> 12 11 13 <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 12 14 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 15 13 16 <script type="text/javascript"> 14 17 var DOCUMENTATION_OPTIONS = { … … 23 26 <script type="text/javascript" src="../_static/underscore.js"></script> 24 27 <script type="text/javascript" src="../_static/doctools.js"></script> 25 <link rel="top" title="guiframe v0.1.0 documentation" href="../index.html" />28 <link rel="top" title="guiframe 0.1.0 documentation" href="../index.html" /> 26 29 <link rel="up" title="Reference" href="index.html" /> 27 30 <link rel="next" title="gui_statusbar" href="gui_statusbar.html" /> … … 44 47 <a href="events.html" title="events" 45 48 accesskey="P">previous</a> |</li> 46 <li><a href="../index.html">guiframe v0.1.0 documentation</a> »</li>49 <li><a href="../index.html">guiframe 0.1.0 documentation</a> »</li> 47 50 <li><a href="index.html" accesskey="U">Reference</a> »</li> 48 51 </ul> … … 57 60 <h1>gui_manager<a class="headerlink" href="#gui-manager" title="Permalink to this headline">¶</a></h1> 58 61 <div class="section" id="sans-guiframe-gui-manager"> 59 <h2><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.gui_manager</span></tt><a class="headerlink" href="#sans-guiframe-gui-manager" title="Permalink to this headline">¶</a></h2> 62 <h2><a class="reference internal" href="#module-sans.guiframe.gui_manager" title="sans.guiframe.gui_manager"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.gui_manager</span></tt></a><a class="headerlink" href="#sans-guiframe-gui-manager" title="Permalink to this headline">¶</a></h2> 63 <span class="target" id="module-sans.guiframe.gui_manager"></span><dl class="class"> 64 <dt id="sans.guiframe.gui_manager.DefaultPanel"> 65 <em class="property">class </em><tt class="descclassname">sans.guiframe.gui_manager.</tt><tt class="descname">DefaultPanel</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel" title="Permalink to this definition">¶</a></dt> 66 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Panel</span></tt>, <a class="reference internal" href="panel_base.html#sans.guiframe.panel_base.PanelBase" title="sans.guiframe.panel_base.PanelBase"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.panel_base.PanelBase</span></tt></a></p> 67 <p>Defines the API for a panels to work with 68 the GUI manager</p> 69 <dl class="attribute"> 70 <dt id="sans.guiframe.gui_manager.DefaultPanel.AcceleratorTable"> 71 <tt class="descname">AcceleratorTable</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.AcceleratorTable" title="Permalink to this definition">¶</a></dt> 72 <dd><p>See <cite>GetAcceleratorTable</cite> and <cite>SetAcceleratorTable</cite></p> 73 </dd></dl> 74 75 <dl class="method"> 76 <dt id="sans.guiframe.gui_manager.DefaultPanel.AcceptsFocus"> 77 <tt class="descname">AcceptsFocus</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.AcceptsFocus" title="Permalink to this definition">¶</a></dt> 78 <dd><p>Can this window have focus?</p> 79 </dd></dl> 80 81 <dl class="method"> 82 <dt id="sans.guiframe.gui_manager.DefaultPanel.AcceptsFocusFromKeyboard"> 83 <tt class="descname">AcceptsFocusFromKeyboard</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.AcceptsFocusFromKeyboard" title="Permalink to this definition">¶</a></dt> 84 <dd><p>Can this window be given focus by keyboard navigation? if not, the 85 only way to give it focus (provided it accepts it at all) is to click 86 it.</p> 87 </dd></dl> 88 89 <dl class="method"> 90 <dt id="sans.guiframe.gui_manager.DefaultPanel.AddChild"> 91 <tt class="descname">AddChild</tt><big>(</big><em>self</em>, <em>Window child</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.AddChild" title="Permalink to this definition">¶</a></dt> 92 <dd><p>Adds a child window. This is called automatically by window creation 93 functions so should not be required by the application programmer.</p> 94 </dd></dl> 95 96 <dl class="method"> 97 <dt id="sans.guiframe.gui_manager.DefaultPanel.AddPendingEvent"> 98 <tt class="descname">AddPendingEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.AddPendingEvent" title="Permalink to this definition">¶</a></dt> 99 <dd></dd></dl> 100 101 <dl class="method"> 102 <dt id="sans.guiframe.gui_manager.DefaultPanel.AdjustForLayoutDirection"> 103 <tt class="descname">AdjustForLayoutDirection</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int width</em>, <em>int widthTotal</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.AdjustForLayoutDirection" title="Permalink to this definition">¶</a></dt> 104 <dd><p>Mirror coordinates for RTL layout if this window uses it and if the 105 mirroring is not done automatically like Win32.</p> 106 </dd></dl> 107 108 <dl class="method"> 109 <dt id="sans.guiframe.gui_manager.DefaultPanel.AssociateHandle"> 110 <tt class="descname">AssociateHandle</tt><big>(</big><em>self</em>, <em>long handle</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.AssociateHandle" title="Permalink to this definition">¶</a></dt> 111 <dd><p>Associate the window with a new native handle</p> 112 </dd></dl> 113 114 <dl class="attribute"> 115 <dt id="sans.guiframe.gui_manager.DefaultPanel.AutoLayout"> 116 <tt class="descname">AutoLayout</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.AutoLayout" title="Permalink to this definition">¶</a></dt> 117 <dd><p>See <cite>GetAutoLayout</cite> and <cite>SetAutoLayout</cite></p> 118 </dd></dl> 119 120 <dl class="attribute"> 121 <dt id="sans.guiframe.gui_manager.DefaultPanel.BackgroundColour"> 122 <tt class="descname">BackgroundColour</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.BackgroundColour" title="Permalink to this definition">¶</a></dt> 123 <dd><p>See <cite>GetBackgroundColour</cite> and <cite>SetBackgroundColour</cite></p> 124 </dd></dl> 125 126 <dl class="attribute"> 127 <dt id="sans.guiframe.gui_manager.DefaultPanel.BackgroundStyle"> 128 <tt class="descname">BackgroundStyle</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.BackgroundStyle" title="Permalink to this definition">¶</a></dt> 129 <dd><p>See <cite>GetBackgroundStyle</cite> and <cite>SetBackgroundStyle</cite></p> 130 </dd></dl> 131 132 <dl class="attribute"> 133 <dt id="sans.guiframe.gui_manager.DefaultPanel.BestSize"> 134 <tt class="descname">BestSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.BestSize" title="Permalink to this definition">¶</a></dt> 135 <dd><p>See <cite>GetBestSize</cite></p> 136 </dd></dl> 137 138 <dl class="attribute"> 139 <dt id="sans.guiframe.gui_manager.DefaultPanel.BestVirtualSize"> 140 <tt class="descname">BestVirtualSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.BestVirtualSize" title="Permalink to this definition">¶</a></dt> 141 <dd><p>See <cite>GetBestVirtualSize</cite></p> 142 </dd></dl> 143 144 <dl class="method"> 145 <dt id="sans.guiframe.gui_manager.DefaultPanel.Bind"> 146 <tt class="descname">Bind</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Bind" title="Permalink to this definition">¶</a></dt> 147 <dd><p>Bind an event to an event handler.</p> 148 <table class="docutils field-list" frame="void" rules="none"> 149 <col class="field-name" /> 150 <col class="field-body" /> 151 <tbody valign="top"> 152 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 153 <li><strong>event</strong> – One of the EVT_* objects that specifies the 154 type of event to bind,</li> 155 <li><strong>handler</strong> – A callable object to be invoked when the 156 event is delivered to self. Pass None to 157 disconnect an event handler.</li> 158 <li><strong>source</strong> – Sometimes the event originates from a 159 different window than self, but you still 160 want to catch it in self. (For example, a 161 button event delivered to a frame.) By 162 passing the source of the event, the event 163 handling system is able to differentiate 164 between the same event type from different 165 controls.</li> 166 <li><strong>id</strong> – Used to spcify the event source by ID instead 167 of instance.</li> 168 <li><strong>id2</strong> – Used when it is desirable to bind a handler 169 to a range of IDs, such as with EVT_MENU_RANGE.</li> 170 </ul> 171 </td> 172 </tr> 173 </tbody> 174 </table> 175 </dd></dl> 176 177 <dl class="attribute"> 178 <dt id="sans.guiframe.gui_manager.DefaultPanel.Border"> 179 <tt class="descname">Border</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Border" title="Permalink to this definition">¶</a></dt> 180 <dd><p>See <cite>GetBorder</cite></p> 181 </dd></dl> 182 183 <dl class="attribute"> 184 <dt id="sans.guiframe.gui_manager.DefaultPanel.CENTER_PANE"> 185 <tt class="descname">CENTER_PANE</tt><em class="property"> = True</em><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.CENTER_PANE" title="Permalink to this definition">¶</a></dt> 186 <dd></dd></dl> 187 188 <dl class="method"> 189 <dt id="sans.guiframe.gui_manager.DefaultPanel.CacheBestSize"> 190 <tt class="descname">CacheBestSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.CacheBestSize" title="Permalink to this definition">¶</a></dt> 191 <dd><p>Cache the best size so it doesn’t need to be calculated again, (at least until 192 some properties of the window change.)</p> 193 </dd></dl> 194 195 <dl class="method"> 196 <dt id="sans.guiframe.gui_manager.DefaultPanel.CanSetTransparent"> 197 <tt class="descname">CanSetTransparent</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.CanSetTransparent" title="Permalink to this definition">¶</a></dt> 198 <dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the platform supports setting the transparency for 199 this window. Note that this method will err on the side of caution, 200 so it is possible that this will return <tt class="docutils literal"><span class="pre">False</span></tt> when it is in fact 201 possible to set the transparency.</p> 202 <p>NOTE: On X-windows systems the X server must have the composite 203 extension loaded, and there must be a composite manager program (such 204 as xcompmgr) running.</p> 205 </dd></dl> 206 207 <dl class="method"> 208 <dt id="sans.guiframe.gui_manager.DefaultPanel.CaptureMouse"> 209 <tt class="descname">CaptureMouse</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.CaptureMouse" title="Permalink to this definition">¶</a></dt> 210 <dd><p>Directs all mouse input to this window. Call wx.Window.ReleaseMouse to 211 release the capture.</p> 212 <p>Note that wxWindows maintains the stack of windows having captured the 213 mouse and when the mouse is released the capture returns to the window 214 which had had captured it previously and it is only really released if 215 there were no previous window. In particular, this means that you must 216 release the mouse as many times as you capture it, unless the window 217 receives the <cite>wx.MouseCaptureLostEvent</cite> event.</p> 218 <p>Any application which captures the mouse in the beginning of some 219 operation <em>must</em> handle <cite>wx.MouseCaptureLostEvent</cite> and cancel this 220 operation when it receives the event. The event handler must not 221 recapture mouse.</p> 222 </dd></dl> 223 224 <dl class="attribute"> 225 <dt id="sans.guiframe.gui_manager.DefaultPanel.Caret"> 226 <tt class="descname">Caret</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Caret" title="Permalink to this definition">¶</a></dt> 227 <dd><p>See <cite>GetCaret</cite> and <cite>SetCaret</cite></p> 228 </dd></dl> 229 230 <dl class="method"> 231 <dt id="sans.guiframe.gui_manager.DefaultPanel.Center"> 232 <tt class="descname">Center</tt><big>(</big><em>self</em>, <em>int direction=BOTH</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Center" title="Permalink to this definition">¶</a></dt> 233 <dd><p>Centers the window. The parameter specifies the direction for 234 centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 235 also include wx.CENTER_ON_SCREEN flag if you want to center the window 236 on the entire screen and not on its parent window. If it is a 237 top-level window and has no parent then it will always be centered 238 relative to the screen.</p> 239 </dd></dl> 240 241 <dl class="method"> 242 <dt id="sans.guiframe.gui_manager.DefaultPanel.CenterOnParent"> 243 <tt class="descname">CenterOnParent</tt><big>(</big><em>self</em>, <em>int dir=BOTH</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.CenterOnParent" title="Permalink to this definition">¶</a></dt> 244 <dd><p>Center with respect to the the parent window</p> 245 </dd></dl> 246 247 <dl class="method"> 248 <dt id="sans.guiframe.gui_manager.DefaultPanel.Centre"> 249 <tt class="descname">Centre</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Centre" title="Permalink to this definition">¶</a></dt> 250 <dd><p>Center(self, int direction=BOTH)</p> 251 <p>Centers the window. The parameter specifies the direction for 252 centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 253 also include wx.CENTER_ON_SCREEN flag if you want to center the window 254 on the entire screen and not on its parent window. If it is a 255 top-level window and has no parent then it will always be centered 256 relative to the screen.</p> 257 </dd></dl> 258 259 <dl class="method"> 260 <dt id="sans.guiframe.gui_manager.DefaultPanel.CentreOnParent"> 261 <tt class="descname">CentreOnParent</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.CentreOnParent" title="Permalink to this definition">¶</a></dt> 262 <dd><p>CenterOnParent(self, int dir=BOTH)</p> 263 <p>Center with respect to the the parent window</p> 264 </dd></dl> 265 266 <dl class="attribute"> 267 <dt id="sans.guiframe.gui_manager.DefaultPanel.CharHeight"> 268 <tt class="descname">CharHeight</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.CharHeight" title="Permalink to this definition">¶</a></dt> 269 <dd><p>See <cite>GetCharHeight</cite></p> 270 </dd></dl> 271 272 <dl class="attribute"> 273 <dt id="sans.guiframe.gui_manager.DefaultPanel.CharWidth"> 274 <tt class="descname">CharWidth</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.CharWidth" title="Permalink to this definition">¶</a></dt> 275 <dd><p>See <cite>GetCharWidth</cite></p> 276 </dd></dl> 277 278 <dl class="attribute"> 279 <dt id="sans.guiframe.gui_manager.DefaultPanel.Children"> 280 <tt class="descname">Children</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Children" title="Permalink to this definition">¶</a></dt> 281 <dd><p>See <cite>GetChildren</cite></p> 282 </dd></dl> 283 284 <dl class="attribute"> 285 <dt id="sans.guiframe.gui_manager.DefaultPanel.ClassName"> 286 <tt class="descname">ClassName</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ClassName" title="Permalink to this definition">¶</a></dt> 287 <dd><p>See <cite>GetClassName</cite></p> 288 </dd></dl> 289 290 <dl class="method"> 291 <dt id="sans.guiframe.gui_manager.DefaultPanel.ClearBackground"> 292 <tt class="descname">ClearBackground</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ClearBackground" title="Permalink to this definition">¶</a></dt> 293 <dd><p>Clears the window by filling it with the current background 294 colour. Does not cause an erase background event to be generated.</p> 295 </dd></dl> 296 297 <dl class="attribute"> 298 <dt id="sans.guiframe.gui_manager.DefaultPanel.ClientAreaOrigin"> 299 <tt class="descname">ClientAreaOrigin</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ClientAreaOrigin" title="Permalink to this definition">¶</a></dt> 300 <dd><p>See <cite>GetClientAreaOrigin</cite></p> 301 </dd></dl> 302 303 <dl class="attribute"> 304 <dt id="sans.guiframe.gui_manager.DefaultPanel.ClientRect"> 305 <tt class="descname">ClientRect</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ClientRect" title="Permalink to this definition">¶</a></dt> 306 <dd><p>See <cite>GetClientRect</cite> and <cite>SetClientRect</cite></p> 307 </dd></dl> 308 309 <dl class="attribute"> 310 <dt id="sans.guiframe.gui_manager.DefaultPanel.ClientSize"> 311 <tt class="descname">ClientSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ClientSize" title="Permalink to this definition">¶</a></dt> 312 <dd><p>See <cite>GetClientSize</cite> and <cite>SetClientSize</cite></p> 313 </dd></dl> 314 315 <dl class="method"> 316 <dt id="sans.guiframe.gui_manager.DefaultPanel.ClientToScreen"> 317 <tt class="descname">ClientToScreen</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ClientToScreen" title="Permalink to this definition">¶</a></dt> 318 <dd><p>Converts to screen coordinates from coordinates relative to this window.</p> 319 </dd></dl> 320 321 <dl class="method"> 322 <dt id="sans.guiframe.gui_manager.DefaultPanel.ClientToScreenXY"> 323 <tt class="descname">ClientToScreenXY</tt><big>(</big><em>int x</em>, <em>int y) -> (x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ClientToScreenXY" title="Permalink to this definition">¶</a></dt> 324 <dd><p>Converts to screen coordinates from coordinates relative to this window.</p> 325 </dd></dl> 326 327 <dl class="method"> 328 <dt id="sans.guiframe.gui_manager.DefaultPanel.ClientToWindowSize"> 329 <tt class="descname">ClientToWindowSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ClientToWindowSize" title="Permalink to this definition">¶</a></dt> 330 <dd></dd></dl> 331 332 <dl class="method"> 333 <dt id="sans.guiframe.gui_manager.DefaultPanel.Close"> 334 <tt class="descname">Close</tt><big>(</big><em>self</em>, <em>bool force=False</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Close" title="Permalink to this definition">¶</a></dt> 335 <dd><p>This function simply generates a EVT_CLOSE event whose handler usually 336 tries to close the window. It doesn’t close the window itself, 337 however. If force is False (the default) then the window’s close 338 handler will be allowed to veto the destruction of the window.</p> 339 </dd></dl> 340 341 <dl class="method"> 342 <dt id="sans.guiframe.gui_manager.DefaultPanel.Connect"> 343 <tt class="descname">Connect</tt><big>(</big><em>self</em>, <em>int id</em>, <em>int lastId</em>, <em>int eventType</em>, <em>PyObject func</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Connect" title="Permalink to this definition">¶</a></dt> 344 <dd></dd></dl> 345 346 <dl class="attribute"> 347 <dt id="sans.guiframe.gui_manager.DefaultPanel.Constraints"> 348 <tt class="descname">Constraints</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Constraints" title="Permalink to this definition">¶</a></dt> 349 <dd><p>See <cite>GetConstraints</cite> and <cite>SetConstraints</cite></p> 350 </dd></dl> 351 352 <dl class="attribute"> 353 <dt id="sans.guiframe.gui_manager.DefaultPanel.ContainingSizer"> 354 <tt class="descname">ContainingSizer</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ContainingSizer" title="Permalink to this definition">¶</a></dt> 355 <dd><p>See <cite>GetContainingSizer</cite> and <cite>SetContainingSizer</cite></p> 356 </dd></dl> 357 358 <dl class="method"> 359 <dt id="sans.guiframe.gui_manager.DefaultPanel.ConvertDialogPointToPixels"> 360 <tt class="descname">ConvertDialogPointToPixels</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ConvertDialogPointToPixels" title="Permalink to this definition">¶</a></dt> 361 <dd><p>Converts a point or size from dialog units to pixels. Dialog units 362 are used for maintaining a dialog’s proportions even if the font 363 changes. For the x dimension, the dialog units are multiplied by the 364 average character width and then divided by 4. For the y dimension, 365 the dialog units are multiplied by the average character height and 366 then divided by 8.</p> 367 </dd></dl> 368 369 <dl class="method"> 370 <dt id="sans.guiframe.gui_manager.DefaultPanel.ConvertDialogSizeToPixels"> 371 <tt class="descname">ConvertDialogSizeToPixels</tt><big>(</big><em>self</em>, <em>Size sz</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ConvertDialogSizeToPixels" title="Permalink to this definition">¶</a></dt> 372 <dd><p>Converts a point or size from dialog units to pixels. Dialog units 373 are used for maintaining a dialog’s proportions even if the font 374 changes. For the x dimension, the dialog units are multiplied by the 375 average character width and then divided by 4. For the y dimension, 376 the dialog units are multiplied by the average character height and 377 then divided by 8.</p> 378 </dd></dl> 379 380 <dl class="method"> 381 <dt id="sans.guiframe.gui_manager.DefaultPanel.ConvertPixelPointToDialog"> 382 <tt class="descname">ConvertPixelPointToDialog</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ConvertPixelPointToDialog" title="Permalink to this definition">¶</a></dt> 383 <dd></dd></dl> 384 385 <dl class="method"> 386 <dt id="sans.guiframe.gui_manager.DefaultPanel.ConvertPixelSizeToDialog"> 387 <tt class="descname">ConvertPixelSizeToDialog</tt><big>(</big><em>self</em>, <em>Size sz</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ConvertPixelSizeToDialog" title="Permalink to this definition">¶</a></dt> 388 <dd></dd></dl> 389 390 <dl class="method"> 391 <dt id="sans.guiframe.gui_manager.DefaultPanel.Create"> 392 <tt class="descname">Create</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Create" title="Permalink to this definition">¶</a></dt> 393 <dd><dl class="docutils"> 394 <dt>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, </dt> 395 <dd>Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, 396 String name=PanelNameStr) -> bool</dd> 397 </dl> 398 <p>Create the GUI part of the Window for 2-phase creation mode.</p> 399 </dd></dl> 400 401 <dl class="attribute"> 402 <dt id="sans.guiframe.gui_manager.DefaultPanel.Cursor"> 403 <tt class="descname">Cursor</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Cursor" title="Permalink to this definition">¶</a></dt> 404 <dd><p>See <cite>GetCursor</cite> and <cite>SetCursor</cite></p> 405 </dd></dl> 406 407 <dl class="method"> 408 <dt id="sans.guiframe.gui_manager.DefaultPanel.DLG_PNT"> 409 <tt class="descname">DLG_PNT</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.DLG_PNT" title="Permalink to this definition">¶</a></dt> 410 <dd><p>Converts a point or size from dialog units to pixels. Dialog units 411 are used for maintaining a dialog’s proportions even if the font 412 changes. For the x dimension, the dialog units are multiplied by the 413 average character width and then divided by 4. For the y dimension, 414 the dialog units are multiplied by the average character height and 415 then divided by 8.</p> 416 </dd></dl> 417 418 <dl class="method"> 419 <dt id="sans.guiframe.gui_manager.DefaultPanel.DLG_SZE"> 420 <tt class="descname">DLG_SZE</tt><big>(</big><em>self</em>, <em>Size sz</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.DLG_SZE" title="Permalink to this definition">¶</a></dt> 421 <dd><p>Converts a point or size from dialog units to pixels. Dialog units 422 are used for maintaining a dialog’s proportions even if the font 423 changes. For the x dimension, the dialog units are multiplied by the 424 average character width and then divided by 4. For the y dimension, 425 the dialog units are multiplied by the average character height and 426 then divided by 8.</p> 427 </dd></dl> 428 429 <dl class="attribute"> 430 <dt id="sans.guiframe.gui_manager.DefaultPanel.DefaultAttributes"> 431 <tt class="descname">DefaultAttributes</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.DefaultAttributes" title="Permalink to this definition">¶</a></dt> 432 <dd><p>See <cite>GetDefaultAttributes</cite></p> 433 </dd></dl> 434 435 <dl class="method"> 436 <dt id="sans.guiframe.gui_manager.DefaultPanel.Destroy"> 437 <tt class="descname">Destroy</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Destroy" title="Permalink to this definition">¶</a></dt> 438 <dd><p>Destroys the window safely. Frames and dialogs are not destroyed 439 immediately when this function is called – they are added to a list 440 of windows to be deleted on idle time, when all the window’s events 441 have been processed. This prevents problems with events being sent to 442 non-existent windows.</p> 443 <p>Returns True if the window has either been successfully deleted, or it 444 has been added to the list of windows pending real deletion.</p> 445 </dd></dl> 446 447 <dl class="method"> 448 <dt id="sans.guiframe.gui_manager.DefaultPanel.DestroyChildren"> 449 <tt class="descname">DestroyChildren</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.DestroyChildren" title="Permalink to this definition">¶</a></dt> 450 <dd><p>Destroys all children of a window. Called automatically by the 451 destructor.</p> 452 </dd></dl> 453 454 <dl class="method"> 455 <dt id="sans.guiframe.gui_manager.DefaultPanel.Disable"> 456 <tt class="descname">Disable</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Disable" title="Permalink to this definition">¶</a></dt> 457 <dd><p>Disables the window, same as Enable(false).</p> 458 </dd></dl> 459 460 <dl class="method"> 461 <dt id="sans.guiframe.gui_manager.DefaultPanel.Disconnect"> 462 <tt class="descname">Disconnect</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Disconnect" title="Permalink to this definition">¶</a></dt> 463 <dd><p>Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, 464 PyObject func=None) -> bool</p> 465 </dd></dl> 466 467 <dl class="method"> 468 <dt id="sans.guiframe.gui_manager.DefaultPanel.DissociateHandle"> 469 <tt class="descname">DissociateHandle</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.DissociateHandle" title="Permalink to this definition">¶</a></dt> 470 <dd><p>Dissociate the current native handle from the window</p> 471 </dd></dl> 472 473 <dl class="method"> 474 <dt id="sans.guiframe.gui_manager.DefaultPanel.DragAcceptFiles"> 475 <tt class="descname">DragAcceptFiles</tt><big>(</big><em>self</em>, <em>bool accept</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.DragAcceptFiles" title="Permalink to this definition">¶</a></dt> 476 <dd><p>Enables or disables eligibility for drop file events, EVT_DROP_FILES.</p> 477 </dd></dl> 478 479 <dl class="attribute"> 480 <dt id="sans.guiframe.gui_manager.DefaultPanel.DropTarget"> 481 <tt class="descname">DropTarget</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.DropTarget" title="Permalink to this definition">¶</a></dt> 482 <dd><p>See <cite>GetDropTarget</cite> and <cite>SetDropTarget</cite></p> 483 </dd></dl> 484 485 <dl class="attribute"> 486 <dt id="sans.guiframe.gui_manager.DefaultPanel.EffectiveMinSize"> 487 <tt class="descname">EffectiveMinSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.EffectiveMinSize" title="Permalink to this definition">¶</a></dt> 488 <dd><p>See <cite>GetEffectiveMinSize</cite></p> 489 </dd></dl> 490 491 <dl class="method"> 492 <dt id="sans.guiframe.gui_manager.DefaultPanel.Enable"> 493 <tt class="descname">Enable</tt><big>(</big><em>self</em>, <em>bool enable=True</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Enable" title="Permalink to this definition">¶</a></dt> 494 <dd><p>Enable or disable the window for user input. Note that when a parent 495 window is disabled, all of its children are disabled as well and they 496 are reenabled again when the parent is. Returns true if the window 497 has been enabled or disabled, false if nothing was done, i.e. if the 498 window had already been in the specified state.</p> 499 </dd></dl> 500 501 <dl class="attribute"> 502 <dt id="sans.guiframe.gui_manager.DefaultPanel.Enabled"> 503 <tt class="descname">Enabled</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Enabled" title="Permalink to this definition">¶</a></dt> 504 <dd><p>See <cite>IsEnabled</cite> and <cite>Enable</cite></p> 505 </dd></dl> 506 507 <dl class="attribute"> 508 <dt id="sans.guiframe.gui_manager.DefaultPanel.EventHandler"> 509 <tt class="descname">EventHandler</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.EventHandler" title="Permalink to this definition">¶</a></dt> 510 <dd><p>See <cite>GetEventHandler</cite> and <cite>SetEventHandler</cite></p> 511 </dd></dl> 512 513 <dl class="attribute"> 514 <dt id="sans.guiframe.gui_manager.DefaultPanel.EvtHandlerEnabled"> 515 <tt class="descname">EvtHandlerEnabled</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.EvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 516 <dd><p>See <cite>GetEvtHandlerEnabled</cite> and <cite>SetEvtHandlerEnabled</cite></p> 517 </dd></dl> 518 519 <dl class="attribute"> 520 <dt id="sans.guiframe.gui_manager.DefaultPanel.ExtraStyle"> 521 <tt class="descname">ExtraStyle</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ExtraStyle" title="Permalink to this definition">¶</a></dt> 522 <dd><p>See <cite>GetExtraStyle</cite> and <cite>SetExtraStyle</cite></p> 523 </dd></dl> 524 525 <dl class="staticmethod"> 526 <dt id="sans.guiframe.gui_manager.DefaultPanel.FindFocus"> 527 <em class="property">static </em><tt class="descname">FindFocus</tt><big>(</big><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.FindFocus" title="Permalink to this definition">¶</a></dt> 528 <dd><p>Returns the window or control that currently has the keyboard focus, 529 or None.</p> 530 </dd></dl> 531 532 <dl class="method"> 533 <dt id="sans.guiframe.gui_manager.DefaultPanel.FindWindowById"> 534 <tt class="descname">FindWindowById</tt><big>(</big><em>self</em>, <em>long winid</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.FindWindowById" title="Permalink to this definition">¶</a></dt> 535 <dd><p>Find a child of this window by window ID</p> 536 </dd></dl> 537 538 <dl class="method"> 539 <dt id="sans.guiframe.gui_manager.DefaultPanel.FindWindowByLabel"> 540 <tt class="descname">FindWindowByLabel</tt><big>(</big><em>self</em>, <em>String label</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.FindWindowByLabel" title="Permalink to this definition">¶</a></dt> 541 <dd><p>Find a child of this window by label</p> 542 </dd></dl> 543 544 <dl class="method"> 545 <dt id="sans.guiframe.gui_manager.DefaultPanel.FindWindowByName"> 546 <tt class="descname">FindWindowByName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.FindWindowByName" title="Permalink to this definition">¶</a></dt> 547 <dd><p>Find a child of this window by name</p> 548 </dd></dl> 549 550 <dl class="method"> 551 <dt id="sans.guiframe.gui_manager.DefaultPanel.Fit"> 552 <tt class="descname">Fit</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Fit" title="Permalink to this definition">¶</a></dt> 553 <dd><p>Sizes the window so that it fits around its subwindows. This function 554 won’t do anything if there are no subwindows and will only really work 555 correctly if sizers are used for the subwindows layout. Also, if the 556 window has exactly one subwindow it is better (faster and the result 557 is more precise as Fit adds some margin to account for fuzziness of 558 its calculations) to call window.SetClientSize(child.GetSize()) 559 instead of calling Fit.</p> 560 </dd></dl> 561 562 <dl class="method"> 563 <dt id="sans.guiframe.gui_manager.DefaultPanel.FitInside"> 564 <tt class="descname">FitInside</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.FitInside" title="Permalink to this definition">¶</a></dt> 565 <dd><p>Similar to Fit, but sizes the interior (virtual) size of a 566 window. Mainly useful with scrolled windows to reset scrollbars after 567 sizing changes that do not trigger a size event, and/or scrolled 568 windows without an interior sizer. This function similarly won’t do 569 anything if there are no subwindows.</p> 570 </dd></dl> 571 572 <dl class="attribute"> 573 <dt id="sans.guiframe.gui_manager.DefaultPanel.Font"> 574 <tt class="descname">Font</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Font" title="Permalink to this definition">¶</a></dt> 575 <dd><p>See <cite>GetFont</cite> and <cite>SetFont</cite></p> 576 </dd></dl> 577 578 <dl class="attribute"> 579 <dt id="sans.guiframe.gui_manager.DefaultPanel.ForegroundColour"> 580 <tt class="descname">ForegroundColour</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ForegroundColour" title="Permalink to this definition">¶</a></dt> 581 <dd><p>See <cite>GetForegroundColour</cite> and <cite>SetForegroundColour</cite></p> 582 </dd></dl> 583 584 <dl class="method"> 585 <dt id="sans.guiframe.gui_manager.DefaultPanel.Freeze"> 586 <tt class="descname">Freeze</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Freeze" title="Permalink to this definition">¶</a></dt> 587 <dd><p>Freezes the window or, in other words, prevents any updates from 588 taking place on screen, the window is not redrawn at all. Thaw must be 589 called to reenable window redrawing. Calls to Freeze/Thaw may be 590 nested, with the actual Thaw being delayed until all the nesting has 591 been undone.</p> 592 <p>This method is useful for visual appearance optimization (for example, 593 it is a good idea to use it before inserting large amount of text into 594 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor 595 for all controls so it is mostly just a hint to wxWindows and not a 596 mandatory directive.</p> 597 </dd></dl> 598 599 <dl class="method"> 600 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetAcceleratorTable"> 601 <tt class="descname">GetAcceleratorTable</tt><big>(</big><em>self</em><big>)</big> → AcceleratorTable<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetAcceleratorTable" title="Permalink to this definition">¶</a></dt> 602 <dd><p>Gets the accelerator table for this window.</p> 603 </dd></dl> 604 605 <dl class="method"> 606 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetAdjustedBestSize"> 607 <tt class="descname">GetAdjustedBestSize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetAdjustedBestSize" title="Permalink to this definition">¶</a></dt> 608 <dd><p>Use <cite>GetEffectiveMinSize</cite> instead.</p> 609 </dd></dl> 610 611 <dl class="method"> 612 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetAutoLayout"> 613 <tt class="descname">GetAutoLayout</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetAutoLayout" title="Permalink to this definition">¶</a></dt> 614 <dd><p>Returns the current autoLayout setting</p> 615 </dd></dl> 616 617 <dl class="method"> 618 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetBackgroundColour"> 619 <tt class="descname">GetBackgroundColour</tt><big>(</big><em>self</em><big>)</big> → Colour<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetBackgroundColour" title="Permalink to this definition">¶</a></dt> 620 <dd><p>Returns the background colour of the window.</p> 621 </dd></dl> 622 623 <dl class="method"> 624 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetBackgroundStyle"> 625 <tt class="descname">GetBackgroundStyle</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetBackgroundStyle" title="Permalink to this definition">¶</a></dt> 626 <dd><p>Returns the background style of the window.</p> 627 <table class="docutils field-list" frame="void" rules="none"> 628 <col class="field-name" /> 629 <col class="field-body" /> 630 <tbody valign="top"> 631 <tr class="field-odd field"><th class="field-name">See :</th><td class="field-body"><cite>SetBackgroundStyle</cite></td> 632 </tr> 633 </tbody> 634 </table> 635 </dd></dl> 636 637 <dl class="method"> 638 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetBestFittingSize"> 639 <tt class="descname">GetBestFittingSize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetBestFittingSize" title="Permalink to this definition">¶</a></dt> 640 <dd><p>Use <cite>GetEffectiveMinSize</cite> instead.</p> 641 </dd></dl> 642 643 <dl class="method"> 644 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetBestSize"> 645 <tt class="descname">GetBestSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetBestSize" title="Permalink to this definition">¶</a></dt> 646 <dd><p>This function returns the best acceptable minimal size for the 647 window, if applicable. For example, for a static text control, it will 648 be the minimal size such that the control label is not truncated. For 649 windows containing subwindows (such as wx.Panel), the size returned by 650 this function will be the same as the size the window would have had 651 after calling Fit.</p> 652 </dd></dl> 653 654 <dl class="method"> 655 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetBestSizeTuple"> 656 <tt class="descname">GetBestSizeTuple</tt><big>(</big><em>) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetBestSizeTuple" title="Permalink to this definition">¶</a></dt> 657 <dd><p>This function returns the best acceptable minimal size for the 658 window, if applicable. For example, for a static text control, it will 659 be the minimal size such that the control label is not truncated. For 660 windows containing subwindows (such as wx.Panel), the size returned by 661 this function will be the same as the size the window would have had 662 after calling Fit.</p> 663 </dd></dl> 664 665 <dl class="method"> 666 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetBestVirtualSize"> 667 <tt class="descname">GetBestVirtualSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetBestVirtualSize" title="Permalink to this definition">¶</a></dt> 668 <dd><p>Return the largest of ClientSize and BestSize (as determined by a 669 sizer, interior children, or other means)</p> 670 </dd></dl> 671 672 <dl class="method"> 673 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetBorder"> 674 <tt class="descname">GetBorder</tt><big>(</big><em>self</em>, <em>long flags</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetBorder" title="Permalink to this definition">¶</a></dt> 675 <dd><p>GetBorder(self) -> int</p> 676 <p>Get border for the flags of this window</p> 677 </dd></dl> 678 679 <dl class="staticmethod"> 680 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetCapture"> 681 <em class="property">static </em><tt class="descname">GetCapture</tt><big>(</big><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetCapture" title="Permalink to this definition">¶</a></dt> 682 <dd><p>Returns the window which currently captures the mouse or None</p> 683 </dd></dl> 684 685 <dl class="method"> 686 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetCaret"> 687 <tt class="descname">GetCaret</tt><big>(</big><em>self</em><big>)</big> → Caret<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetCaret" title="Permalink to this definition">¶</a></dt> 688 <dd><p>Returns the caret associated with the window.</p> 689 </dd></dl> 690 691 <dl class="method"> 692 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetCharHeight"> 693 <tt class="descname">GetCharHeight</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetCharHeight" title="Permalink to this definition">¶</a></dt> 694 <dd><p>Get the (average) character size for the current font.</p> 695 </dd></dl> 696 697 <dl class="method"> 698 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetCharWidth"> 699 <tt class="descname">GetCharWidth</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetCharWidth" title="Permalink to this definition">¶</a></dt> 700 <dd><p>Get the (average) character size for the current font.</p> 701 </dd></dl> 702 703 <dl class="method"> 704 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetChildren"> 705 <tt class="descname">GetChildren</tt><big>(</big><em>self</em><big>)</big> → WindowList<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetChildren" title="Permalink to this definition">¶</a></dt> 706 <dd><p>Returns an object containing a list of the window’s children. The 707 object provides a Python sequence-like interface over the internal 708 list maintained by the window..</p> 709 </dd></dl> 710 711 <dl class="staticmethod"> 712 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetClassDefaultAttributes"> 713 <em class="property">static </em><tt class="descname">GetClassDefaultAttributes</tt><big>(</big><em>int variant=WINDOW_VARIANT_NORMAL</em><big>)</big> → VisualAttributes<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetClassDefaultAttributes" title="Permalink to this definition">¶</a></dt> 714 <dd><p>Get the default attributes for this class. This is useful if you want 715 to use the same font or colour in your own control as in a standard 716 control – which is a much better idea than hard coding specific 717 colours or fonts which might look completely out of place on the 718 user’s system, especially if it uses themes.</p> 719 <p>The variant parameter is only relevant under Mac currently and is 720 ignore under other platforms. Under Mac, it will change the size of 721 the returned font. See <cite>wx.Window.SetWindowVariant</cite> for more about 722 this.</p> 723 </dd></dl> 724 725 <dl class="method"> 726 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetClassName"> 727 <tt class="descname">GetClassName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetClassName" title="Permalink to this definition">¶</a></dt> 728 <dd><p>Returns the class name of the C++ class using wxRTTI.</p> 729 </dd></dl> 730 731 <dl class="method"> 732 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetClientAreaOrigin"> 733 <tt class="descname">GetClientAreaOrigin</tt><big>(</big><em>self</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetClientAreaOrigin" title="Permalink to this definition">¶</a></dt> 734 <dd><p>Get the origin of the client area of the window relative to the 735 window’s top left corner (the client area may be shifted because of 736 the borders, scrollbars, other decorations...)</p> 737 </dd></dl> 738 739 <dl class="method"> 740 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetClientRect"> 741 <tt class="descname">GetClientRect</tt><big>(</big><em>self</em><big>)</big> → Rect<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetClientRect" title="Permalink to this definition">¶</a></dt> 742 <dd><p>Get the client area position and size as a <cite>wx.Rect</cite> object.</p> 743 </dd></dl> 744 745 <dl class="method"> 746 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetClientSize"> 747 <tt class="descname">GetClientSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetClientSize" title="Permalink to this definition">¶</a></dt> 748 <dd><p>This gets the size of the window’s ‘client area’ in pixels. The client 749 area is the area which may be drawn on by the programmer, excluding 750 title bar, border, scrollbars, etc.</p> 751 </dd></dl> 752 753 <dl class="method"> 754 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetClientSizeTuple"> 755 <tt class="descname">GetClientSizeTuple</tt><big>(</big><em>) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetClientSizeTuple" title="Permalink to this definition">¶</a></dt> 756 <dd><p>This gets the size of the window’s ‘client area’ in pixels. The client 757 area is the area which may be drawn on by the programmer, excluding 758 title bar, border, scrollbars, etc.</p> 759 </dd></dl> 760 761 <dl class="method"> 762 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetConstraints"> 763 <tt class="descname">GetConstraints</tt><big>(</big><em>self</em><big>)</big> → LayoutConstraints<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetConstraints" title="Permalink to this definition">¶</a></dt> 764 <dd><p>Returns a pointer to the window’s layout constraints, or None if there 765 are none.</p> 766 </dd></dl> 767 768 <dl class="method"> 769 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetContainingSizer"> 770 <tt class="descname">GetContainingSizer</tt><big>(</big><em>self</em><big>)</big> → Sizer<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetContainingSizer" title="Permalink to this definition">¶</a></dt> 771 <dd><p>Return the sizer that this window is a member of, if any, otherwise None.</p> 772 </dd></dl> 773 774 <dl class="method"> 775 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetCursor"> 776 <tt class="descname">GetCursor</tt><big>(</big><em>self</em><big>)</big> → Cursor<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetCursor" title="Permalink to this definition">¶</a></dt> 777 <dd><p>Return the cursor associated with this window.</p> 778 </dd></dl> 779 780 <dl class="method"> 781 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetDefaultAttributes"> 782 <tt class="descname">GetDefaultAttributes</tt><big>(</big><em>self</em><big>)</big> → VisualAttributes<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetDefaultAttributes" title="Permalink to this definition">¶</a></dt> 783 <dd><p>Get the default attributes for an instance of this class. This is 784 useful if you want to use the same font or colour in your own control 785 as in a standard control – which is a much better idea than hard 786 coding specific colours or fonts which might look completely out of 787 place on the user’s system, especially if it uses themes.</p> 788 </dd></dl> 789 790 <dl class="method"> 791 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetDropTarget"> 792 <tt class="descname">GetDropTarget</tt><big>(</big><em>self</em><big>)</big> → DropTarget<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetDropTarget" title="Permalink to this definition">¶</a></dt> 793 <dd><p>Returns the associated drop target, which may be None.</p> 794 </dd></dl> 795 796 <dl class="method"> 797 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetEffectiveMinSize"> 798 <tt class="descname">GetEffectiveMinSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetEffectiveMinSize" title="Permalink to this definition">¶</a></dt> 799 <dd><p>This function will merge the window’s best size into the window’s 800 minimum size, giving priority to the min size components, and returns 801 the results.</p> 802 </dd></dl> 803 804 <dl class="method"> 805 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetEventHandler"> 806 <tt class="descname">GetEventHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetEventHandler" title="Permalink to this definition">¶</a></dt> 807 <dd><p>Returns the event handler for this window. By default, the window is 808 its own event handler.</p> 809 </dd></dl> 810 811 <dl class="method"> 812 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetEvtHandlerEnabled"> 813 <tt class="descname">GetEvtHandlerEnabled</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 814 <dd></dd></dl> 815 816 <dl class="method"> 817 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetExtraStyle"> 818 <tt class="descname">GetExtraStyle</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetExtraStyle" title="Permalink to this definition">¶</a></dt> 819 <dd><p>Returns the extra style bits for the window.</p> 820 </dd></dl> 821 822 <dl class="method"> 823 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetFont"> 824 <tt class="descname">GetFont</tt><big>(</big><em>self</em><big>)</big> → Font<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetFont" title="Permalink to this definition">¶</a></dt> 825 <dd><p>Returns the default font used for this window.</p> 826 </dd></dl> 827 828 <dl class="method"> 829 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetForegroundColour"> 830 <tt class="descname">GetForegroundColour</tt><big>(</big><em>self</em><big>)</big> → Colour<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetForegroundColour" title="Permalink to this definition">¶</a></dt> 831 <dd><p>Returns the foreground colour of the window. The interpretation of 832 foreground colour is dependent on the window class; it may be the text 833 colour or other colour, or it may not be used at all.</p> 834 </dd></dl> 835 836 <dl class="method"> 837 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetFullTextExtent"> 838 <tt class="descname">GetFullTextExtent</tt><big>(</big><em>String string</em>, <em>Font font=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetFullTextExtent" title="Permalink to this definition">¶</a></dt> 839 <dd><blockquote> 840 <div>(width, height, descent, externalLeading)</div></blockquote> 841 <p>Get the width, height, decent and leading of the text using the 842 current or specified font.</p> 843 </dd></dl> 844 845 <dl class="method"> 846 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetGrandParent"> 847 <tt class="descname">GetGrandParent</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetGrandParent" title="Permalink to this definition">¶</a></dt> 848 <dd><p>Returns the parent of the parent of this window, or None if there 849 isn’t one.</p> 850 </dd></dl> 851 852 <dl class="method"> 853 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetGtkWidget"> 854 <tt class="descname">GetGtkWidget</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetGtkWidget" title="Permalink to this definition">¶</a></dt> 855 <dd><p>On wxGTK returns a pointer to the GtkWidget for this window as a long 856 integer. On the other platforms this method returns zero.</p> 857 </dd></dl> 858 859 <dl class="method"> 860 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetHandle"> 861 <tt class="descname">GetHandle</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetHandle" title="Permalink to this definition">¶</a></dt> 862 <dd><p>Returns the platform-specific handle (as a long integer) of the 863 physical window. On wxMSW this is the win32 window handle, on wxGTK 864 it is the XWindow ID, and on wxMac it is the ControlRef.</p> 865 </dd></dl> 866 867 <dl class="method"> 868 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetHelpText"> 869 <tt class="descname">GetHelpText</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetHelpText" title="Permalink to this definition">¶</a></dt> 870 <dd><p>Gets the help text to be used as context-sensitive help for this 871 window. Note that the text is actually stored by the current 872 <cite>wx.HelpProvider</cite> implementation, and not in the window object itself.</p> 873 </dd></dl> 874 875 <dl class="method"> 876 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetHelpTextAtPoint"> 877 <tt class="descname">GetHelpTextAtPoint</tt><big>(</big><em>self</em>, <em>Point pt</em>, <em>wxHelpEvent::Origin origin</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetHelpTextAtPoint" title="Permalink to this definition">¶</a></dt> 878 <dd><p>Get the help string associated with the given position in this window.</p> 879 <p>Notice that pt may be invalid if event origin is keyboard or unknown 880 and this method should return the global window help text then</p> 881 </dd></dl> 882 883 <dl class="method"> 884 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetId"> 885 <tt class="descname">GetId</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetId" title="Permalink to this definition">¶</a></dt> 886 <dd><p>Returns the identifier of the window. Each window has an integer 887 identifier. If the application has not provided one (or the default Id 888 -1 is used) then an unique identifier with a negative value will be 889 generated.</p> 890 </dd></dl> 891 892 <dl class="method"> 893 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetLabel"> 894 <tt class="descname">GetLabel</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetLabel" title="Permalink to this definition">¶</a></dt> 895 <dd><p>Generic way of getting a label from any window, for identification 896 purposes. The interpretation of this function differs from class to 897 class. For frames and dialogs, the value returned is the title. For 898 buttons or static text controls, it is the button text. This function 899 can be useful for meta-programs such as testing tools or special-needs 900 access programs)which need to identify windows by name.</p> 901 </dd></dl> 902 903 <dl class="method"> 904 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetLayoutDirection"> 905 <tt class="descname">GetLayoutDirection</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetLayoutDirection" title="Permalink to this definition">¶</a></dt> 906 <dd><p>Get the layout direction (LTR or RTL) for this window. Returns 907 <tt class="docutils literal"><span class="pre">wx.Layout_Default</span></tt> if layout direction is not supported.</p> 908 </dd></dl> 909 910 <dl class="method"> 911 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetMaxHeight"> 912 <tt class="descname">GetMaxHeight</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetMaxHeight" title="Permalink to this definition">¶</a></dt> 913 <dd></dd></dl> 914 915 <dl class="method"> 916 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetMaxSize"> 917 <tt class="descname">GetMaxSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetMaxSize" title="Permalink to this definition">¶</a></dt> 918 <dd></dd></dl> 919 920 <dl class="method"> 921 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetMaxWidth"> 922 <tt class="descname">GetMaxWidth</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetMaxWidth" title="Permalink to this definition">¶</a></dt> 923 <dd></dd></dl> 924 925 <dl class="method"> 926 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetMinHeight"> 927 <tt class="descname">GetMinHeight</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetMinHeight" title="Permalink to this definition">¶</a></dt> 928 <dd></dd></dl> 929 930 <dl class="method"> 931 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetMinSize"> 932 <tt class="descname">GetMinSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetMinSize" title="Permalink to this definition">¶</a></dt> 933 <dd></dd></dl> 934 935 <dl class="method"> 936 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetMinWidth"> 937 <tt class="descname">GetMinWidth</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetMinWidth" title="Permalink to this definition">¶</a></dt> 938 <dd></dd></dl> 939 940 <dl class="method"> 941 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetName"> 942 <tt class="descname">GetName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetName" title="Permalink to this definition">¶</a></dt> 943 <dd><p>Returns the windows name. This name is not guaranteed to be unique; 944 it is up to the programmer to supply an appropriate name in the window 945 constructor or via wx.Window.SetName.</p> 946 </dd></dl> 947 948 <dl class="method"> 949 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetNextHandler"> 950 <tt class="descname">GetNextHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetNextHandler" title="Permalink to this definition">¶</a></dt> 951 <dd></dd></dl> 952 953 <dl class="method"> 954 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetParent"> 955 <tt class="descname">GetParent</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetParent" title="Permalink to this definition">¶</a></dt> 956 <dd><p>Returns the parent window of this window, or None if there isn’t one.</p> 957 </dd></dl> 958 959 <dl class="method"> 960 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetPosition"> 961 <tt class="descname">GetPosition</tt><big>(</big><em>self</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetPosition" title="Permalink to this definition">¶</a></dt> 962 <dd><p>Get the window’s position. Notice that the position is in client 963 coordinates for child windows and screen coordinates for the top level 964 ones, use <cite>GetScreenPosition</cite> if you need screen coordinates for all 965 kinds of windows.</p> 966 </dd></dl> 967 968 <dl class="method"> 969 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetPositionTuple"> 970 <tt class="descname">GetPositionTuple</tt><big>(</big><em>) -> (x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetPositionTuple" title="Permalink to this definition">¶</a></dt> 971 <dd><p>Get the window’s position. Notice that the position is in client 972 coordinates for child windows and screen coordinates for the top level 973 ones, use <cite>GetScreenPosition</cite> if you need screen coordinates for all 974 kinds of windows.</p> 975 </dd></dl> 976 977 <dl class="method"> 978 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetPreviousHandler"> 979 <tt class="descname">GetPreviousHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetPreviousHandler" title="Permalink to this definition">¶</a></dt> 980 <dd></dd></dl> 981 982 <dl class="method"> 983 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetRect"> 984 <tt class="descname">GetRect</tt><big>(</big><em>self</em><big>)</big> → Rect<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetRect" title="Permalink to this definition">¶</a></dt> 985 <dd><p>Returns the size and position of the window as a <cite>wx.Rect</cite> object.</p> 986 </dd></dl> 987 988 <dl class="method"> 989 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetScreenPosition"> 990 <tt class="descname">GetScreenPosition</tt><big>(</big><em>self</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetScreenPosition" title="Permalink to this definition">¶</a></dt> 991 <dd><p>Get the position of the window in screen coordinantes.</p> 992 </dd></dl> 993 994 <dl class="method"> 995 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetScreenPositionTuple"> 996 <tt class="descname">GetScreenPositionTuple</tt><big>(</big><em>) -> (x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetScreenPositionTuple" title="Permalink to this definition">¶</a></dt> 997 <dd><p>Get the position of the window in screen coordinantes.</p> 998 </dd></dl> 999 1000 <dl class="method"> 1001 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetScreenRect"> 1002 <tt class="descname">GetScreenRect</tt><big>(</big><em>self</em><big>)</big> → Rect<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetScreenRect" title="Permalink to this definition">¶</a></dt> 1003 <dd><p>Returns the size and position of the window in screen coordinantes as 1004 a <cite>wx.Rect</cite> object.</p> 1005 </dd></dl> 1006 1007 <dl class="method"> 1008 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetScrollPos"> 1009 <tt class="descname">GetScrollPos</tt><big>(</big><em>self</em>, <em>int orientation</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetScrollPos" title="Permalink to this definition">¶</a></dt> 1010 <dd><p>Returns the built-in scrollbar position.</p> 1011 </dd></dl> 1012 1013 <dl class="method"> 1014 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetScrollRange"> 1015 <tt class="descname">GetScrollRange</tt><big>(</big><em>self</em>, <em>int orientation</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetScrollRange" title="Permalink to this definition">¶</a></dt> 1016 <dd><p>Returns the built-in scrollbar range.</p> 1017 </dd></dl> 1018 1019 <dl class="method"> 1020 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetScrollThumb"> 1021 <tt class="descname">GetScrollThumb</tt><big>(</big><em>self</em>, <em>int orientation</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetScrollThumb" title="Permalink to this definition">¶</a></dt> 1022 <dd><p>Returns the built-in scrollbar thumb size.</p> 1023 </dd></dl> 1024 1025 <dl class="method"> 1026 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetSize"> 1027 <tt class="descname">GetSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetSize" title="Permalink to this definition">¶</a></dt> 1028 <dd><p>Get the window size.</p> 1029 </dd></dl> 1030 1031 <dl class="method"> 1032 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetSizeTuple"> 1033 <tt class="descname">GetSizeTuple</tt><big>(</big><em>) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetSizeTuple" title="Permalink to this definition">¶</a></dt> 1034 <dd><p>Get the window size.</p> 1035 </dd></dl> 1036 1037 <dl class="method"> 1038 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetSizer"> 1039 <tt class="descname">GetSizer</tt><big>(</big><em>self</em><big>)</big> → Sizer<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetSizer" title="Permalink to this definition">¶</a></dt> 1040 <dd><p>Return the sizer associated with the window by a previous call to 1041 SetSizer or None if there isn’t one.</p> 1042 </dd></dl> 1043 1044 <dl class="method"> 1045 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetTextExtent"> 1046 <tt class="descname">GetTextExtent</tt><big>(</big><em>String string) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetTextExtent" title="Permalink to this definition">¶</a></dt> 1047 <dd><p>Get the width and height of the text using the current font.</p> 1048 </dd></dl> 1049 1050 <dl class="method"> 1051 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetThemeEnabled"> 1052 <tt class="descname">GetThemeEnabled</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetThemeEnabled" title="Permalink to this definition">¶</a></dt> 1053 <dd><p>Return the themeEnabled flag.</p> 1054 </dd></dl> 1055 1056 <dl class="method"> 1057 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetToolTip"> 1058 <tt class="descname">GetToolTip</tt><big>(</big><em>self</em><big>)</big> → ToolTip<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetToolTip" title="Permalink to this definition">¶</a></dt> 1059 <dd><p>get the associated tooltip or None if none</p> 1060 </dd></dl> 1061 1062 <dl class="method"> 1063 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetTopLevelParent"> 1064 <tt class="descname">GetTopLevelParent</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetTopLevelParent" title="Permalink to this definition">¶</a></dt> 1065 <dd><p>Returns the first frame or dialog in this window’s parental hierarchy.</p> 1066 </dd></dl> 1067 1068 <dl class="method"> 1069 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetUpdateClientRect"> 1070 <tt class="descname">GetUpdateClientRect</tt><big>(</big><em>self</em><big>)</big> → Rect<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetUpdateClientRect" title="Permalink to this definition">¶</a></dt> 1071 <dd><p>Get the update rectangle region bounding box in client coords.</p> 1072 </dd></dl> 1073 1074 <dl class="method"> 1075 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetUpdateRegion"> 1076 <tt class="descname">GetUpdateRegion</tt><big>(</big><em>self</em><big>)</big> → Region<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetUpdateRegion" title="Permalink to this definition">¶</a></dt> 1077 <dd><p>Returns the region specifying which parts of the window have been 1078 damaged. Should only be called within an EVT_PAINT handler.</p> 1079 </dd></dl> 1080 1081 <dl class="method"> 1082 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetValidator"> 1083 <tt class="descname">GetValidator</tt><big>(</big><em>self</em><big>)</big> → Validator<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetValidator" title="Permalink to this definition">¶</a></dt> 1084 <dd><p>Returns a pointer to the current validator for the window, or None if 1085 there is none.</p> 1086 </dd></dl> 1087 1088 <dl class="method"> 1089 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetVirtualSize"> 1090 <tt class="descname">GetVirtualSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetVirtualSize" title="Permalink to this definition">¶</a></dt> 1091 <dd><p>Get the the virtual size of the window in pixels. For most windows 1092 this is just the client area of the window, but for some like scrolled 1093 windows it is more or less independent of the screen window size.</p> 1094 </dd></dl> 1095 1096 <dl class="method"> 1097 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetVirtualSizeTuple"> 1098 <tt class="descname">GetVirtualSizeTuple</tt><big>(</big><em>) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetVirtualSizeTuple" title="Permalink to this definition">¶</a></dt> 1099 <dd><p>Get the the virtual size of the window in pixels. For most windows 1100 this is just the client area of the window, but for some like scrolled 1101 windows it is more or less independent of the screen window size.</p> 1102 </dd></dl> 1103 1104 <dl class="method"> 1105 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetWindowBorderSize"> 1106 <tt class="descname">GetWindowBorderSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetWindowBorderSize" title="Permalink to this definition">¶</a></dt> 1107 <dd><p>Return the size of the left/right and top/bottom borders.</p> 1108 </dd></dl> 1109 1110 <dl class="method"> 1111 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetWindowStyle"> 1112 <tt class="descname">GetWindowStyle</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetWindowStyle" title="Permalink to this definition">¶</a></dt> 1113 <dd><p>GetWindowStyleFlag(self) -> long</p> 1114 <p>Gets the window style that was passed to the constructor or Create 1115 method.</p> 1116 </dd></dl> 1117 1118 <dl class="method"> 1119 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetWindowStyleFlag"> 1120 <tt class="descname">GetWindowStyleFlag</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetWindowStyleFlag" title="Permalink to this definition">¶</a></dt> 1121 <dd><p>Gets the window style that was passed to the constructor or Create 1122 method.</p> 1123 </dd></dl> 1124 1125 <dl class="method"> 1126 <dt id="sans.guiframe.gui_manager.DefaultPanel.GetWindowVariant"> 1127 <tt class="descname">GetWindowVariant</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GetWindowVariant" title="Permalink to this definition">¶</a></dt> 1128 <dd></dd></dl> 1129 1130 <dl class="attribute"> 1131 <dt id="sans.guiframe.gui_manager.DefaultPanel.GrandParent"> 1132 <tt class="descname">GrandParent</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GrandParent" title="Permalink to this definition">¶</a></dt> 1133 <dd><p>See <cite>GetGrandParent</cite></p> 1134 </dd></dl> 1135 1136 <dl class="attribute"> 1137 <dt id="sans.guiframe.gui_manager.DefaultPanel.GtkWidget"> 1138 <tt class="descname">GtkWidget</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.GtkWidget" title="Permalink to this definition">¶</a></dt> 1139 <dd><p>GetGtkWidget(self) -> long</p> 1140 <p>On wxGTK returns a pointer to the GtkWidget for this window as a long 1141 integer. On the other platforms this method returns zero.</p> 1142 </dd></dl> 1143 1144 <dl class="attribute"> 1145 <dt id="sans.guiframe.gui_manager.DefaultPanel.Handle"> 1146 <tt class="descname">Handle</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Handle" title="Permalink to this definition">¶</a></dt> 1147 <dd><p>See <cite>GetHandle</cite></p> 1148 </dd></dl> 1149 1150 <dl class="method"> 1151 <dt id="sans.guiframe.gui_manager.DefaultPanel.HasCapture"> 1152 <tt class="descname">HasCapture</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.HasCapture" title="Permalink to this definition">¶</a></dt> 1153 <dd><p>Returns true if this window has the current mouse capture.</p> 1154 </dd></dl> 1155 1156 <dl class="method"> 1157 <dt id="sans.guiframe.gui_manager.DefaultPanel.HasFlag"> 1158 <tt class="descname">HasFlag</tt><big>(</big><em>self</em>, <em>int flag</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.HasFlag" title="Permalink to this definition">¶</a></dt> 1159 <dd><p>Test if the given style is set for this window.</p> 1160 </dd></dl> 1161 1162 <dl class="method"> 1163 <dt id="sans.guiframe.gui_manager.DefaultPanel.HasMultiplePages"> 1164 <tt class="descname">HasMultiplePages</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.HasMultiplePages" title="Permalink to this definition">¶</a></dt> 1165 <dd></dd></dl> 1166 1167 <dl class="method"> 1168 <dt id="sans.guiframe.gui_manager.DefaultPanel.HasScrollbar"> 1169 <tt class="descname">HasScrollbar</tt><big>(</big><em>self</em>, <em>int orient</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.HasScrollbar" title="Permalink to this definition">¶</a></dt> 1170 <dd><p>Does the window have the scrollbar for this orientation?</p> 1171 </dd></dl> 1172 1173 <dl class="method"> 1174 <dt id="sans.guiframe.gui_manager.DefaultPanel.HasTransparentBackground"> 1175 <tt class="descname">HasTransparentBackground</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.HasTransparentBackground" title="Permalink to this definition">¶</a></dt> 1176 <dd><p>Returns True if this window’s background is transparent (as, for 1177 example, for <cite>wx.StaticText</cite>) and should show the parent window’s 1178 background.</p> 1179 <p>This method is mostly used internally by the library itself and you 1180 normally shouldn’t have to call it. You may, however, have to override 1181 it in your custom control classes to ensure that background is painted 1182 correctly.</p> 1183 </dd></dl> 1184 1185 <dl class="attribute"> 1186 <dt id="sans.guiframe.gui_manager.DefaultPanel.HelpText"> 1187 <tt class="descname">HelpText</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.HelpText" title="Permalink to this definition">¶</a></dt> 1188 <dd><p>See <cite>GetHelpText</cite> and <cite>SetHelpText</cite></p> 1189 </dd></dl> 1190 1191 <dl class="method"> 1192 <dt id="sans.guiframe.gui_manager.DefaultPanel.Hide"> 1193 <tt class="descname">Hide</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Hide" title="Permalink to this definition">¶</a></dt> 1194 <dd><p>Equivalent to calling Show(False).</p> 1195 </dd></dl> 1196 1197 <dl class="method"> 1198 <dt id="sans.guiframe.gui_manager.DefaultPanel.HitTest"> 1199 <tt class="descname">HitTest</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.HitTest" title="Permalink to this definition">¶</a></dt> 1200 <dd><p>Test where the given (in client coords) point lies</p> 1201 </dd></dl> 1202 1203 <dl class="method"> 1204 <dt id="sans.guiframe.gui_manager.DefaultPanel.HitTestXY"> 1205 <tt class="descname">HitTestXY</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int y</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.HitTestXY" title="Permalink to this definition">¶</a></dt> 1206 <dd><p>Test where the given (in client coords) point lies</p> 1207 </dd></dl> 1208 1209 <dl class="attribute"> 1210 <dt id="sans.guiframe.gui_manager.DefaultPanel.Id"> 1211 <tt class="descname">Id</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Id" title="Permalink to this definition">¶</a></dt> 1212 <dd><p>See <cite>GetId</cite> and <cite>SetId</cite></p> 1213 </dd></dl> 1214 1215 <dl class="method"> 1216 <dt id="sans.guiframe.gui_manager.DefaultPanel.InheritAttributes"> 1217 <tt class="descname">InheritAttributes</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.InheritAttributes" title="Permalink to this definition">¶</a></dt> 1218 <dd><p>This function is (or should be, in case of custom controls) called 1219 during window creation to intelligently set up the window visual 1220 attributes, that is the font and the foreground and background 1221 colours.</p> 1222 <p>By ‘intelligently’ the following is meant: by default, all windows use 1223 their own default attributes. However if some of the parent’s 1224 attributes are explicitly changed (that is, using SetFont and not 1225 SetOwnFont) and if the corresponding attribute hadn’t been 1226 explicitly set for this window itself, then this window takes the same 1227 value as used by the parent. In addition, if the window overrides 1228 ShouldInheritColours to return false, the colours will not be changed 1229 no matter what and only the font might.</p> 1230 <p>This rather complicated logic is necessary in order to accommodate the 1231 different usage scenarios. The most common one is when all default 1232 attributes are used and in this case, nothing should be inherited as 1233 in modern GUIs different controls use different fonts (and colours) 1234 than their siblings so they can’t inherit the same value from the 1235 parent. However it was also deemed desirable to allow to simply change 1236 the attributes of all children at once by just changing the font or 1237 colour of their common parent, hence in this case we do inherit the 1238 parents attributes.</p> 1239 </dd></dl> 1240 1241 <dl class="method"> 1242 <dt id="sans.guiframe.gui_manager.DefaultPanel.InheritsBackgroundColour"> 1243 <tt class="descname">InheritsBackgroundColour</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.InheritsBackgroundColour" title="Permalink to this definition">¶</a></dt> 1244 <dd></dd></dl> 1245 1246 <dl class="method"> 1247 <dt id="sans.guiframe.gui_manager.DefaultPanel.InitDialog"> 1248 <tt class="descname">InitDialog</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.InitDialog" title="Permalink to this definition">¶</a></dt> 1249 <dd><p>Sends an EVT_INIT_DIALOG event, whose handler usually transfers data 1250 to the dialog via validators.</p> 1251 </dd></dl> 1252 1253 <dl class="method"> 1254 <dt id="sans.guiframe.gui_manager.DefaultPanel.InvalidateBestSize"> 1255 <tt class="descname">InvalidateBestSize</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.InvalidateBestSize" title="Permalink to this definition">¶</a></dt> 1256 <dd><p>Reset the cached best size value so it will be recalculated the next 1257 time it is needed.</p> 1258 </dd></dl> 1259 1260 <dl class="method"> 1261 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsBeingDeleted"> 1262 <tt class="descname">IsBeingDeleted</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsBeingDeleted" title="Permalink to this definition">¶</a></dt> 1263 <dd><p>Is the window in the process of being deleted?</p> 1264 </dd></dl> 1265 1266 <dl class="method"> 1267 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsDoubleBuffered"> 1268 <tt class="descname">IsDoubleBuffered</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsDoubleBuffered" title="Permalink to this definition">¶</a></dt> 1269 <dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the window contents is double-buffered by the 1270 system, i.e. if any drawing done on the window is really done on a 1271 temporary backing surface and transferred to the screen all at once 1272 later.</p> 1273 </dd></dl> 1274 1275 <dl class="method"> 1276 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsEnabled"> 1277 <tt class="descname">IsEnabled</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsEnabled" title="Permalink to this definition">¶</a></dt> 1278 <dd><p>Returns true if the window is enabled for input, false otherwise.</p> 1279 </dd></dl> 1280 1281 <dl class="method"> 1282 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsExposed"> 1283 <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> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsExposed" title="Permalink to this definition">¶</a></dt> 1284 <dd><p>Returns true if the given point or rectangle area has been exposed 1285 since the last repaint. Call this in an paint event handler to 1286 optimize redrawing by only redrawing those areas, which have been 1287 exposed.</p> 1288 </dd></dl> 1289 1290 <dl class="method"> 1291 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsExposedPoint"> 1292 <tt class="descname">IsExposedPoint</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsExposedPoint" title="Permalink to this definition">¶</a></dt> 1293 <dd><p>Returns true if the given point or rectangle area has been exposed 1294 since the last repaint. Call this in an paint event handler to 1295 optimize redrawing by only redrawing those areas, which have been 1296 exposed.</p> 1297 </dd></dl> 1298 1299 <dl class="method"> 1300 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsExposedRect"> 1301 <tt class="descname">IsExposedRect</tt><big>(</big><em>self</em>, <em>Rect rect</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsExposedRect" title="Permalink to this definition">¶</a></dt> 1302 <dd><p>Returns true if the given point or rectangle area has been exposed 1303 since the last repaint. Call this in an paint event handler to 1304 optimize redrawing by only redrawing those areas, which have been 1305 exposed.</p> 1306 </dd></dl> 1307 1308 <dl class="method"> 1309 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsFrozen"> 1310 <tt class="descname">IsFrozen</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsFrozen" title="Permalink to this definition">¶</a></dt> 1311 <dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the window has been frozen and not thawed yet.</p> 1312 <table class="docutils field-list" frame="void" rules="none"> 1313 <col class="field-name" /> 1314 <col class="field-body" /> 1315 <tbody valign="top"> 1316 <tr class="field-odd field"><th class="field-name">See :</th><td class="field-body"><cite>Freeze</cite> and <cite>Thaw</cite></td> 1317 </tr> 1318 </tbody> 1319 </table> 1320 </dd></dl> 1321 1322 <dl class="method"> 1323 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsRetained"> 1324 <tt class="descname">IsRetained</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsRetained" title="Permalink to this definition">¶</a></dt> 1325 <dd><p>Returns true if the window is retained, false otherwise. Retained 1326 windows are only available on X platforms.</p> 1327 </dd></dl> 1328 1329 <dl class="method"> 1330 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsSameAs"> 1331 <tt class="descname">IsSameAs</tt><big>(</big><em>self</em>, <em>Object p</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsSameAs" title="Permalink to this definition">¶</a></dt> 1332 <dd><p>For wx.Objects that use C++ reference counting internally, this method 1333 can be used to determine if two objects are referencing the same data 1334 object.</p> 1335 </dd></dl> 1336 1337 <dl class="method"> 1338 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsShown"> 1339 <tt class="descname">IsShown</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsShown" title="Permalink to this definition">¶</a></dt> 1340 <dd><p>Returns true if the window is shown, false if it has been hidden.</p> 1341 </dd></dl> 1342 1343 <dl class="method"> 1344 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsShownOnScreen"> 1345 <tt class="descname">IsShownOnScreen</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsShownOnScreen" title="Permalink to this definition">¶</a></dt> 1346 <dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the window is physically visible on the screen, 1347 i.e. it is shown and all its parents up to the toplevel window are 1348 shown as well.</p> 1349 </dd></dl> 1350 1351 <dl class="method"> 1352 <dt id="sans.guiframe.gui_manager.DefaultPanel.IsTopLevel"> 1353 <tt class="descname">IsTopLevel</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.IsTopLevel" title="Permalink to this definition">¶</a></dt> 1354 <dd><p>Returns true if the given window is a top-level one. Currently all 1355 frames and dialogs are always considered to be top-level windows (even 1356 if they have a parent window).</p> 1357 </dd></dl> 1358 1359 <dl class="attribute"> 1360 <dt id="sans.guiframe.gui_manager.DefaultPanel.Label"> 1361 <tt class="descname">Label</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Label" title="Permalink to this definition">¶</a></dt> 1362 <dd><p>See <cite>GetLabel</cite> and <cite>SetLabel</cite></p> 1363 </dd></dl> 1364 1365 <dl class="method"> 1366 <dt id="sans.guiframe.gui_manager.DefaultPanel.Layout"> 1367 <tt class="descname">Layout</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Layout" title="Permalink to this definition">¶</a></dt> 1368 <dd><p>Invokes the constraint-based layout algorithm or the sizer-based 1369 algorithm for this window. See SetAutoLayout: when auto layout is on, 1370 this function gets called automatically by the default EVT_SIZE 1371 handler when the window is resized.</p> 1372 </dd></dl> 1373 1374 <dl class="attribute"> 1375 <dt id="sans.guiframe.gui_manager.DefaultPanel.LayoutDirection"> 1376 <tt class="descname">LayoutDirection</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.LayoutDirection" title="Permalink to this definition">¶</a></dt> 1377 <dd><p>See <cite>GetLayoutDirection</cite> and <cite>SetLayoutDirection</cite></p> 1378 </dd></dl> 1379 1380 <dl class="method"> 1381 <dt id="sans.guiframe.gui_manager.DefaultPanel.LineDown"> 1382 <tt class="descname">LineDown</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.LineDown" title="Permalink to this definition">¶</a></dt> 1383 <dd><p>This is just a wrapper for ScrollLines(1).</p> 1384 </dd></dl> 1385 1386 <dl class="method"> 1387 <dt id="sans.guiframe.gui_manager.DefaultPanel.LineUp"> 1388 <tt class="descname">LineUp</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.LineUp" title="Permalink to this definition">¶</a></dt> 1389 <dd><p>This is just a wrapper for ScrollLines(-1).</p> 1390 </dd></dl> 1391 1392 <dl class="method"> 1393 <dt id="sans.guiframe.gui_manager.DefaultPanel.Lower"> 1394 <tt class="descname">Lower</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Lower" title="Permalink to this definition">¶</a></dt> 1395 <dd><p>Lowers the window to the bottom of the window hierarchy. In current 1396 version of wxWidgets this works both for managed and child windows.</p> 1397 </dd></dl> 1398 1399 <dl class="method"> 1400 <dt id="sans.guiframe.gui_manager.DefaultPanel.MakeModal"> 1401 <tt class="descname">MakeModal</tt><big>(</big><em>self</em>, <em>bool modal=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MakeModal" title="Permalink to this definition">¶</a></dt> 1402 <dd><p>Disables all other windows in the application so that the user can 1403 only interact with this window. Passing False will reverse this 1404 effect.</p> 1405 </dd></dl> 1406 1407 <dl class="attribute"> 1408 <dt id="sans.guiframe.gui_manager.DefaultPanel.MaxHeight"> 1409 <tt class="descname">MaxHeight</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MaxHeight" title="Permalink to this definition">¶</a></dt> 1410 <dd><p>See <cite>GetMaxHeight</cite></p> 1411 </dd></dl> 1412 1413 <dl class="attribute"> 1414 <dt id="sans.guiframe.gui_manager.DefaultPanel.MaxSize"> 1415 <tt class="descname">MaxSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MaxSize" title="Permalink to this definition">¶</a></dt> 1416 <dd><p>See <cite>GetMaxSize</cite> and <cite>SetMaxSize</cite></p> 1417 </dd></dl> 1418 1419 <dl class="attribute"> 1420 <dt id="sans.guiframe.gui_manager.DefaultPanel.MaxWidth"> 1421 <tt class="descname">MaxWidth</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MaxWidth" title="Permalink to this definition">¶</a></dt> 1422 <dd><p>See <cite>GetMaxWidth</cite></p> 1423 </dd></dl> 1424 1425 <dl class="attribute"> 1426 <dt id="sans.guiframe.gui_manager.DefaultPanel.MinHeight"> 1427 <tt class="descname">MinHeight</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MinHeight" title="Permalink to this definition">¶</a></dt> 1428 <dd><p>See <cite>GetMinHeight</cite></p> 1429 </dd></dl> 1430 1431 <dl class="attribute"> 1432 <dt id="sans.guiframe.gui_manager.DefaultPanel.MinSize"> 1433 <tt class="descname">MinSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MinSize" title="Permalink to this definition">¶</a></dt> 1434 <dd><p>See <cite>GetMinSize</cite> and <cite>SetMinSize</cite></p> 1435 </dd></dl> 1436 1437 <dl class="attribute"> 1438 <dt id="sans.guiframe.gui_manager.DefaultPanel.MinWidth"> 1439 <tt class="descname">MinWidth</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MinWidth" title="Permalink to this definition">¶</a></dt> 1440 <dd><p>See <cite>GetMinWidth</cite></p> 1441 </dd></dl> 1442 1443 <dl class="method"> 1444 <dt id="sans.guiframe.gui_manager.DefaultPanel.Move"> 1445 <tt class="descname">Move</tt><big>(</big><em>self</em>, <em>Point pt</em>, <em>int flags=SIZE_USE_EXISTING</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Move" title="Permalink to this definition">¶</a></dt> 1446 <dd><p>Moves the window to the given position.</p> 1447 </dd></dl> 1448 1449 <dl class="method"> 1450 <dt id="sans.guiframe.gui_manager.DefaultPanel.MoveAfterInTabOrder"> 1451 <tt class="descname">MoveAfterInTabOrder</tt><big>(</big><em>self</em>, <em>Window win</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MoveAfterInTabOrder" title="Permalink to this definition">¶</a></dt> 1452 <dd><p>Moves this window in the tab navigation order after the specified 1453 sibling window. This means that when the user presses the TAB key on 1454 that other window, the focus switches to this window.</p> 1455 <p>The default tab order is the same as creation order. This function 1456 and <cite>MoveBeforeInTabOrder</cite> allow to change it after creating all the 1457 windows.</p> 1458 </dd></dl> 1459 1460 <dl class="method"> 1461 <dt id="sans.guiframe.gui_manager.DefaultPanel.MoveBeforeInTabOrder"> 1462 <tt class="descname">MoveBeforeInTabOrder</tt><big>(</big><em>self</em>, <em>Window win</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MoveBeforeInTabOrder" title="Permalink to this definition">¶</a></dt> 1463 <dd><p>Same as <cite>MoveAfterInTabOrder</cite> except that it inserts this window just 1464 before win instead of putting it right after it.</p> 1465 </dd></dl> 1466 1467 <dl class="method"> 1468 <dt id="sans.guiframe.gui_manager.DefaultPanel.MoveXY"> 1469 <tt class="descname">MoveXY</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int y</em>, <em>int flags=SIZE_USE_EXISTING</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.MoveXY" title="Permalink to this definition">¶</a></dt> 1470 <dd><p>Moves the window to the given position.</p> 1471 </dd></dl> 1472 1473 <dl class="attribute"> 1474 <dt id="sans.guiframe.gui_manager.DefaultPanel.Name"> 1475 <tt class="descname">Name</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Name" title="Permalink to this definition">¶</a></dt> 1476 <dd><p>See <cite>GetName</cite> and <cite>SetName</cite></p> 1477 </dd></dl> 1478 1479 <dl class="method"> 1480 <dt id="sans.guiframe.gui_manager.DefaultPanel.Navigate"> 1481 <tt class="descname">Navigate</tt><big>(</big><em>self</em>, <em>int flags=NavigationKeyEvent.IsForward</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Navigate" title="Permalink to this definition">¶</a></dt> 1482 <dd><p>Does keyboard navigation from this window to another, by sending a 1483 <cite>wx.NavigationKeyEvent</cite>.</p> 1484 </dd></dl> 1485 1486 <dl class="staticmethod"> 1487 <dt id="sans.guiframe.gui_manager.DefaultPanel.NewControlId"> 1488 <em class="property">static </em><tt class="descname">NewControlId</tt><big>(</big><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.NewControlId" title="Permalink to this definition">¶</a></dt> 1489 <dd><p>Generate a control id for the controls which were not given one.</p> 1490 </dd></dl> 1491 1492 <dl class="staticmethod"> 1493 <dt id="sans.guiframe.gui_manager.DefaultPanel.NextControlId"> 1494 <em class="property">static </em><tt class="descname">NextControlId</tt><big>(</big><em>int winid</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.NextControlId" title="Permalink to this definition">¶</a></dt> 1495 <dd><p>Get the id of the control following the one with the given 1496 autogenerated) id</p> 1497 </dd></dl> 1498 1499 <dl class="attribute"> 1500 <dt id="sans.guiframe.gui_manager.DefaultPanel.NextHandler"> 1501 <tt class="descname">NextHandler</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.NextHandler" title="Permalink to this definition">¶</a></dt> 1502 <dd><p>See <cite>GetNextHandler</cite> and <cite>SetNextHandler</cite></p> 1503 </dd></dl> 1504 1505 <dl class="method"> 1506 <dt id="sans.guiframe.gui_manager.DefaultPanel.OnPaint"> 1507 <tt class="descname">OnPaint</tt><big>(</big><em>self</em>, <em>PaintEvent event</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.OnPaint" title="Permalink to this definition">¶</a></dt> 1508 <dd></dd></dl> 1509 1510 <dl class="method"> 1511 <dt id="sans.guiframe.gui_manager.DefaultPanel.PageDown"> 1512 <tt class="descname">PageDown</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PageDown" title="Permalink to this definition">¶</a></dt> 1513 <dd><p>This is just a wrapper for ScrollPages(1).</p> 1514 </dd></dl> 1515 1516 <dl class="method"> 1517 <dt id="sans.guiframe.gui_manager.DefaultPanel.PageUp"> 1518 <tt class="descname">PageUp</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PageUp" title="Permalink to this definition">¶</a></dt> 1519 <dd><p>This is just a wrapper for ScrollPages(-1).</p> 1520 </dd></dl> 1521 1522 <dl class="attribute"> 1523 <dt id="sans.guiframe.gui_manager.DefaultPanel.Parent"> 1524 <tt class="descname">Parent</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Parent" title="Permalink to this definition">¶</a></dt> 1525 <dd><p>See <cite>GetParent</cite></p> 1526 </dd></dl> 1527 1528 <dl class="method"> 1529 <dt id="sans.guiframe.gui_manager.DefaultPanel.PopEventHandler"> 1530 <tt class="descname">PopEventHandler</tt><big>(</big><em>self</em>, <em>bool deleteHandler=False</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PopEventHandler" title="Permalink to this definition">¶</a></dt> 1531 <dd><p>Removes and returns the top-most event handler on the event handler 1532 stack. If deleteHandler is True then the wx.EvtHandler object will be 1533 destroyed after it is popped, and <tt class="docutils literal"><span class="pre">None</span></tt> will be returned instead.</p> 1534 </dd></dl> 1535 1536 <dl class="method"> 1537 <dt id="sans.guiframe.gui_manager.DefaultPanel.PopupMenu"> 1538 <tt class="descname">PopupMenu</tt><big>(</big><em>self</em>, <em>Menu menu</em>, <em>Point pos=DefaultPosition</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PopupMenu" title="Permalink to this definition">¶</a></dt> 1539 <dd><p>Pops up the given menu at the specified coordinates, relative to this window, 1540 and returns control when the user has dismissed the menu. If a menu item is 1541 selected, the corresponding menu event is generated and will be processed as 1542 usual. If the default position is given then the current position of the 1543 mouse cursor will be used.</p> 1544 </dd></dl> 1545 1546 <dl class="method"> 1547 <dt id="sans.guiframe.gui_manager.DefaultPanel.PopupMenuXY"> 1548 <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> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PopupMenuXY" title="Permalink to this definition">¶</a></dt> 1549 <dd><p>Pops up the given menu at the specified coordinates, relative to this window, 1550 and returns control when the user has dismissed the menu. If a menu item is 1551 selected, the corresponding menu event is generated and will be processed as 1552 usual. If the default position is given then the current position of the 1553 mouse cursor will be used.</p> 1554 </dd></dl> 1555 1556 <dl class="attribute"> 1557 <dt id="sans.guiframe.gui_manager.DefaultPanel.Position"> 1558 <tt class="descname">Position</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Position" title="Permalink to this definition">¶</a></dt> 1559 <dd><p>See <cite>GetPosition</cite> and <cite>SetPosition</cite></p> 1560 </dd></dl> 1561 1562 <dl class="method"> 1563 <dt id="sans.guiframe.gui_manager.DefaultPanel.PostCreate"> 1564 <tt class="descname">PostCreate</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PostCreate" title="Permalink to this definition">¶</a></dt> 1565 <dd><p>Phase 3 of the 2-phase create <wink!> 1566 Call this method after precreating the window with the 2-phase create method.</p> 1567 </dd></dl> 1568 1569 <dl class="method"> 1570 <dt id="sans.guiframe.gui_manager.DefaultPanel.PrepareDC"> 1571 <tt class="descname">PrepareDC</tt><big>(</big><em>self</em>, <em>DC dc</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PrepareDC" title="Permalink to this definition">¶</a></dt> 1572 <dd><p>Call this function to prepare the device context for drawing a 1573 scrolled image. It sets the device origin according to the current 1574 scroll position.</p> 1575 </dd></dl> 1576 1577 <dl class="staticmethod"> 1578 <dt id="sans.guiframe.gui_manager.DefaultPanel.PrevControlId"> 1579 <em class="property">static </em><tt class="descname">PrevControlId</tt><big>(</big><em>int winid</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PrevControlId" title="Permalink to this definition">¶</a></dt> 1580 <dd><p>Get the id of the control preceding the one with the given 1581 autogenerated) id</p> 1582 </dd></dl> 1583 1584 <dl class="attribute"> 1585 <dt id="sans.guiframe.gui_manager.DefaultPanel.PreviousHandler"> 1586 <tt class="descname">PreviousHandler</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PreviousHandler" title="Permalink to this definition">¶</a></dt> 1587 <dd><p>See <cite>GetPreviousHandler</cite> and <cite>SetPreviousHandler</cite></p> 1588 </dd></dl> 1589 1590 <dl class="method"> 1591 <dt id="sans.guiframe.gui_manager.DefaultPanel.ProcessEvent"> 1592 <tt class="descname">ProcessEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ProcessEvent" title="Permalink to this definition">¶</a></dt> 1593 <dd></dd></dl> 1594 1595 <dl class="method"> 1596 <dt id="sans.guiframe.gui_manager.DefaultPanel.ProcessPendingEvents"> 1597 <tt class="descname">ProcessPendingEvents</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ProcessPendingEvents" title="Permalink to this definition">¶</a></dt> 1598 <dd></dd></dl> 1599 1600 <dl class="method"> 1601 <dt id="sans.guiframe.gui_manager.DefaultPanel.PushEventHandler"> 1602 <tt class="descname">PushEventHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.PushEventHandler" title="Permalink to this definition">¶</a></dt> 1603 <dd><p>Pushes this event handler onto the event handler stack for the window. 1604 An event handler is an object that is capable of processing the events 1605 sent to a window. (In other words, is able to dispatch the events to a 1606 handler function.) By default, the window is its own event handler, 1607 but an application may wish to substitute another, for example to 1608 allow central implementation of event-handling for a variety of 1609 different window classes.</p> 1610 <p>wx.Window.PushEventHandler allows an application to set up a chain of 1611 event handlers, where an event not handled by one event handler is 1612 handed to the next one in the chain. Use <cite>wx.Window.PopEventHandler</cite> 1613 to remove the event handler. Ownership of the handler is <em>not</em> given 1614 to the window, so you should be sure to pop the handler before the 1615 window is destroyed and either let PopEventHandler destroy it, or call 1616 its Destroy method yourself.</p> 1617 </dd></dl> 1618 1619 <dl class="method"> 1620 <dt id="sans.guiframe.gui_manager.DefaultPanel.Raise"> 1621 <tt class="descname">Raise</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Raise" title="Permalink to this definition">¶</a></dt> 1622 <dd><p>Raises the window to the top of the window hierarchy. In current 1623 version of wxWidgets this works both for managed and child windows.</p> 1624 </dd></dl> 1625 1626 <dl class="attribute"> 1627 <dt id="sans.guiframe.gui_manager.DefaultPanel.Rect"> 1628 <tt class="descname">Rect</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Rect" title="Permalink to this definition">¶</a></dt> 1629 <dd><p>See <cite>GetRect</cite> and <cite>SetRect</cite></p> 1630 </dd></dl> 1631 1632 <dl class="method"> 1633 <dt id="sans.guiframe.gui_manager.DefaultPanel.Refresh"> 1634 <tt class="descname">Refresh</tt><big>(</big><em>self</em>, <em>bool eraseBackground=True</em>, <em>Rect rect=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Refresh" title="Permalink to this definition">¶</a></dt> 1635 <dd><p>Mark the specified rectangle (or the whole window) as “dirty” so it 1636 will be repainted. Causes an EVT_PAINT event to be generated and sent 1637 to the window.</p> 1638 </dd></dl> 1639 1640 <dl class="method"> 1641 <dt id="sans.guiframe.gui_manager.DefaultPanel.RefreshRect"> 1642 <tt class="descname">RefreshRect</tt><big>(</big><em>self</em>, <em>Rect rect</em>, <em>bool eraseBackground=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.RefreshRect" title="Permalink to this definition">¶</a></dt> 1643 <dd><p>Redraws the contents of the given rectangle: the area inside it will 1644 be repainted. This is the same as Refresh but has a nicer syntax.</p> 1645 </dd></dl> 1646 1647 <dl class="method"> 1648 <dt id="sans.guiframe.gui_manager.DefaultPanel.RegisterHotKey"> 1649 <tt class="descname">RegisterHotKey</tt><big>(</big><em>self</em>, <em>int hotkeyId</em>, <em>int modifiers</em>, <em>int keycode</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.RegisterHotKey" title="Permalink to this definition">¶</a></dt> 1650 <dd><p>Registers a system wide hotkey. Every time the user presses the hotkey 1651 registered here, this window will receive a hotkey event. It will 1652 receive the event even if the application is in the background and 1653 does not have the input focus because the user is working with some 1654 other application. To bind an event handler function to this hotkey 1655 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the 1656 hotkey was registered successfully.</p> 1657 </dd></dl> 1658 1659 <dl class="method"> 1660 <dt id="sans.guiframe.gui_manager.DefaultPanel.ReleaseMouse"> 1661 <tt class="descname">ReleaseMouse</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ReleaseMouse" title="Permalink to this definition">¶</a></dt> 1662 <dd><p>Releases mouse input captured with wx.Window.CaptureMouse.</p> 1663 </dd></dl> 1664 1665 <dl class="method"> 1666 <dt id="sans.guiframe.gui_manager.DefaultPanel.RemoveChild"> 1667 <tt class="descname">RemoveChild</tt><big>(</big><em>self</em>, <em>Window child</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.RemoveChild" title="Permalink to this definition">¶</a></dt> 1668 <dd><p>Removes a child window. This is called automatically by window 1669 deletion functions so should not be required by the application 1670 programmer.</p> 1671 </dd></dl> 1672 1673 <dl class="method"> 1674 <dt id="sans.guiframe.gui_manager.DefaultPanel.RemoveEventHandler"> 1675 <tt class="descname">RemoveEventHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.RemoveEventHandler" title="Permalink to this definition">¶</a></dt> 1676 <dd><p>Find the given handler in the event handler chain and remove (but not 1677 delete) it from the event handler chain, returns True if it was found 1678 and False otherwise (this also results in an assert failure so this 1679 function should only be called when the handler is supposed to be 1680 there.)</p> 1681 </dd></dl> 1682 1683 <dl class="method"> 1684 <dt id="sans.guiframe.gui_manager.DefaultPanel.Reparent"> 1685 <tt class="descname">Reparent</tt><big>(</big><em>self</em>, <em>Window newParent</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Reparent" title="Permalink to this definition">¶</a></dt> 1686 <dd><p>Reparents the window, i.e the window will be removed from its current 1687 parent window (e.g. a non-standard toolbar in a wxFrame) and then 1688 re-inserted into another. Available on Windows and GTK. Returns True 1689 if the parent was changed, False otherwise (error or newParent == 1690 oldParent)</p> 1691 </dd></dl> 1692 1693 <dl class="attribute"> 1694 <dt id="sans.guiframe.gui_manager.DefaultPanel.ScreenPosition"> 1695 <tt class="descname">ScreenPosition</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ScreenPosition" title="Permalink to this definition">¶</a></dt> 1696 <dd><p>See <cite>GetScreenPosition</cite></p> 1697 </dd></dl> 1698 1699 <dl class="attribute"> 1700 <dt id="sans.guiframe.gui_manager.DefaultPanel.ScreenRect"> 1701 <tt class="descname">ScreenRect</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ScreenRect" title="Permalink to this definition">¶</a></dt> 1702 <dd><p>See <cite>GetScreenRect</cite></p> 1703 </dd></dl> 1704 1705 <dl class="method"> 1706 <dt id="sans.guiframe.gui_manager.DefaultPanel.ScreenToClient"> 1707 <tt class="descname">ScreenToClient</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ScreenToClient" title="Permalink to this definition">¶</a></dt> 1708 <dd><p>Converts from screen to client window coordinates.</p> 1709 </dd></dl> 1710 1711 <dl class="method"> 1712 <dt id="sans.guiframe.gui_manager.DefaultPanel.ScreenToClientXY"> 1713 <tt class="descname">ScreenToClientXY</tt><big>(</big><em>int x</em>, <em>int y) -> (x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ScreenToClientXY" title="Permalink to this definition">¶</a></dt> 1714 <dd><p>Converts from screen to client window coordinates.</p> 1715 </dd></dl> 1716 1717 <dl class="method"> 1718 <dt id="sans.guiframe.gui_manager.DefaultPanel.ScrollLines"> 1719 <tt class="descname">ScrollLines</tt><big>(</big><em>self</em>, <em>int lines</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ScrollLines" title="Permalink to this definition">¶</a></dt> 1720 <dd><p>If the platform and window class supports it, scrolls the window by 1721 the given number of lines down, if lines is positive, or up if lines 1722 is negative. Returns True if the window was scrolled, False if it was 1723 already on top/bottom and nothing was done.</p> 1724 </dd></dl> 1725 1726 <dl class="method"> 1727 <dt id="sans.guiframe.gui_manager.DefaultPanel.ScrollPages"> 1728 <tt class="descname">ScrollPages</tt><big>(</big><em>self</em>, <em>int pages</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ScrollPages" title="Permalink to this definition">¶</a></dt> 1729 <dd><p>If the platform and window class supports it, scrolls the window by 1730 the given number of pages down, if pages is positive, or up if pages 1731 is negative. Returns True if the window was scrolled, False if it was 1732 already on top/bottom and nothing was done.</p> 1733 </dd></dl> 1734 1735 <dl class="method"> 1736 <dt id="sans.guiframe.gui_manager.DefaultPanel.ScrollWindow"> 1737 <tt class="descname">ScrollWindow</tt><big>(</big><em>self</em>, <em>int dx</em>, <em>int dy</em>, <em>Rect rect=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ScrollWindow" title="Permalink to this definition">¶</a></dt> 1738 <dd><p>Physically scrolls the pixels in the window and move child windows 1739 accordingly. Use this function to optimise your scrolling 1740 implementations, to minimise the area that must be redrawn. Note that 1741 it is rarely required to call this function from a user program.</p> 1742 </dd></dl> 1743 1744 <dl class="method"> 1745 <dt id="sans.guiframe.gui_manager.DefaultPanel.SendSizeEvent"> 1746 <tt class="descname">SendSizeEvent</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SendSizeEvent" title="Permalink to this definition">¶</a></dt> 1747 <dd></dd></dl> 1748 1749 <dl class="method"> 1750 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetAcceleratorTable"> 1751 <tt class="descname">SetAcceleratorTable</tt><big>(</big><em>self</em>, <em>AcceleratorTable accel</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetAcceleratorTable" title="Permalink to this definition">¶</a></dt> 1752 <dd><p>Sets the accelerator table for this window.</p> 1753 </dd></dl> 1754 1755 <dl class="method"> 1756 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetAutoLayout"> 1757 <tt class="descname">SetAutoLayout</tt><big>(</big><em>self</em>, <em>bool autoLayout</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetAutoLayout" title="Permalink to this definition">¶</a></dt> 1758 <dd><p>Determines whether the Layout function will be called automatically 1759 when the window is resized. lease note that this only happens for the 1760 windows usually used to contain children, namely <cite>wx.Panel</cite> and 1761 <cite>wx.TopLevelWindow</cite> (and the classes deriving from them).</p> 1762 <p>This method is called implicitly by <cite>SetSizer</cite> but if you use 1763 <cite>SetConstraints</cite> you should call it manually or otherwise the window 1764 layout won’t be correctly updated when its size changes.</p> 1765 </dd></dl> 1766 1767 <dl class="method"> 1768 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetBackgroundColour"> 1769 <tt class="descname">SetBackgroundColour</tt><big>(</big><em>self</em>, <em>Colour colour</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetBackgroundColour" title="Permalink to this definition">¶</a></dt> 1770 <dd><p>Sets the background colour of the window. Returns True if the colour 1771 was changed. The background colour is usually painted by the default 1772 EVT_ERASE_BACKGROUND event handler function under Windows and 1773 automatically under GTK. Using <cite>wx.NullColour</cite> will reset the window 1774 to the default background colour.</p> 1775 <p>Note that setting the background colour may not cause an immediate 1776 refresh, so you may wish to call <cite>ClearBackground</cite> or <cite>Refresh</cite> after 1777 calling this function.</p> 1778 <p>Using this function will disable attempts to use themes for this 1779 window, if the system supports them. Use with care since usually the 1780 themes represent the appearance chosen by the user to be used for all 1781 applications on the system.</p> 1782 </dd></dl> 1783 1784 <dl class="method"> 1785 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetBackgroundStyle"> 1786 <tt class="descname">SetBackgroundStyle</tt><big>(</big><em>self</em>, <em>int style</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetBackgroundStyle" title="Permalink to this definition">¶</a></dt> 1787 <dd><p>Returns the background style of the window. The background style 1788 indicates how the background of the window is drawn.</p> 1789 <blockquote> 1790 <div><table border="1" class="docutils"> 1791 <colgroup> 1792 <col width="35%" /> 1793 <col width="65%" /> 1794 </colgroup> 1795 <tbody valign="top"> 1796 <tr class="row-odd"><td>wx.BG_STYLE_SYSTEM</td> 1797 <td>The background colour or pattern should 1798 be determined by the system</td> 1799 </tr> 1800 <tr class="row-even"><td>wx.BG_STYLE_COLOUR</td> 1801 <td>The background should be a solid colour</td> 1802 </tr> 1803 <tr class="row-odd"><td>wx.BG_STYLE_CUSTOM</td> 1804 <td>The background will be implemented by the 1805 application.</td> 1806 </tr> 1807 </tbody> 1808 </table> 1809 </div></blockquote> 1810 <p>On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of 1811 a custom background, such as a tiled bitmap. Currently the style has 1812 no effect on other platforms.</p> 1813 <table class="docutils field-list" frame="void" rules="none"> 1814 <col class="field-name" /> 1815 <col class="field-body" /> 1816 <tbody valign="top"> 1817 <tr class="field-odd field"><th class="field-name">See :</th><td class="field-body"><cite>GetBackgroundStyle</cite>, <cite>SetBackgroundColour</cite></td> 1818 </tr> 1819 </tbody> 1820 </table> 1821 </dd></dl> 1822 1823 <dl class="method"> 1824 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetBestFittingSize"> 1825 <tt class="descname">SetBestFittingSize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetBestFittingSize" title="Permalink to this definition">¶</a></dt> 1826 <dd><p>Use <cite>SetInitialSize</cite></p> 1827 </dd></dl> 1828 1829 <dl class="method"> 1830 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetCaret"> 1831 <tt class="descname">SetCaret</tt><big>(</big><em>self</em>, <em>Caret caret</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetCaret" title="Permalink to this definition">¶</a></dt> 1832 <dd><p>Sets the caret associated with the window.</p> 1833 </dd></dl> 1834 1835 <dl class="method"> 1836 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetClientRect"> 1837 <tt class="descname">SetClientRect</tt><big>(</big><em>self</em>, <em>Rect rect</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetClientRect" title="Permalink to this definition">¶</a></dt> 1838 <dd><p>This sets the size of the window client area in pixels. Using this 1839 function to size a window tends to be more device-independent than 1840 wx.Window.SetSize, since the application need not worry about what 1841 dimensions the border or title bar have when trying to fit the window 1842 around panel items, for example.</p> 1843 </dd></dl> 1844 1845 <dl class="method"> 1846 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetClientSize"> 1847 <tt class="descname">SetClientSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetClientSize" title="Permalink to this definition">¶</a></dt> 1848 <dd><p>This sets the size of the window client area in pixels. Using this 1849 function to size a window tends to be more device-independent than 1850 wx.Window.SetSize, since the application need not worry about what 1851 dimensions the border or title bar have when trying to fit the window 1852 around panel items, for example.</p> 1853 </dd></dl> 1854 1855 <dl class="method"> 1856 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetClientSizeWH"> 1857 <tt class="descname">SetClientSizeWH</tt><big>(</big><em>self</em>, <em>int width</em>, <em>int height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetClientSizeWH" title="Permalink to this definition">¶</a></dt> 1858 <dd><p>This sets the size of the window client area in pixels. Using this 1859 function to size a window tends to be more device-independent than 1860 wx.Window.SetSize, since the application need not worry about what 1861 dimensions the border or title bar have when trying to fit the window 1862 around panel items, for example.</p> 1863 </dd></dl> 1864 1865 <dl class="method"> 1866 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetConstraints"> 1867 <tt class="descname">SetConstraints</tt><big>(</big><em>self</em>, <em>LayoutConstraints constraints</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetConstraints" title="Permalink to this definition">¶</a></dt> 1868 <dd><p>Sets the window to have the given layout constraints. If an existing 1869 layout constraints object is already owned by the window, it will be 1870 deleted. Pass None to disassociate and delete the window’s current 1871 constraints.</p> 1872 <p>You must call SetAutoLayout to tell a window to use the constraints 1873 automatically in its default EVT_SIZE handler; otherwise, you must 1874 handle EVT_SIZE yourself and call Layout() explicitly. When setting 1875 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have 1876 effect.</p> 1877 </dd></dl> 1878 1879 <dl class="method"> 1880 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetContainingSizer"> 1881 <tt class="descname">SetContainingSizer</tt><big>(</big><em>self</em>, <em>Sizer sizer</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetContainingSizer" title="Permalink to this definition">¶</a></dt> 1882 <dd><p>This normally does not need to be called by application code. It is 1883 called internally when a window is added to a sizer, and is used so 1884 the window can remove itself from the sizer when it is destroyed.</p> 1885 </dd></dl> 1886 1887 <dl class="method"> 1888 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetCursor"> 1889 <tt class="descname">SetCursor</tt><big>(</big><em>self</em>, <em>Cursor cursor</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetCursor" title="Permalink to this definition">¶</a></dt> 1890 <dd><p>Sets the window’s cursor. Notice that the window cursor also sets it 1891 for the children of the window implicitly.</p> 1892 <p>The cursor may be wx.NullCursor in which case the window cursor will 1893 be reset back to default.</p> 1894 </dd></dl> 1895 1896 <dl class="method"> 1897 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetDimensions"> 1898 <tt class="descname">SetDimensions</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int y</em>, <em>int width</em>, <em>int height</em>, <em>int sizeFlags=SIZE_AUTO</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetDimensions" title="Permalink to this definition">¶</a></dt> 1899 <dd><p>Sets the position and size of the window in pixels. The sizeFlags 1900 parameter indicates the interpretation of the other params if they are 1901 equal to -1.</p> 1902 <blockquote> 1903 <div><table border="1" class="docutils"> 1904 <colgroup> 1905 <col width="39%" /> 1906 <col width="61%" /> 1907 </colgroup> 1908 <tbody valign="top"> 1909 <tr class="row-odd"><td>wx.SIZE_AUTO</td> 1910 <td>A -1 indicates that a class-specific 1911 default should be used.</td> 1912 </tr> 1913 <tr class="row-even"><td>wx.SIZE_USE_EXISTING</td> 1914 <td>Existing dimensions should be used if 1915 -1 values are supplied.</td> 1916 </tr> 1917 <tr class="row-odd"><td>wxSIZE_ALLOW_MINUS_ONE</td> 1918 <td>Allow dimensions of -1 and less to be 1919 interpreted as real dimensions, not 1920 default values.</td> 1921 </tr> 1922 </tbody> 1923 </table> 1924 </div></blockquote> 1925 </dd></dl> 1926 1927 <dl class="method"> 1928 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetDoubleBuffered"> 1929 <tt class="descname">SetDoubleBuffered</tt><big>(</big><em>self</em>, <em>bool on</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetDoubleBuffered" title="Permalink to this definition">¶</a></dt> 1930 <dd><p>Put the native window into double buffered or composited mode.</p> 1931 </dd></dl> 1932 1933 <dl class="method"> 1934 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetDropTarget"> 1935 <tt class="descname">SetDropTarget</tt><big>(</big><em>self</em>, <em>DropTarget dropTarget</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetDropTarget" title="Permalink to this definition">¶</a></dt> 1936 <dd><p>Associates a drop target with this window. If the window already has 1937 a drop target, it is deleted.</p> 1938 </dd></dl> 1939 1940 <dl class="method"> 1941 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetEventHandler"> 1942 <tt class="descname">SetEventHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetEventHandler" title="Permalink to this definition">¶</a></dt> 1943 <dd><p>Sets the event handler for this window. An event handler is an object 1944 that is capable of processing the events sent to a window. (In other 1945 words, is able to dispatch the events to handler function.) By 1946 default, the window is its own event handler, but an application may 1947 wish to substitute another, for example to allow central 1948 implementation of event-handling for a variety of different window 1949 classes.</p> 1950 <p>It is usually better to use <cite>wx.Window.PushEventHandler</cite> since this sets 1951 up a chain of event handlers, where an event not handled by one event 1952 handler is handed off to the next one in the chain.</p> 1953 </dd></dl> 1954 1955 <dl class="method"> 1956 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetEvtHandlerEnabled"> 1957 <tt class="descname">SetEvtHandlerEnabled</tt><big>(</big><em>self</em>, <em>bool enabled</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 1958 <dd></dd></dl> 1959 1960 <dl class="method"> 1961 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetExtraStyle"> 1962 <tt class="descname">SetExtraStyle</tt><big>(</big><em>self</em>, <em>long exStyle</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetExtraStyle" title="Permalink to this definition">¶</a></dt> 1963 <dd><p>Sets the extra style bits for the window. Extra styles are the less 1964 often used style bits which can’t be set with the constructor or with 1965 SetWindowStyleFlag()</p> 1966 </dd></dl> 1967 1968 <dl class="method"> 1969 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetFocus"> 1970 <tt class="descname">SetFocus</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetFocus" title="Permalink to this definition">¶</a></dt> 1971 <dd><p>Set’s the focus to this window, allowing it to receive keyboard input.</p> 1972 </dd></dl> 1973 1974 <dl class="method"> 1975 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetFocusFromKbd"> 1976 <tt class="descname">SetFocusFromKbd</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetFocusFromKbd" title="Permalink to this definition">¶</a></dt> 1977 <dd><p>Set focus to this window as the result of a keyboard action. Normally 1978 only called internally.</p> 1979 </dd></dl> 1980 1981 <dl class="method"> 1982 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetFocusIgnoringChildren"> 1983 <tt class="descname">SetFocusIgnoringChildren</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetFocusIgnoringChildren" title="Permalink to this definition">¶</a></dt> 1984 <dd><p>In contrast to <cite>SetFocus</cite> (see above) this will set the focus to the 1985 panel even of there are child windows in the panel. This is only 1986 rarely needed.</p> 1987 </dd></dl> 1988 1989 <dl class="method"> 1990 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetFont"> 1991 <tt class="descname">SetFont</tt><big>(</big><em>self</em>, <em>Font font</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetFont" title="Permalink to this definition">¶</a></dt> 1992 <dd><p>Sets the font for this window.</p> 1993 </dd></dl> 1994 1995 <dl class="method"> 1996 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetForegroundColour"> 1997 <tt class="descname">SetForegroundColour</tt><big>(</big><em>self</em>, <em>Colour colour</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetForegroundColour" title="Permalink to this definition">¶</a></dt> 1998 <dd><p>Sets the foreground colour of the window. Returns True is the colour 1999 was changed. The interpretation of foreground colour is dependent on 2000 the window class; it may be the text colour or other colour, or it may 2001 not be used at all.</p> 2002 </dd></dl> 2003 2004 <dl class="method"> 2005 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetHelpText"> 2006 <tt class="descname">SetHelpText</tt><big>(</big><em>self</em>, <em>String text</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetHelpText" title="Permalink to this definition">¶</a></dt> 2007 <dd><p>Sets the help text to be used as context-sensitive help for this 2008 window. Note that the text is actually stored by the current 2009 <cite>wx.HelpProvider</cite> implementation, and not in the window object itself.</p> 2010 </dd></dl> 2011 2012 <dl class="method"> 2013 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetHelpTextForId"> 2014 <tt class="descname">SetHelpTextForId</tt><big>(</big><em>self</em>, <em>String text</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetHelpTextForId" title="Permalink to this definition">¶</a></dt> 2015 <dd><p>Associate this help text with all windows with the same id as this 2016 one.</p> 2017 </dd></dl> 2018 2019 <dl class="method"> 2020 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetId"> 2021 <tt class="descname">SetId</tt><big>(</big><em>self</em>, <em>int winid</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetId" title="Permalink to this definition">¶</a></dt> 2022 <dd><p>Sets the identifier of the window. Each window has an integer 2023 identifier. If the application has not provided one, an identifier 2024 will be generated. Normally, the identifier should be provided on 2025 creation and should not be modified subsequently.</p> 2026 </dd></dl> 2027 2028 <dl class="method"> 2029 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetInitialSize"> 2030 <tt class="descname">SetInitialSize</tt><big>(</big><em>self</em>, <em>Size size=DefaultSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetInitialSize" title="Permalink to this definition">¶</a></dt> 2031 <dd><p>A ‘Smart’ SetSize that will fill in default size components with the 2032 window’s <em>best size</em> values. Also set’s the minsize for use with sizers.</p> 2033 </dd></dl> 2034 2035 <dl class="method"> 2036 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetLabel"> 2037 <tt class="descname">SetLabel</tt><big>(</big><em>self</em>, <em>String label</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetLabel" title="Permalink to this definition">¶</a></dt> 2038 <dd><p>Set the text which the window shows in its label if applicable.</p> 2039 </dd></dl> 2040 2041 <dl class="method"> 2042 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetLayoutDirection"> 2043 <tt class="descname">SetLayoutDirection</tt><big>(</big><em>self</em>, <em>int dir</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetLayoutDirection" title="Permalink to this definition">¶</a></dt> 2044 <dd><p>Set the layout direction (LTR or RTL) for this window.</p> 2045 </dd></dl> 2046 2047 <dl class="method"> 2048 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetMaxSize"> 2049 <tt class="descname">SetMaxSize</tt><big>(</big><em>self</em>, <em>Size maxSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetMaxSize" title="Permalink to this definition">¶</a></dt> 2050 <dd><p>A more convenient method than <cite>SetSizeHints</cite> for setting just the 2051 max size.</p> 2052 </dd></dl> 2053 2054 <dl class="method"> 2055 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetMinSize"> 2056 <tt class="descname">SetMinSize</tt><big>(</big><em>self</em>, <em>Size minSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetMinSize" title="Permalink to this definition">¶</a></dt> 2057 <dd><p>A more convenient method than <cite>SetSizeHints</cite> for setting just the 2058 min size.</p> 2059 </dd></dl> 2060 2061 <dl class="method"> 2062 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetName"> 2063 <tt class="descname">SetName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetName" title="Permalink to this definition">¶</a></dt> 2064 <dd><p>Sets the window’s name. The window name is used for ressource setting 2065 in X, it is not the same as the window title/label</p> 2066 </dd></dl> 2067 2068 <dl class="method"> 2069 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetNextHandler"> 2070 <tt class="descname">SetNextHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetNextHandler" title="Permalink to this definition">¶</a></dt> 2071 <dd></dd></dl> 2072 2073 <dl class="method"> 2074 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetOwnBackgroundColour"> 2075 <tt class="descname">SetOwnBackgroundColour</tt><big>(</big><em>self</em>, <em>Colour colour</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetOwnBackgroundColour" title="Permalink to this definition">¶</a></dt> 2076 <dd></dd></dl> 2077 2078 <dl class="method"> 2079 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetOwnFont"> 2080 <tt class="descname">SetOwnFont</tt><big>(</big><em>self</em>, <em>Font font</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetOwnFont" title="Permalink to this definition">¶</a></dt> 2081 <dd></dd></dl> 2082 2083 <dl class="method"> 2084 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetOwnForegroundColour"> 2085 <tt class="descname">SetOwnForegroundColour</tt><big>(</big><em>self</em>, <em>Colour colour</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetOwnForegroundColour" title="Permalink to this definition">¶</a></dt> 2086 <dd></dd></dl> 2087 2088 <dl class="method"> 2089 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetPosition"> 2090 <tt class="descname">SetPosition</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetPosition" title="Permalink to this definition">¶</a></dt> 2091 <dd><p>Move(self, Point pt, int flags=SIZE_USE_EXISTING)</p> 2092 <p>Moves the window to the given position.</p> 2093 </dd></dl> 2094 2095 <dl class="method"> 2096 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetPreviousHandler"> 2097 <tt class="descname">SetPreviousHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetPreviousHandler" title="Permalink to this definition">¶</a></dt> 2098 <dd></dd></dl> 2099 2100 <dl class="method"> 2101 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetRect"> 2102 <tt class="descname">SetRect</tt><big>(</big><em>self</em>, <em>Rect rect</em>, <em>int sizeFlags=SIZE_AUTO</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetRect" title="Permalink to this definition">¶</a></dt> 2103 <dd><p>Sets the position and size of the window in pixels using a wx.Rect.</p> 2104 </dd></dl> 2105 2106 <dl class="method"> 2107 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetScrollPos"> 2108 <tt class="descname">SetScrollPos</tt><big>(</big><em>self</em>, <em>int orientation</em>, <em>int pos</em>, <em>bool refresh=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetScrollPos" title="Permalink to this definition">¶</a></dt> 2109 <dd><p>Sets the position of one of the built-in scrollbars.</p> 2110 </dd></dl> 2111 2112 <dl class="method"> 2113 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetScrollbar"> 2114 <tt class="descname">SetScrollbar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetScrollbar" title="Permalink to this definition">¶</a></dt> 2115 <dd><dl class="docutils"> 2116 <dt>SetScrollbar(self, int orientation, int position, int thumbSize, int range, </dt> 2117 <dd>bool refresh=True)</dd> 2118 </dl> 2119 <p>Sets the scrollbar properties of a built-in scrollbar.</p> 2120 </dd></dl> 2121 2122 <dl class="method"> 2123 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetSize"> 2124 <tt class="descname">SetSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetSize" title="Permalink to this definition">¶</a></dt> 2125 <dd><p>Sets the size of the window in pixels.</p> 2126 </dd></dl> 2127 2128 <dl class="method"> 2129 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetSizeHints"> 2130 <tt class="descname">SetSizeHints</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetSizeHints" title="Permalink to this definition">¶</a></dt> 2131 <dd><dl class="docutils"> 2132 <dt>SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, </dt> 2133 <dd>int incH=-1)</dd> 2134 </dl> 2135 <p>Allows specification of minimum and maximum window sizes, and window 2136 size increments. If a pair of values is not set (or set to -1), the 2137 default values will be used. If this function is called, the user 2138 will not be able to size the window outside the given bounds (if it is 2139 a top-level window.) Sizers will also inspect the minimum window size 2140 and will use that value if set when calculating layout.</p> 2141 <p>The resizing increments are only significant under Motif or Xt.</p> 2142 </dd></dl> 2143 2144 <dl class="method"> 2145 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetSizeHintsSz"> 2146 <tt class="descname">SetSizeHintsSz</tt><big>(</big><em>self</em>, <em>Size minSize</em>, <em>Size maxSize=DefaultSize</em>, <em>Size incSize=DefaultSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetSizeHintsSz" title="Permalink to this definition">¶</a></dt> 2147 <dd><p>Allows specification of minimum and maximum window sizes, and window 2148 size increments. If a pair of values is not set (or set to -1), the 2149 default values will be used. If this function is called, the user 2150 will not be able to size the window outside the given bounds (if it is 2151 a top-level window.) Sizers will also inspect the minimum window size 2152 and will use that value if set when calculating layout.</p> 2153 <p>The resizing increments are only significant under Motif or Xt.</p> 2154 </dd></dl> 2155 2156 <dl class="method"> 2157 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetSizeWH"> 2158 <tt class="descname">SetSizeWH</tt><big>(</big><em>self</em>, <em>int width</em>, <em>int height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetSizeWH" title="Permalink to this definition">¶</a></dt> 2159 <dd><p>Sets the size of the window in pixels.</p> 2160 </dd></dl> 2161 2162 <dl class="method"> 2163 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetSizer"> 2164 <tt class="descname">SetSizer</tt><big>(</big><em>self</em>, <em>Sizer sizer</em>, <em>bool deleteOld=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetSizer" title="Permalink to this definition">¶</a></dt> 2165 <dd><p>Sets the window to have the given layout sizer. The window will then 2166 own the object, and will take care of its deletion. If an existing 2167 layout sizer object is already owned by the window, it will be deleted 2168 if the deleteOld parameter is true. Note that this function will also 2169 call SetAutoLayout implicitly with a True parameter if the sizer is 2170 non-None, and False otherwise.</p> 2171 </dd></dl> 2172 2173 <dl class="method"> 2174 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetSizerAndFit"> 2175 <tt class="descname">SetSizerAndFit</tt><big>(</big><em>self</em>, <em>Sizer sizer</em>, <em>bool deleteOld=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetSizerAndFit" title="Permalink to this definition">¶</a></dt> 2176 <dd><p>The same as SetSizer, except it also sets the size hints for the 2177 window based on the sizer’s minimum size.</p> 2178 </dd></dl> 2179 2180 <dl class="method"> 2181 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetThemeEnabled"> 2182 <tt class="descname">SetThemeEnabled</tt><big>(</big><em>self</em>, <em>bool enableTheme</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetThemeEnabled" title="Permalink to this definition">¶</a></dt> 2183 <dd><dl class="docutils"> 2184 <dt>This function tells a window if it should use the system’s “theme”</dt> 2185 <dd>code to draw the windows’ background instead if its own background 2186 drawing code. This will only have an effect on platforms that support 2187 the notion of themes in user defined windows. One such platform is 2188 GTK+ where windows can have (very colourful) backgrounds defined by a 2189 user’s selected theme.</dd> 2190 </dl> 2191 <p>Dialogs, notebook pages and the status bar have this flag set to true 2192 by default so that the default look and feel is simulated best.</p> 2193 </dd></dl> 2194 2195 <dl class="method"> 2196 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetToolTip"> 2197 <tt class="descname">SetToolTip</tt><big>(</big><em>self</em>, <em>ToolTip tip</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetToolTip" title="Permalink to this definition">¶</a></dt> 2198 <dd><p>Attach a tooltip to the window.</p> 2199 </dd></dl> 2200 2201 <dl class="method"> 2202 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetToolTipString"> 2203 <tt class="descname">SetToolTipString</tt><big>(</big><em>self</em>, <em>String tip</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetToolTipString" title="Permalink to this definition">¶</a></dt> 2204 <dd><p>Attach a tooltip to the window.</p> 2205 </dd></dl> 2206 2207 <dl class="method"> 2208 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetTransparent"> 2209 <tt class="descname">SetTransparent</tt><big>(</big><em>self</em>, <em>byte alpha</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetTransparent" title="Permalink to this definition">¶</a></dt> 2210 <dd><p>Attempt to set the transparency of this window to the <tt class="docutils literal"><span class="pre">alpha</span></tt> value, 2211 returns True on success. The <tt class="docutils literal"><span class="pre">alpha</span></tt> value is an integer in the 2212 range of 0 to 255, where 0 is fully transparent and 255 is fully 2213 opaque.</p> 2214 </dd></dl> 2215 2216 <dl class="method"> 2217 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetValidator"> 2218 <tt class="descname">SetValidator</tt><big>(</big><em>self</em>, <em>Validator validator</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetValidator" title="Permalink to this definition">¶</a></dt> 2219 <dd><p>Deletes the current validator (if any) and sets the window validator, 2220 having called wx.Validator.Clone to create a new validator of this 2221 type.</p> 2222 </dd></dl> 2223 2224 <dl class="method"> 2225 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetVirtualSize"> 2226 <tt class="descname">SetVirtualSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetVirtualSize" title="Permalink to this definition">¶</a></dt> 2227 <dd><p>Set the the virtual size of a window in pixels. For most windows this 2228 is just the client area of the window, but for some like scrolled 2229 windows it is more or less independent of the screen window size.</p> 2230 </dd></dl> 2231 2232 <dl class="method"> 2233 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetVirtualSizeHints"> 2234 <tt class="descname">SetVirtualSizeHints</tt><big>(</big><em>self</em>, <em>int minW</em>, <em>int minH</em>, <em>int maxW=-1</em>, <em>int maxH=-1</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetVirtualSizeHints" title="Permalink to this definition">¶</a></dt> 2235 <dd><p>Allows specification of minimum and maximum virtual window sizes. If a 2236 pair of values is not set (or set to -1), the default values will be 2237 used. If this function is called, the user will not be able to size 2238 the virtual area of the window outside the given bounds.</p> 2239 </dd></dl> 2240 2241 <dl class="method"> 2242 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetVirtualSizeHintsSz"> 2243 <tt class="descname">SetVirtualSizeHintsSz</tt><big>(</big><em>self</em>, <em>Size minSize</em>, <em>Size maxSize=DefaultSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetVirtualSizeHintsSz" title="Permalink to this definition">¶</a></dt> 2244 <dd><p>Allows specification of minimum and maximum virtual window sizes. If a 2245 pair of values is not set (or set to -1), the default values will be 2246 used. If this function is called, the user will not be able to size 2247 the virtual area of the window outside the given bounds.</p> 2248 </dd></dl> 2249 2250 <dl class="method"> 2251 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetVirtualSizeWH"> 2252 <tt class="descname">SetVirtualSizeWH</tt><big>(</big><em>self</em>, <em>int w</em>, <em>int h</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetVirtualSizeWH" title="Permalink to this definition">¶</a></dt> 2253 <dd><p>Set the the virtual size of a window in pixels. For most windows this 2254 is just the client area of the window, but for some like scrolled 2255 windows it is more or less independent of the screen window size.</p> 2256 </dd></dl> 2257 2258 <dl class="method"> 2259 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetWindowStyle"> 2260 <tt class="descname">SetWindowStyle</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetWindowStyle" title="Permalink to this definition">¶</a></dt> 2261 <dd><p>SetWindowStyleFlag(self, long style)</p> 2262 <p>Sets the style of the window. Please note that some styles cannot be 2263 changed after the window creation and that Refresh() might need to be 2264 called after changing the others for the change to take place 2265 immediately.</p> 2266 </dd></dl> 2267 2268 <dl class="method"> 2269 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetWindowStyleFlag"> 2270 <tt class="descname">SetWindowStyleFlag</tt><big>(</big><em>self</em>, <em>long style</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetWindowStyleFlag" title="Permalink to this definition">¶</a></dt> 2271 <dd><p>Sets the style of the window. Please note that some styles cannot be 2272 changed after the window creation and that Refresh() might need to be 2273 called after changing the others for the change to take place 2274 immediately.</p> 2275 </dd></dl> 2276 2277 <dl class="method"> 2278 <dt id="sans.guiframe.gui_manager.DefaultPanel.SetWindowVariant"> 2279 <tt class="descname">SetWindowVariant</tt><big>(</big><em>self</em>, <em>int variant</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.SetWindowVariant" title="Permalink to this definition">¶</a></dt> 2280 <dd><p>Sets the variant of the window/font size to use for this window, if 2281 the platform supports variants, for example, wxMac.</p> 2282 </dd></dl> 2283 2284 <dl class="method"> 2285 <dt id="sans.guiframe.gui_manager.DefaultPanel.ShouldInheritColours"> 2286 <tt class="descname">ShouldInheritColours</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ShouldInheritColours" title="Permalink to this definition">¶</a></dt> 2287 <dd><p>Return true from here to allow the colours of this window to be 2288 changed by InheritAttributes, returning false forbids inheriting them 2289 from the parent window.</p> 2290 <p>The base class version returns false, but this method is overridden in 2291 wxControl where it returns true.</p> 2292 </dd></dl> 2293 2294 <dl class="method"> 2295 <dt id="sans.guiframe.gui_manager.DefaultPanel.Show"> 2296 <tt class="descname">Show</tt><big>(</big><em>self</em>, <em>bool show=True</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Show" title="Permalink to this definition">¶</a></dt> 2297 <dd><p>Shows or hides the window. You may need to call Raise for a top level 2298 window if you want to bring it to top, although this is not needed if 2299 Show is called immediately after the frame creation. Returns True if 2300 the window has been shown or hidden or False if nothing was done 2301 because it already was in the requested state.</p> 2302 </dd></dl> 2303 2304 <dl class="attribute"> 2305 <dt id="sans.guiframe.gui_manager.DefaultPanel.Shown"> 2306 <tt class="descname">Shown</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Shown" title="Permalink to this definition">¶</a></dt> 2307 <dd><p>See <cite>IsShown</cite> and <cite>Show</cite></p> 2308 </dd></dl> 2309 2310 <dl class="attribute"> 2311 <dt id="sans.guiframe.gui_manager.DefaultPanel.Size"> 2312 <tt class="descname">Size</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Size" title="Permalink to this definition">¶</a></dt> 2313 <dd><p>See <cite>GetSize</cite> and <cite>SetSize</cite></p> 2314 </dd></dl> 2315 2316 <dl class="attribute"> 2317 <dt id="sans.guiframe.gui_manager.DefaultPanel.Sizer"> 2318 <tt class="descname">Sizer</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Sizer" title="Permalink to this definition">¶</a></dt> 2319 <dd><p>See <cite>GetSizer</cite> and <cite>SetSizer</cite></p> 2320 </dd></dl> 2321 2322 <dl class="method"> 2323 <dt id="sans.guiframe.gui_manager.DefaultPanel.Thaw"> 2324 <tt class="descname">Thaw</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Thaw" title="Permalink to this definition">¶</a></dt> 2325 <dd><p>Reenables window updating after a previous call to Freeze. Calls to 2326 Freeze/Thaw may be nested, so Thaw must be called the same number of 2327 times that Freeze was before the window will be updated.</p> 2328 </dd></dl> 2329 2330 <dl class="attribute"> 2331 <dt id="sans.guiframe.gui_manager.DefaultPanel.ThemeEnabled"> 2332 <tt class="descname">ThemeEnabled</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ThemeEnabled" title="Permalink to this definition">¶</a></dt> 2333 <dd><p>See <cite>GetThemeEnabled</cite> and <cite>SetThemeEnabled</cite></p> 2334 </dd></dl> 2335 2336 <dl class="method"> 2337 <dt id="sans.guiframe.gui_manager.DefaultPanel.ToggleWindowStyle"> 2338 <tt class="descname">ToggleWindowStyle</tt><big>(</big><em>self</em>, <em>int flag</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ToggleWindowStyle" title="Permalink to this definition">¶</a></dt> 2339 <dd><p>Turn the flag on if it had been turned off before and vice versa, 2340 returns True if the flag is turned on by this function call.</p> 2341 </dd></dl> 2342 2343 <dl class="attribute"> 2344 <dt id="sans.guiframe.gui_manager.DefaultPanel.ToolTip"> 2345 <tt class="descname">ToolTip</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.ToolTip" title="Permalink to this definition">¶</a></dt> 2346 <dd><p>See <cite>GetToolTip</cite> and <cite>SetToolTip</cite></p> 2347 </dd></dl> 2348 2349 <dl class="attribute"> 2350 <dt id="sans.guiframe.gui_manager.DefaultPanel.TopLevel"> 2351 <tt class="descname">TopLevel</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.TopLevel" title="Permalink to this definition">¶</a></dt> 2352 <dd><p>See <cite>IsTopLevel</cite></p> 2353 </dd></dl> 2354 2355 <dl class="attribute"> 2356 <dt id="sans.guiframe.gui_manager.DefaultPanel.TopLevelParent"> 2357 <tt class="descname">TopLevelParent</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.TopLevelParent" title="Permalink to this definition">¶</a></dt> 2358 <dd><p>See <cite>GetTopLevelParent</cite></p> 2359 </dd></dl> 2360 2361 <dl class="method"> 2362 <dt id="sans.guiframe.gui_manager.DefaultPanel.TransferDataFromWindow"> 2363 <tt class="descname">TransferDataFromWindow</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.TransferDataFromWindow" title="Permalink to this definition">¶</a></dt> 2364 <dd><p>Transfers values from child controls to data areas specified by their 2365 validators. Returns false if a transfer failed. If the window has 2366 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will 2367 also call TransferDataFromWindow() of all child windows.</p> 2368 </dd></dl> 2369 2370 <dl class="method"> 2371 <dt id="sans.guiframe.gui_manager.DefaultPanel.TransferDataToWindow"> 2372 <tt class="descname">TransferDataToWindow</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.TransferDataToWindow" title="Permalink to this definition">¶</a></dt> 2373 <dd><p>Transfers values to child controls from data areas specified by their 2374 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra 2375 style flag set, the method will also call TransferDataToWindow() of 2376 all child windows.</p> 2377 </dd></dl> 2378 2379 <dl class="method"> 2380 <dt id="sans.guiframe.gui_manager.DefaultPanel.Unbind"> 2381 <tt class="descname">Unbind</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Unbind" title="Permalink to this definition">¶</a></dt> 2382 <dd><p>Disconnects the event handler binding for event from self. 2383 Returns True if successful.</p> 2384 </dd></dl> 2385 2386 <dl class="method"> 2387 <dt id="sans.guiframe.gui_manager.DefaultPanel.UnregisterHotKey"> 2388 <tt class="descname">UnregisterHotKey</tt><big>(</big><em>self</em>, <em>int hotkeyId</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.UnregisterHotKey" title="Permalink to this definition">¶</a></dt> 2389 <dd><p>Unregisters a system wide hotkey.</p> 2390 </dd></dl> 2391 2392 <dl class="method"> 2393 <dt id="sans.guiframe.gui_manager.DefaultPanel.Update"> 2394 <tt class="descname">Update</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Update" title="Permalink to this definition">¶</a></dt> 2395 <dd><p>Calling this method immediately repaints the invalidated area of the 2396 window instead of waiting for the EVT_PAINT event to happen, (normally 2397 this would usually only happen when the flow of control returns to the 2398 event loop.) Notice that this function doesn’t refresh the window and 2399 does nothing if the window has been already repainted. Use <cite>Refresh</cite> 2400 first if you want to immediately redraw the window (or some portion of 2401 it) unconditionally.</p> 2402 </dd></dl> 2403 2404 <dl class="attribute"> 2405 <dt id="sans.guiframe.gui_manager.DefaultPanel.UpdateClientRect"> 2406 <tt class="descname">UpdateClientRect</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.UpdateClientRect" title="Permalink to this definition">¶</a></dt> 2407 <dd><p>See <cite>GetUpdateClientRect</cite></p> 2408 </dd></dl> 2409 2410 <dl class="attribute"> 2411 <dt id="sans.guiframe.gui_manager.DefaultPanel.UpdateRegion"> 2412 <tt class="descname">UpdateRegion</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.UpdateRegion" title="Permalink to this definition">¶</a></dt> 2413 <dd><p>See <cite>GetUpdateRegion</cite></p> 2414 </dd></dl> 2415 2416 <dl class="method"> 2417 <dt id="sans.guiframe.gui_manager.DefaultPanel.UpdateWindowUI"> 2418 <tt class="descname">UpdateWindowUI</tt><big>(</big><em>self</em>, <em>long flags=UPDATE_UI_NONE</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.UpdateWindowUI" title="Permalink to this definition">¶</a></dt> 2419 <dd><p>This function sends EVT_UPDATE_UI events to the window. The particular 2420 implementation depends on the window; for example a wx.ToolBar will 2421 send an update UI event for each toolbar button, and a wx.Frame will 2422 send an update UI event for each menubar menu item. You can call this 2423 function from your application to ensure that your UI is up-to-date at 2424 a particular point in time (as far as your EVT_UPDATE_UI handlers are 2425 concerned). This may be necessary if you have called 2426 <cite>wx.UpdateUIEvent.SetMode</cite> or <cite>wx.UpdateUIEvent.SetUpdateInterval</cite> to 2427 limit the overhead that wxWindows incurs by sending update UI events 2428 in idle time.</p> 2429 </dd></dl> 2430 2431 <dl class="method"> 2432 <dt id="sans.guiframe.gui_manager.DefaultPanel.UseBgCol"> 2433 <tt class="descname">UseBgCol</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.UseBgCol" title="Permalink to this definition">¶</a></dt> 2434 <dd></dd></dl> 2435 2436 <dl class="method"> 2437 <dt id="sans.guiframe.gui_manager.DefaultPanel.Validate"> 2438 <tt class="descname">Validate</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Validate" title="Permalink to this definition">¶</a></dt> 2439 <dd><p>Validates the current values of the child controls using their 2440 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra 2441 style flag set, the method will also call Validate() of all child 2442 windows. Returns false if any of the validations failed.</p> 2443 </dd></dl> 2444 2445 <dl class="attribute"> 2446 <dt id="sans.guiframe.gui_manager.DefaultPanel.Validator"> 2447 <tt class="descname">Validator</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.Validator" title="Permalink to this definition">¶</a></dt> 2448 <dd><p>See <cite>GetValidator</cite> and <cite>SetValidator</cite></p> 2449 </dd></dl> 2450 2451 <dl class="attribute"> 2452 <dt id="sans.guiframe.gui_manager.DefaultPanel.VirtualSize"> 2453 <tt class="descname">VirtualSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.VirtualSize" title="Permalink to this definition">¶</a></dt> 2454 <dd><p>See <cite>GetVirtualSize</cite> and <cite>SetVirtualSize</cite></p> 2455 </dd></dl> 2456 2457 <dl class="method"> 2458 <dt id="sans.guiframe.gui_manager.DefaultPanel.WarpPointer"> 2459 <tt class="descname">WarpPointer</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.WarpPointer" title="Permalink to this definition">¶</a></dt> 2460 <dd><p>Moves the pointer to the given position on the window.</p> 2461 <p>NOTE: This function is not supported under Mac because Apple Human 2462 Interface Guidelines forbid moving the mouse cursor programmatically.</p> 2463 </dd></dl> 2464 2465 <dl class="attribute"> 2466 <dt id="sans.guiframe.gui_manager.DefaultPanel.WindowStyle"> 2467 <tt class="descname">WindowStyle</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.WindowStyle" title="Permalink to this definition">¶</a></dt> 2468 <dd><p>See <cite>GetWindowStyle</cite> and <cite>SetWindowStyle</cite></p> 2469 </dd></dl> 2470 2471 <dl class="attribute"> 2472 <dt id="sans.guiframe.gui_manager.DefaultPanel.WindowStyleFlag"> 2473 <tt class="descname">WindowStyleFlag</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.WindowStyleFlag" title="Permalink to this definition">¶</a></dt> 2474 <dd><p>See <cite>GetWindowStyleFlag</cite> and <cite>SetWindowStyleFlag</cite></p> 2475 </dd></dl> 2476 2477 <dl class="method"> 2478 <dt id="sans.guiframe.gui_manager.DefaultPanel.WindowToClientSize"> 2479 <tt class="descname">WindowToClientSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.WindowToClientSize" title="Permalink to this definition">¶</a></dt> 2480 <dd></dd></dl> 2481 2482 <dl class="attribute"> 2483 <dt id="sans.guiframe.gui_manager.DefaultPanel.WindowVariant"> 2484 <tt class="descname">WindowVariant</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.WindowVariant" title="Permalink to this definition">¶</a></dt> 2485 <dd><p>See <cite>GetWindowVariant</cite> and <cite>SetWindowVariant</cite></p> 2486 </dd></dl> 2487 2488 <dl class="attribute"> 2489 <dt id="sans.guiframe.gui_manager.DefaultPanel.__class__"> 2490 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__class__" title="Permalink to this definition">¶</a></dt> 2491 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 2492 </dd></dl> 2493 2494 <dl class="attribute"> 2495 <dt id="sans.guiframe.gui_manager.DefaultPanel.__delattr__"> 2496 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__delattr__" title="Permalink to this definition">¶</a></dt> 2497 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 2498 </dd></dl> 2499 2500 <dl class="attribute"> 2501 <dt id="sans.guiframe.gui_manager.DefaultPanel.__dict__"> 2502 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x04F013F0></em><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__dict__" title="Permalink to this definition">¶</a></dt> 2503 <dd></dd></dl> 2504 2505 <dl class="attribute"> 2506 <dt id="sans.guiframe.gui_manager.DefaultPanel.__getattribute__"> 2507 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__getattribute__" title="Permalink to this definition">¶</a></dt> 2508 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 2509 </dd></dl> 2510 2511 <dl class="attribute"> 2512 <dt id="sans.guiframe.gui_manager.DefaultPanel.__hash__"> 2513 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__hash__" title="Permalink to this definition">¶</a></dt> 2514 <dd><p>x.__hash__() <==> hash(x)</p> 2515 </dd></dl> 2516 2517 <dl class="method"> 2518 <dt id="sans.guiframe.gui_manager.DefaultPanel.__init__"> 2519 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__init__" title="Permalink to this definition">¶</a></dt> 2520 <dd></dd></dl> 2521 2522 <dl class="attribute"> 2523 <dt id="sans.guiframe.gui_manager.DefaultPanel.__module__"> 2524 <tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.gui_manager'</em><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__module__" title="Permalink to this definition">¶</a></dt> 2525 <dd></dd></dl> 2526 2527 <dl class="staticmethod"> 2528 <dt id="sans.guiframe.gui_manager.DefaultPanel.__new__"> 2529 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__new__" title="Permalink to this definition">¶</a></dt> 2530 <dd></dd></dl> 2531 2532 <dl class="method"> 2533 <dt id="sans.guiframe.gui_manager.DefaultPanel.__reduce__"> 2534 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__reduce__" title="Permalink to this definition">¶</a></dt> 2535 <dd><p>helper for pickle</p> 2536 </dd></dl> 2537 2538 <dl class="method"> 2539 <dt id="sans.guiframe.gui_manager.DefaultPanel.__reduce_ex__"> 2540 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 2541 <dd><p>helper for pickle</p> 2542 </dd></dl> 2543 2544 <dl class="method"> 2545 <dt id="sans.guiframe.gui_manager.DefaultPanel.__repr__"> 2546 <tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__repr__" title="Permalink to this definition">¶</a></dt> 2547 <dd></dd></dl> 2548 2549 <dl class="attribute"> 2550 <dt id="sans.guiframe.gui_manager.DefaultPanel.__setattr__"> 2551 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__setattr__" title="Permalink to this definition">¶</a></dt> 2552 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 2553 </dd></dl> 2554 2555 <dl class="attribute"> 2556 <dt id="sans.guiframe.gui_manager.DefaultPanel.__str__"> 2557 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__str__" title="Permalink to this definition">¶</a></dt> 2558 <dd><p>x.__str__() <==> str(x)</p> 2559 </dd></dl> 2560 2561 <dl class="attribute"> 2562 <dt id="sans.guiframe.gui_manager.DefaultPanel.__weakref__"> 2563 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.__weakref__" title="Permalink to this definition">¶</a></dt> 2564 <dd><p>list of weak references to the object (if defined)</p> 2565 </dd></dl> 2566 2567 <dl class="method"> 2568 <dt id="sans.guiframe.gui_manager.DefaultPanel._setOORInfo"> 2569 <tt class="descname">_setOORInfo</tt><big>(</big><em>self</em>, <em>PyObject _self</em>, <em>bool incref=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._setOORInfo" title="Permalink to this definition">¶</a></dt> 2570 <dd></dd></dl> 2571 2572 <dl class="method"> 2573 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_bookmark_flag"> 2574 <tt class="descname">_set_bookmark_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_bookmark_flag" title="Permalink to this definition">¶</a></dt> 2575 <dd><p>The derivative class sets the bookmark flag value to indicate that it 2576 can be bookmarked</p> 2577 </dd></dl> 2578 2579 <dl class="method"> 2580 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_copy_flag"> 2581 <tt class="descname">_set_copy_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_copy_flag" title="Permalink to this definition">¶</a></dt> 2582 <dd><p>The derivative class sets the copy flag value to indicate that the 2583 action done can be recovered</p> 2584 </dd></dl> 2585 2586 <dl class="method"> 2587 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_drag_flag"> 2588 <tt class="descname">_set_drag_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_drag_flag" title="Permalink to this definition">¶</a></dt> 2589 <dd><p>The derivative class sets the drag flag value to indicate that 2590 dragging motion is possible</p> 2591 </dd></dl> 2592 2593 <dl class="method"> 2594 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_paste_flag"> 2595 <tt class="descname">_set_paste_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_paste_flag" title="Permalink to this definition">¶</a></dt> 2596 <dd><p>The derivative class sets the paste flag value to indicate that the 2597 action done can be recovered</p> 2598 </dd></dl> 2599 2600 <dl class="method"> 2601 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_preview_flag"> 2602 <tt class="descname">_set_preview_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_preview_flag" title="Permalink to this definition">¶</a></dt> 2603 <dd><p>The derivative class sets the preview flag value to indicate that it 2604 can be previewed</p> 2605 </dd></dl> 2606 2607 <dl class="method"> 2608 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_print_flag"> 2609 <tt class="descname">_set_print_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_print_flag" title="Permalink to this definition">¶</a></dt> 2610 <dd><p>The derivative class sets the print flag value to indicate that it can 2611 be printed</p> 2612 </dd></dl> 2613 2614 <dl class="method"> 2615 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_redo_flag"> 2616 <tt class="descname">_set_redo_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_redo_flag" title="Permalink to this definition">¶</a></dt> 2617 <dd><p>The derivative class sets the redo flag value to indicate that the 2618 action done can be recovered</p> 2619 </dd></dl> 2620 2621 <dl class="method"> 2622 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_reset_flag"> 2623 <tt class="descname">_set_reset_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_reset_flag" title="Permalink to this definition">¶</a></dt> 2624 <dd><p>The derivative class sets the reset flag value to indicate that it 2625 can be reset</p> 2626 </dd></dl> 2627 2628 <dl class="method"> 2629 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_save_flag"> 2630 <tt class="descname">_set_save_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_save_flag" title="Permalink to this definition">¶</a></dt> 2631 <dd><p>The derivative class sets the drag flag value to indicate that it 2632 can be saved</p> 2633 </dd></dl> 2634 2635 <dl class="method"> 2636 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_undo_flag"> 2637 <tt class="descname">_set_undo_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_undo_flag" title="Permalink to this definition">¶</a></dt> 2638 <dd><p>The derivative class sets the undo flag value to indicate that the 2639 current action done can be canceled</p> 2640 </dd></dl> 2641 2642 <dl class="method"> 2643 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_zoom_flag"> 2644 <tt class="descname">_set_zoom_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_zoom_flag" title="Permalink to this definition">¶</a></dt> 2645 <dd><p>The derivative class sets the zoom flag value to indicate that it 2646 can be zoomed</p> 2647 </dd></dl> 2648 2649 <dl class="method"> 2650 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_zoomed_in_flag"> 2651 <tt class="descname">_set_zoomed_in_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_zoomed_in_flag" title="Permalink to this definition">¶</a></dt> 2652 <dd><p>The derivative class sets the zoom in flag value to indicate that it 2653 can be zoomed in</p> 2654 </dd></dl> 2655 2656 <dl class="method"> 2657 <dt id="sans.guiframe.gui_manager.DefaultPanel._set_zoomed_out_flag"> 2658 <tt class="descname">_set_zoomed_out_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel._set_zoomed_out_flag" title="Permalink to this definition">¶</a></dt> 2659 <dd><p>The derivative class sets the zoom out flag value to indicate that it 2660 can be zoomed out</p> 2661 </dd></dl> 2662 2663 <dl class="method"> 2664 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_bookmark_flag"> 2665 <tt class="descname">get_bookmark_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_bookmark_flag" title="Permalink to this definition">¶</a></dt> 2666 <dd><p>Get the bookmark flag to update appropriately the tool bar</p> 2667 </dd></dl> 2668 2669 <dl class="method"> 2670 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_copy_flag"> 2671 <tt class="descname">get_copy_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_copy_flag" title="Permalink to this definition">¶</a></dt> 2672 <dd><p>Get the copy flag to update appropriately the tool bar</p> 2673 </dd></dl> 2674 2675 <dl class="method"> 2676 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_data"> 2677 <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_data" title="Permalink to this definition">¶</a></dt> 2678 <dd><p>return list of current data</p> 2679 </dd></dl> 2680 2681 <dl class="method"> 2682 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_drag_flag"> 2683 <tt class="descname">get_drag_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_drag_flag" title="Permalink to this definition">¶</a></dt> 2684 <dd><p>Get the drag flag to update appropriately the tool bar</p> 2685 </dd></dl> 2686 2687 <dl class="method"> 2688 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_manager"> 2689 <tt class="descname">get_manager</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_manager" title="Permalink to this definition">¶</a></dt> 2690 <dd></dd></dl> 2691 2692 <dl class="method"> 2693 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_paste_flag"> 2694 <tt class="descname">get_paste_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_paste_flag" title="Permalink to this definition">¶</a></dt> 2695 <dd><p>Get the copy flag to update appropriately the tool bar</p> 2696 </dd></dl> 2697 2698 <dl class="method"> 2699 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_preview_flag"> 2700 <tt class="descname">get_preview_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_preview_flag" title="Permalink to this definition">¶</a></dt> 2701 <dd><p>Get the preview flag to update appropriately the tool bar</p> 2702 </dd></dl> 2703 2704 <dl class="method"> 2705 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_print_flag"> 2706 <tt class="descname">get_print_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_print_flag" title="Permalink to this definition">¶</a></dt> 2707 <dd><p>Get the print flag to update appropriately the tool bar</p> 2708 </dd></dl> 2709 2710 <dl class="method"> 2711 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_redo_flag"> 2712 <tt class="descname">get_redo_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_redo_flag" title="Permalink to this definition">¶</a></dt> 2713 <dd><p>Get the redo flag to update appropriately the tool bar</p> 2714 </dd></dl> 2715 2716 <dl class="method"> 2717 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_reset_flag"> 2718 <tt class="descname">get_reset_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_reset_flag" title="Permalink to this definition">¶</a></dt> 2719 <dd><p>Get the reset flag to update appropriately the tool bar</p> 2720 </dd></dl> 2721 2722 <dl class="method"> 2723 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_save_flag"> 2724 <tt class="descname">get_save_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_save_flag" title="Permalink to this definition">¶</a></dt> 2725 <dd><p>Get the save flag to update appropriately the tool bar</p> 2726 </dd></dl> 2727 2728 <dl class="method"> 2729 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_state"> 2730 <tt class="descname">get_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_state" title="Permalink to this definition">¶</a></dt> 2731 <dd><p>return the current state</p> 2732 </dd></dl> 2733 2734 <dl class="method"> 2735 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_undo_flag"> 2736 <tt class="descname">get_undo_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_undo_flag" title="Permalink to this definition">¶</a></dt> 2737 <dd><p>Get the undo flag to update appropriately the tool bar</p> 2738 </dd></dl> 2739 2740 <dl class="method"> 2741 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_zoom_flag"> 2742 <tt class="descname">get_zoom_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_zoom_flag" title="Permalink to this definition">¶</a></dt> 2743 <dd><p>Get the zoom flag to update appropriately the tool bar</p> 2744 </dd></dl> 2745 2746 <dl class="method"> 2747 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_zoom_in_flag"> 2748 <tt class="descname">get_zoom_in_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_zoom_in_flag" title="Permalink to this definition">¶</a></dt> 2749 <dd><p>Get the zoom in flag to update appropriately the tool bar</p> 2750 </dd></dl> 2751 2752 <dl class="method"> 2753 <dt id="sans.guiframe.gui_manager.DefaultPanel.get_zoom_out_flag"> 2754 <tt class="descname">get_zoom_out_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.get_zoom_out_flag" title="Permalink to this definition">¶</a></dt> 2755 <dd><p>Get the zoom out flag to update appropriately the tool bar</p> 2756 </dd></dl> 2757 2758 <dl class="attribute"> 2759 <dt id="sans.guiframe.gui_manager.DefaultPanel.group_id"> 2760 <tt class="descname">group_id</tt><em class="property"> = None</em><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.group_id" title="Permalink to this definition">¶</a></dt> 2761 <dd></dd></dl> 2762 2763 <dl class="method"> 2764 <dt id="sans.guiframe.gui_manager.DefaultPanel.has_changed"> 2765 <tt class="descname">has_changed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.has_changed" title="Permalink to this definition">¶</a></dt> 2766 <dd></dd></dl> 2767 2768 <dl class="method"> 2769 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_batch_selection"> 2770 <tt class="descname">on_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_batch_selection" title="Permalink to this definition">¶</a></dt> 2771 <dd><table class="docutils field-list" frame="void" rules="none"> 2772 <col class="field-name" /> 2773 <col class="field-body" /> 2774 <tbody valign="top"> 2775 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – contains parameter enable . when enable is set to True</td> 2776 </tr> 2777 </tbody> 2778 </table> 2779 <p>the application is in Batch mode 2780 else the application is default mode(single mode)</p> 2781 </dd></dl> 2782 2783 <dl class="method"> 2784 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_bookmark"> 2785 <tt class="descname">on_bookmark</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_bookmark" title="Permalink to this definition">¶</a></dt> 2786 <dd><p>The derivative class is on bookmark mode if implemented</p> 2787 </dd></dl> 2788 2789 <dl class="method"> 2790 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_copy"> 2791 <tt class="descname">on_copy</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_copy" title="Permalink to this definition">¶</a></dt> 2792 <dd><p>The copy action if possible</p> 2793 </dd></dl> 2794 2795 <dl class="method"> 2796 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_drag"> 2797 <tt class="descname">on_drag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_drag" title="Permalink to this definition">¶</a></dt> 2798 <dd><p>The derivative class allows dragging motion if implemented</p> 2799 </dd></dl> 2800 2801 <dl class="method"> 2802 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_kill_focus"> 2803 <tt class="descname">on_kill_focus</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_kill_focus" title="Permalink to this definition">¶</a></dt> 2804 <dd><p>The derivative class is on unfocus if implemented</p> 2805 </dd></dl> 2806 2807 <dl class="method"> 2808 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_paste"> 2809 <tt class="descname">on_paste</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_paste" title="Permalink to this definition">¶</a></dt> 2810 <dd><p>The paste action if possible</p> 2811 </dd></dl> 2812 2813 <dl class="method"> 2814 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_preview"> 2815 <tt class="descname">on_preview</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_preview" title="Permalink to this definition">¶</a></dt> 2816 <dd><p>Display a printable version of the class derivative</p> 2817 </dd></dl> 2818 2819 <dl class="method"> 2820 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_redo"> 2821 <tt class="descname">on_redo</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_redo" title="Permalink to this definition">¶</a></dt> 2822 <dd><p>The previous action is restored if possible</p> 2823 </dd></dl> 2824 2825 <dl class="method"> 2826 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_reset"> 2827 <tt class="descname">on_reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_reset" title="Permalink to this definition">¶</a></dt> 2828 <dd><p>The derivative class state is restored</p> 2829 </dd></dl> 2830 2831 <dl class="method"> 2832 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_save"> 2833 <tt class="descname">on_save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_save" title="Permalink to this definition">¶</a></dt> 2834 <dd><p>The state of the derivative class is restored</p> 2835 </dd></dl> 2836 2837 <dl class="method"> 2838 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_set_focus"> 2839 <tt class="descname">on_set_focus</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_set_focus" title="Permalink to this definition">¶</a></dt> 2840 <dd><p>The derivative class is on focus if implemented</p> 2841 </dd></dl> 2842 2843 <dl class="method"> 2844 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_tap_focus"> 2845 <tt class="descname">on_tap_focus</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_tap_focus" title="Permalink to this definition">¶</a></dt> 2846 <dd><p>Update menu on clicking the panel tap</p> 2847 </dd></dl> 2848 2849 <dl class="method"> 2850 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_undo"> 2851 <tt class="descname">on_undo</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_undo" title="Permalink to this definition">¶</a></dt> 2852 <dd><p>The current action is canceled</p> 2853 </dd></dl> 2854 2855 <dl class="method"> 2856 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_zoom"> 2857 <tt class="descname">on_zoom</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_zoom" title="Permalink to this definition">¶</a></dt> 2858 <dd><p>The derivative class is on zoom mode (using pane) 2859 if zoom mode is implemented</p> 2860 </dd></dl> 2861 2862 <dl class="method"> 2863 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_zoom_in"> 2864 <tt class="descname">on_zoom_in</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_zoom_in" title="Permalink to this definition">¶</a></dt> 2865 <dd><p>The derivative class is on zoom in mode if implemented</p> 2866 </dd></dl> 2867 2868 <dl class="method"> 2869 <dt id="sans.guiframe.gui_manager.DefaultPanel.on_zoom_out"> 2870 <tt class="descname">on_zoom_out</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.on_zoom_out" title="Permalink to this definition">¶</a></dt> 2871 <dd><p>The derivative class is on zoom out mode if implemented</p> 2872 </dd></dl> 2873 2874 <dl class="method"> 2875 <dt id="sans.guiframe.gui_manager.DefaultPanel.save_project"> 2876 <tt class="descname">save_project</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.save_project" title="Permalink to this definition">¶</a></dt> 2877 <dd><p>return an xml node containing state of the panel 2878 that guiframe can write to file</p> 2879 </dd></dl> 2880 2881 <dl class="method"> 2882 <dt id="sans.guiframe.gui_manager.DefaultPanel.set_manager"> 2883 <tt class="descname">set_manager</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.set_manager" title="Permalink to this definition">¶</a></dt> 2884 <dd></dd></dl> 2885 2886 <dl class="attribute"> 2887 <dt id="sans.guiframe.gui_manager.DefaultPanel.thisown"> 2888 <tt class="descname">thisown</tt><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.thisown" title="Permalink to this definition">¶</a></dt> 2889 <dd><p>The membership flag</p> 2890 </dd></dl> 2891 2892 <dl class="attribute"> 2893 <dt id="sans.guiframe.gui_manager.DefaultPanel.uid"> 2894 <tt class="descname">uid</tt><em class="property"> = None</em><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.uid" title="Permalink to this definition">¶</a></dt> 2895 <dd></dd></dl> 2896 2897 <dl class="attribute"> 2898 <dt id="sans.guiframe.gui_manager.DefaultPanel.window_caption"> 2899 <tt class="descname">window_caption</tt><em class="property"> = 'Welcome panel'</em><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.window_caption" title="Permalink to this definition">¶</a></dt> 2900 <dd></dd></dl> 2901 2902 <dl class="attribute"> 2903 <dt id="sans.guiframe.gui_manager.DefaultPanel.window_name"> 2904 <tt class="descname">window_name</tt><em class="property"> = 'default'</em><a class="headerlink" href="#sans.guiframe.gui_manager.DefaultPanel.window_name" title="Permalink to this definition">¶</a></dt> 2905 <dd></dd></dl> 2906 2907 </dd></dl> 2908 2909 <dl class="class"> 2910 <dt id="sans.guiframe.gui_manager.ViewApp"> 2911 <em class="property">class </em><tt class="descclassname">sans.guiframe.gui_manager.</tt><tt class="descname">ViewApp</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp" title="Permalink to this definition">¶</a></dt> 2912 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.App</span></tt></p> 2913 <dl class="attribute"> 2914 <dt id="sans.guiframe.gui_manager.ViewApp.Active"> 2915 <tt class="descname">Active</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Active" title="Permalink to this definition">¶</a></dt> 2916 <dd><p>IsActive(self) -> bool</p> 2917 <p>Return True if our app has focus.</p> 2918 </dd></dl> 2919 2920 <dl class="method"> 2921 <dt id="sans.guiframe.gui_manager.ViewApp.AddPendingEvent"> 2922 <tt class="descname">AddPendingEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.AddPendingEvent" title="Permalink to this definition">¶</a></dt> 2923 <dd></dd></dl> 2924 2925 <dl class="attribute"> 2926 <dt id="sans.guiframe.gui_manager.ViewApp.AppName"> 2927 <tt class="descname">AppName</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.AppName" title="Permalink to this definition">¶</a></dt> 2928 <dd><p>See <cite>GetAppName</cite> and <cite>SetAppName</cite></p> 2929 </dd></dl> 2930 2931 <dl class="attribute"> 2932 <dt id="sans.guiframe.gui_manager.ViewApp.AssertMode"> 2933 <tt class="descname">AssertMode</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.AssertMode" title="Permalink to this definition">¶</a></dt> 2934 <dd><p>See <cite>GetAssertMode</cite> and <cite>SetAssertMode</cite></p> 2935 </dd></dl> 2936 2937 <dl class="method"> 2938 <dt id="sans.guiframe.gui_manager.ViewApp.Bind"> 2939 <tt class="descname">Bind</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Bind" title="Permalink to this definition">¶</a></dt> 2940 <dd><p>Bind an event to an event handler.</p> 2941 <table class="docutils field-list" frame="void" rules="none"> 2942 <col class="field-name" /> 2943 <col class="field-body" /> 2944 <tbody valign="top"> 2945 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 2946 <li><strong>event</strong> – One of the EVT_* objects that specifies the 2947 type of event to bind,</li> 2948 <li><strong>handler</strong> – A callable object to be invoked when the 2949 event is delivered to self. Pass None to 2950 disconnect an event handler.</li> 2951 <li><strong>source</strong> – Sometimes the event originates from a 2952 different window than self, but you still 2953 want to catch it in self. (For example, a 2954 button event delivered to a frame.) By 2955 passing the source of the event, the event 2956 handling system is able to differentiate 2957 between the same event type from different 2958 controls.</li> 2959 <li><strong>id</strong> – Used to spcify the event source by ID instead 2960 of instance.</li> 2961 <li><strong>id2</strong> – Used when it is desirable to bind a handler 2962 to a range of IDs, such as with EVT_MENU_RANGE.</li> 2963 </ul> 2964 </td> 2965 </tr> 2966 </tbody> 2967 </table> 2968 </dd></dl> 2969 2970 <dl class="attribute"> 2971 <dt id="sans.guiframe.gui_manager.ViewApp.ClassName"> 2972 <tt class="descname">ClassName</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.ClassName" title="Permalink to this definition">¶</a></dt> 2973 <dd><p>See <cite>GetClassName</cite> and <cite>SetClassName</cite></p> 2974 </dd></dl> 2975 2976 <dl class="method"> 2977 <dt id="sans.guiframe.gui_manager.ViewApp.Connect"> 2978 <tt class="descname">Connect</tt><big>(</big><em>self</em>, <em>int id</em>, <em>int lastId</em>, <em>int eventType</em>, <em>PyObject func</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Connect" title="Permalink to this definition">¶</a></dt> 2979 <dd></dd></dl> 2980 2981 <dl class="method"> 2982 <dt id="sans.guiframe.gui_manager.ViewApp.Destroy"> 2983 <tt class="descname">Destroy</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Destroy" title="Permalink to this definition">¶</a></dt> 2984 <dd></dd></dl> 2985 2986 <dl class="method"> 2987 <dt id="sans.guiframe.gui_manager.ViewApp.Disconnect"> 2988 <tt class="descname">Disconnect</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Disconnect" title="Permalink to this definition">¶</a></dt> 2989 <dd><p>Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, 2990 PyObject func=None) -> bool</p> 2991 </dd></dl> 2992 2993 <dl class="method"> 2994 <dt id="sans.guiframe.gui_manager.ViewApp.Dispatch"> 2995 <tt class="descname">Dispatch</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Dispatch" title="Permalink to this definition">¶</a></dt> 2996 <dd><p>Process the first event in the event queue (blocks until an event 2997 appears if there are none currently)</p> 2998 </dd></dl> 2999 3000 <dl class="attribute"> 3001 <dt id="sans.guiframe.gui_manager.ViewApp.EvtHandlerEnabled"> 3002 <tt class="descname">EvtHandlerEnabled</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.EvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 3003 <dd><p>See <cite>GetEvtHandlerEnabled</cite> and <cite>SetEvtHandlerEnabled</cite></p> 3004 </dd></dl> 3005 3006 <dl class="method"> 3007 <dt id="sans.guiframe.gui_manager.ViewApp.Exit"> 3008 <tt class="descname">Exit</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Exit" title="Permalink to this definition">¶</a></dt> 3009 <dd><p>Exit the main loop thus terminating the application. 3010 :see: <cite>wx.Exit</cite></p> 3011 </dd></dl> 3012 3013 <dl class="method"> 3014 <dt id="sans.guiframe.gui_manager.ViewApp.ExitMainLoop"> 3015 <tt class="descname">ExitMainLoop</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.ExitMainLoop" title="Permalink to this definition">¶</a></dt> 3016 <dd><p>Exit the main GUI loop during the next iteration of the main 3017 loop, (i.e. it does not stop the program immediately!)</p> 3018 </dd></dl> 3019 3020 <dl class="attribute"> 3021 <dt id="sans.guiframe.gui_manager.ViewApp.ExitOnFrameDelete"> 3022 <tt class="descname">ExitOnFrameDelete</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.ExitOnFrameDelete" title="Permalink to this definition">¶</a></dt> 3023 <dd><p>See <cite>GetExitOnFrameDelete</cite> and <cite>SetExitOnFrameDelete</cite></p> 3024 </dd></dl> 3025 3026 <dl class="method"> 3027 <dt id="sans.guiframe.gui_manager.ViewApp.FilterEvent"> 3028 <tt class="descname">FilterEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.FilterEvent" title="Permalink to this definition">¶</a></dt> 3029 <dd><p>Filters all events. <cite>SetCallFilterEvent</cite> controls whether or not your 3030 override is called.</p> 3031 </dd></dl> 3032 3033 <dl class="method"> 3034 <dt id="sans.guiframe.gui_manager.ViewApp.GetAppName"> 3035 <tt class="descname">GetAppName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetAppName" title="Permalink to this definition">¶</a></dt> 3036 <dd><p>Get the application name.</p> 3037 </dd></dl> 3038 3039 <dl class="method"> 3040 <dt id="sans.guiframe.gui_manager.ViewApp.GetAssertMode"> 3041 <tt class="descname">GetAssertMode</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetAssertMode" title="Permalink to this definition">¶</a></dt> 3042 <dd><p>Get the current OnAssert behaviour setting.</p> 3043 </dd></dl> 3044 3045 <dl class="method"> 3046 <dt id="sans.guiframe.gui_manager.ViewApp.GetCallFilterEvent"> 3047 <tt class="descname">GetCallFilterEvent</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetCallFilterEvent" title="Permalink to this definition">¶</a></dt> 3048 <dd><p>Returns the state of the Call FilterEvent flag.</p> 3049 </dd></dl> 3050 3051 <dl class="method"> 3052 <dt id="sans.guiframe.gui_manager.ViewApp.GetClassName"> 3053 <tt class="descname">GetClassName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetClassName" title="Permalink to this definition">¶</a></dt> 3054 <dd><p>Get the application’s class name.</p> 3055 </dd></dl> 3056 3057 <dl class="staticmethod"> 3058 <dt id="sans.guiframe.gui_manager.ViewApp.GetComCtl32Version"> 3059 <em class="property">static </em><tt class="descname">GetComCtl32Version</tt><big>(</big><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetComCtl32Version" title="Permalink to this definition">¶</a></dt> 3060 <dd><p>Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if 3061 it wasn’t found at all. Raises an exception on non-Windows platforms.</p> 3062 </dd></dl> 3063 3064 <dl class="method"> 3065 <dt id="sans.guiframe.gui_manager.ViewApp.GetEvtHandlerEnabled"> 3066 <tt class="descname">GetEvtHandlerEnabled</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 3067 <dd></dd></dl> 3068 3069 <dl class="method"> 3070 <dt id="sans.guiframe.gui_manager.ViewApp.GetExitOnFrameDelete"> 3071 <tt class="descname">GetExitOnFrameDelete</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetExitOnFrameDelete" title="Permalink to this definition">¶</a></dt> 3072 <dd><p>Get the current exit behaviour setting.</p> 3073 </dd></dl> 3074 3075 <dl class="method"> 3076 <dt id="sans.guiframe.gui_manager.ViewApp.GetLayoutDirection"> 3077 <tt class="descname">GetLayoutDirection</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetLayoutDirection" title="Permalink to this definition">¶</a></dt> 3078 <dd><p>Return the layout direction for the current locale.</p> 3079 </dd></dl> 3080 3081 <dl class="staticmethod"> 3082 <dt id="sans.guiframe.gui_manager.ViewApp.GetMacAboutMenuItemId"> 3083 <em class="property">static </em><tt class="descname">GetMacAboutMenuItemId</tt><big>(</big><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetMacAboutMenuItemId" title="Permalink to this definition">¶</a></dt> 3084 <dd></dd></dl> 3085 3086 <dl class="staticmethod"> 3087 <dt id="sans.guiframe.gui_manager.ViewApp.GetMacExitMenuItemId"> 3088 <em class="property">static </em><tt class="descname">GetMacExitMenuItemId</tt><big>(</big><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetMacExitMenuItemId" title="Permalink to this definition">¶</a></dt> 3089 <dd></dd></dl> 3090 3091 <dl class="staticmethod"> 3092 <dt id="sans.guiframe.gui_manager.ViewApp.GetMacHelpMenuTitleName"> 3093 <em class="property">static </em><tt class="descname">GetMacHelpMenuTitleName</tt><big>(</big><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetMacHelpMenuTitleName" title="Permalink to this definition">¶</a></dt> 3094 <dd></dd></dl> 3095 3096 <dl class="staticmethod"> 3097 <dt id="sans.guiframe.gui_manager.ViewApp.GetMacPreferencesMenuItemId"> 3098 <em class="property">static </em><tt class="descname">GetMacPreferencesMenuItemId</tt><big>(</big><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetMacPreferencesMenuItemId" title="Permalink to this definition">¶</a></dt> 3099 <dd></dd></dl> 3100 3101 <dl class="staticmethod"> 3102 <dt id="sans.guiframe.gui_manager.ViewApp.GetMacSupportPCMenuShortcuts"> 3103 <em class="property">static </em><tt class="descname">GetMacSupportPCMenuShortcuts</tt><big>(</big><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetMacSupportPCMenuShortcuts" title="Permalink to this definition">¶</a></dt> 3104 <dd></dd></dl> 3105 3106 <dl class="method"> 3107 <dt id="sans.guiframe.gui_manager.ViewApp.GetNextHandler"> 3108 <tt class="descname">GetNextHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetNextHandler" title="Permalink to this definition">¶</a></dt> 3109 <dd></dd></dl> 3110 3111 <dl class="method"> 3112 <dt id="sans.guiframe.gui_manager.ViewApp.GetPreviousHandler"> 3113 <tt class="descname">GetPreviousHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetPreviousHandler" title="Permalink to this definition">¶</a></dt> 3114 <dd></dd></dl> 3115 3116 <dl class="method"> 3117 <dt id="sans.guiframe.gui_manager.ViewApp.GetPrintMode"> 3118 <tt class="descname">GetPrintMode</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetPrintMode" title="Permalink to this definition">¶</a></dt> 3119 <dd></dd></dl> 3120 3121 <dl class="method"> 3122 <dt id="sans.guiframe.gui_manager.ViewApp.GetTopWindow"> 3123 <tt class="descname">GetTopWindow</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetTopWindow" title="Permalink to this definition">¶</a></dt> 3124 <dd><p>Return the <em>main</em> top level window (if it hadn’t been set previously 3125 with SetTopWindow(), will return just some top level window and, if 3126 there not any, will return None)</p> 3127 </dd></dl> 3128 3129 <dl class="method"> 3130 <dt id="sans.guiframe.gui_manager.ViewApp.GetTraits"> 3131 <tt class="descname">GetTraits</tt><big>(</big><em>self</em><big>)</big> → wxAppTraits<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetTraits" title="Permalink to this definition">¶</a></dt> 3132 <dd><p>Return (and create if necessary) the app traits object to which we 3133 delegate for everything which either should be configurable by the 3134 user (then he can change the default behaviour simply by overriding 3135 CreateTraits() and returning his own traits object) or which is 3136 GUI/console dependent as then wx.AppTraits allows us to abstract the 3137 differences behind the common facade.</p> 3138 <table class="docutils field-list" frame="void" rules="none"> 3139 <col class="field-name" /> 3140 <col class="field-body" /> 3141 <tbody valign="top"> 3142 <tr class="field-odd field"><th class="field-name">Todo :</th><td class="field-body">Add support for overriding CreateAppTraits in wxPython.</td> 3143 </tr> 3144 </tbody> 3145 </table> 3146 </dd></dl> 3147 3148 <dl class="method"> 3149 <dt id="sans.guiframe.gui_manager.ViewApp.GetUseBestVisual"> 3150 <tt class="descname">GetUseBestVisual</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetUseBestVisual" title="Permalink to this definition">¶</a></dt> 3151 <dd><p>Get current UseBestVisual setting.</p> 3152 </dd></dl> 3153 3154 <dl class="method"> 3155 <dt id="sans.guiframe.gui_manager.ViewApp.GetVendorName"> 3156 <tt class="descname">GetVendorName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.GetVendorName" title="Permalink to this definition">¶</a></dt> 3157 <dd><p>Get the application’s vendor name.</p> 3158 </dd></dl> 3159 3160 <dl class="method"> 3161 <dt id="sans.guiframe.gui_manager.ViewApp.IsActive"> 3162 <tt class="descname">IsActive</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.IsActive" title="Permalink to this definition">¶</a></dt> 3163 <dd><p>Return True if our app has focus.</p> 3164 </dd></dl> 3165 3166 <dl class="staticmethod"> 3167 <dt id="sans.guiframe.gui_manager.ViewApp.IsDisplayAvailable"> 3168 <em class="property">static </em><tt class="descname">IsDisplayAvailable</tt><big>(</big><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.IsDisplayAvailable" title="Permalink to this definition">¶</a></dt> 3169 <dd><p>Tests if it is possible to create a GUI in the current environment. 3170 This will mean different things on the different platforms.</p> 3171 <blockquote> 3172 <div><ul class="simple"> 3173 <li>On X Windows systems this function will return <tt class="docutils literal"><span class="pre">False</span></tt> if it is 3174 not able to open a connection to the X display, which can happen 3175 if $DISPLAY is not set, or is not set correctly.</li> 3176 <li>On Mac OS X a <tt class="docutils literal"><span class="pre">False</span></tt> return value will mean that wx is not 3177 able to access the window manager, which can happen if logged in 3178 remotely or if running from the normal version of python instead 3179 of the framework version, (i.e., pythonw.)</li> 3180 <li>On MS Windows...</li> 3181 </ul> 3182 </div></blockquote> 3183 </dd></dl> 3184 3185 <dl class="staticmethod"> 3186 <dt id="sans.guiframe.gui_manager.ViewApp.IsMainLoopRunning"> 3187 <em class="property">static </em><tt class="descname">IsMainLoopRunning</tt><big>(</big><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.IsMainLoopRunning" title="Permalink to this definition">¶</a></dt> 3188 <dd><p>Returns True if we’re running the main loop, i.e. if the events can 3189 currently be dispatched.</p> 3190 </dd></dl> 3191 3192 <dl class="method"> 3193 <dt id="sans.guiframe.gui_manager.ViewApp.IsSameAs"> 3194 <tt class="descname">IsSameAs</tt><big>(</big><em>self</em>, <em>Object p</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.IsSameAs" title="Permalink to this definition">¶</a></dt> 3195 <dd><p>For wx.Objects that use C++ reference counting internally, this method 3196 can be used to determine if two objects are referencing the same data 3197 object.</p> 3198 </dd></dl> 3199 3200 <dl class="attribute"> 3201 <dt id="sans.guiframe.gui_manager.ViewApp.LayoutDirection"> 3202 <tt class="descname">LayoutDirection</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.LayoutDirection" title="Permalink to this definition">¶</a></dt> 3203 <dd><p>See <cite>GetLayoutDirection</cite></p> 3204 </dd></dl> 3205 3206 <dl class="method"> 3207 <dt id="sans.guiframe.gui_manager.ViewApp.MacHideApp"> 3208 <tt class="descname">MacHideApp</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.MacHideApp" title="Permalink to this definition">¶</a></dt> 3209 <dd><p>Hide all application windows just as the user can do with the system 3210 Hide command. Mac only.</p> 3211 </dd></dl> 3212 3213 <dl class="method"> 3214 <dt id="sans.guiframe.gui_manager.ViewApp.MacRequestUserAttention"> 3215 <tt class="descname">MacRequestUserAttention</tt><big>(</big><em>self</em>, <em>int ?</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.MacRequestUserAttention" title="Permalink to this definition">¶</a></dt> 3216 <dd></dd></dl> 3217 3218 <dl class="method"> 3219 <dt id="sans.guiframe.gui_manager.ViewApp.MainLoop"> 3220 <tt class="descname">MainLoop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.MainLoop" title="Permalink to this definition">¶</a></dt> 3221 <dd><p>Execute the main GUI event loop</p> 3222 </dd></dl> 3223 3224 <dl class="attribute"> 3225 <dt id="sans.guiframe.gui_manager.ViewApp.NextHandler"> 3226 <tt class="descname">NextHandler</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.NextHandler" title="Permalink to this definition">¶</a></dt> 3227 <dd><p>See <cite>GetNextHandler</cite> and <cite>SetNextHandler</cite></p> 3228 </dd></dl> 3229 3230 <dl class="method"> 3231 <dt id="sans.guiframe.gui_manager.ViewApp.OnInit"> 3232 <tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.OnInit" title="Permalink to this definition">¶</a></dt> 3233 <dd></dd></dl> 3234 3235 <dl class="method"> 3236 <dt id="sans.guiframe.gui_manager.ViewApp.OnPreInit"> 3237 <tt class="descname">OnPreInit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.OnPreInit" title="Permalink to this definition">¶</a></dt> 3238 <dd><p>Things that must be done after _BootstrapApp has done its 3239 thing, but would be nice if they were already done by the time 3240 that OnInit is called.</p> 3241 </dd></dl> 3242 3243 <dl class="method"> 3244 <dt id="sans.guiframe.gui_manager.ViewApp.Pending"> 3245 <tt class="descname">Pending</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Pending" title="Permalink to this definition">¶</a></dt> 3246 <dd><p>Returns True if there are unprocessed events in the event queue.</p> 3247 </dd></dl> 3248 3249 <dl class="attribute"> 3250 <dt id="sans.guiframe.gui_manager.ViewApp.PreviousHandler"> 3251 <tt class="descname">PreviousHandler</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.PreviousHandler" title="Permalink to this definition">¶</a></dt> 3252 <dd><p>See <cite>GetPreviousHandler</cite> and <cite>SetPreviousHandler</cite></p> 3253 </dd></dl> 3254 3255 <dl class="attribute"> 3256 <dt id="sans.guiframe.gui_manager.ViewApp.PrintMode"> 3257 <tt class="descname">PrintMode</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.PrintMode" title="Permalink to this definition">¶</a></dt> 3258 <dd><p>See <cite>GetPrintMode</cite> and <cite>SetPrintMode</cite></p> 3259 </dd></dl> 3260 3261 <dl class="method"> 3262 <dt id="sans.guiframe.gui_manager.ViewApp.ProcessEvent"> 3263 <tt class="descname">ProcessEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.ProcessEvent" title="Permalink to this definition">¶</a></dt> 3264 <dd></dd></dl> 3265 3266 <dl class="method"> 3267 <dt id="sans.guiframe.gui_manager.ViewApp.ProcessIdle"> 3268 <tt class="descname">ProcessIdle</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.ProcessIdle" title="Permalink to this definition">¶</a></dt> 3269 <dd><p>Called from the MainLoop when the application becomes idle (there are 3270 no pending events) and sends a <cite>wx.IdleEvent</cite> to all interested 3271 parties. Returns True if more idle events are needed, False if not.</p> 3272 </dd></dl> 3273 3274 <dl class="method"> 3275 <dt id="sans.guiframe.gui_manager.ViewApp.ProcessPendingEvents"> 3276 <tt class="descname">ProcessPendingEvents</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.ProcessPendingEvents" title="Permalink to this definition">¶</a></dt> 3277 <dd><p>Process all events in the Pending Events list – it is necessary to 3278 call this function to process posted events. This normally happens 3279 during each event loop iteration.</p> 3280 </dd></dl> 3281 3282 <dl class="method"> 3283 <dt id="sans.guiframe.gui_manager.ViewApp.RedirectStdio"> 3284 <tt class="descname">RedirectStdio</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.RedirectStdio" title="Permalink to this definition">¶</a></dt> 3285 <dd><p>Redirect sys.stdout and sys.stderr to a file or a popup window.</p> 3286 </dd></dl> 3287 3288 <dl class="method"> 3289 <dt id="sans.guiframe.gui_manager.ViewApp.RestoreStdio"> 3290 <tt class="descname">RestoreStdio</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.RestoreStdio" title="Permalink to this definition">¶</a></dt> 3291 <dd></dd></dl> 3292 3293 <dl class="method"> 3294 <dt id="sans.guiframe.gui_manager.ViewApp.SendIdleEvents"> 3295 <tt class="descname">SendIdleEvents</tt><big>(</big><em>self</em>, <em>Window win</em>, <em>IdleEvent event</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SendIdleEvents" title="Permalink to this definition">¶</a></dt> 3296 <dd><p>Send idle event to window and all subwindows. Returns True if more 3297 idle time is requested.</p> 3298 </dd></dl> 3299 3300 <dl class="method"> 3301 <dt id="sans.guiframe.gui_manager.ViewApp.SetAppName"> 3302 <tt class="descname">SetAppName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetAppName" title="Permalink to this definition">¶</a></dt> 3303 <dd><p>Set the application name. This value may be used automatically by 3304 <cite>wx.Config</cite> and such.</p> 3305 </dd></dl> 3306 3307 <dl class="method"> 3308 <dt id="sans.guiframe.gui_manager.ViewApp.SetAssertMode"> 3309 <tt class="descname">SetAssertMode</tt><big>(</big><em>self</em>, <em>int mode</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetAssertMode" title="Permalink to this definition">¶</a></dt> 3310 <dd><p>Set the OnAssert behaviour for debug and hybrid builds.</p> 3311 </dd></dl> 3312 3313 <dl class="method"> 3314 <dt id="sans.guiframe.gui_manager.ViewApp.SetCallFilterEvent"> 3315 <tt class="descname">SetCallFilterEvent</tt><big>(</big><em>self</em>, <em>bool callFilterEvent=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetCallFilterEvent" title="Permalink to this definition">¶</a></dt> 3316 <dd><p>Set the Call FilterEvent flag. When set your override of FilterEvent 3317 will be called. SetCallFilterEvent’s purpose is to avoid any 3318 performance penalty when you have overriden FilterEvent, but don’t 3319 want it to be called, and also to reduce the runtime overhead when it 3320 is not overridden.</p> 3321 </dd></dl> 3322 3323 <dl class="method"> 3324 <dt id="sans.guiframe.gui_manager.ViewApp.SetClassName"> 3325 <tt class="descname">SetClassName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetClassName" title="Permalink to this definition">¶</a></dt> 3326 <dd><p>Set the application’s class name. This value may be used for 3327 X-resources if applicable for the platform</p> 3328 </dd></dl> 3329 3330 <dl class="method"> 3331 <dt id="sans.guiframe.gui_manager.ViewApp.SetEvtHandlerEnabled"> 3332 <tt class="descname">SetEvtHandlerEnabled</tt><big>(</big><em>self</em>, <em>bool enabled</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 3333 <dd></dd></dl> 3334 3335 <dl class="method"> 3336 <dt id="sans.guiframe.gui_manager.ViewApp.SetExitOnFrameDelete"> 3337 <tt class="descname">SetExitOnFrameDelete</tt><big>(</big><em>self</em>, <em>bool flag</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetExitOnFrameDelete" title="Permalink to this definition">¶</a></dt> 3338 <dd><p>Control the exit behaviour: by default, the program will exit the main 3339 loop (and so, usually, terminate) when the last top-level program 3340 window is deleted. Beware that if you disable this behaviour (with 3341 SetExitOnFrameDelete(False)), you’ll have to call ExitMainLoop() 3342 explicitly from somewhere.</p> 3343 </dd></dl> 3344 3345 <dl class="staticmethod"> 3346 <dt id="sans.guiframe.gui_manager.ViewApp.SetMacAboutMenuItemId"> 3347 <em class="property">static </em><tt class="descname">SetMacAboutMenuItemId</tt><big>(</big><em>long val</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetMacAboutMenuItemId" title="Permalink to this definition">¶</a></dt> 3348 <dd></dd></dl> 3349 3350 <dl class="staticmethod"> 3351 <dt id="sans.guiframe.gui_manager.ViewApp.SetMacExitMenuItemId"> 3352 <em class="property">static </em><tt class="descname">SetMacExitMenuItemId</tt><big>(</big><em>long val</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetMacExitMenuItemId" title="Permalink to this definition">¶</a></dt> 3353 <dd></dd></dl> 3354 3355 <dl class="staticmethod"> 3356 <dt id="sans.guiframe.gui_manager.ViewApp.SetMacHelpMenuTitleName"> 3357 <em class="property">static </em><tt class="descname">SetMacHelpMenuTitleName</tt><big>(</big><em>String val</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetMacHelpMenuTitleName" title="Permalink to this definition">¶</a></dt> 3358 <dd></dd></dl> 3359 3360 <dl class="staticmethod"> 3361 <dt id="sans.guiframe.gui_manager.ViewApp.SetMacPreferencesMenuItemId"> 3362 <em class="property">static </em><tt class="descname">SetMacPreferencesMenuItemId</tt><big>(</big><em>long val</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetMacPreferencesMenuItemId" title="Permalink to this definition">¶</a></dt> 3363 <dd></dd></dl> 3364 3365 <dl class="staticmethod"> 3366 <dt id="sans.guiframe.gui_manager.ViewApp.SetMacSupportPCMenuShortcuts"> 3367 <em class="property">static </em><tt class="descname">SetMacSupportPCMenuShortcuts</tt><big>(</big><em>bool val</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetMacSupportPCMenuShortcuts" title="Permalink to this definition">¶</a></dt> 3368 <dd></dd></dl> 3369 3370 <dl class="method"> 3371 <dt id="sans.guiframe.gui_manager.ViewApp.SetNextHandler"> 3372 <tt class="descname">SetNextHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetNextHandler" title="Permalink to this definition">¶</a></dt> 3373 <dd></dd></dl> 3374 3375 <dl class="method"> 3376 <dt id="sans.guiframe.gui_manager.ViewApp.SetOutputWindowAttributes"> 3377 <tt class="descname">SetOutputWindowAttributes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetOutputWindowAttributes" title="Permalink to this definition">¶</a></dt> 3378 <dd><p>Set the title, position and/or size of the output window if 3379 the stdio has been redirected. This should be called before 3380 any output would cause the output window to be created.</p> 3381 </dd></dl> 3382 3383 <dl class="method"> 3384 <dt id="sans.guiframe.gui_manager.ViewApp.SetPreviousHandler"> 3385 <tt class="descname">SetPreviousHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetPreviousHandler" title="Permalink to this definition">¶</a></dt> 3386 <dd></dd></dl> 3387 3388 <dl class="method"> 3389 <dt id="sans.guiframe.gui_manager.ViewApp.SetPrintMode"> 3390 <tt class="descname">SetPrintMode</tt><big>(</big><em>self</em>, <em>int mode</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetPrintMode" title="Permalink to this definition">¶</a></dt> 3391 <dd></dd></dl> 3392 3393 <dl class="method"> 3394 <dt id="sans.guiframe.gui_manager.ViewApp.SetTopWindow"> 3395 <tt class="descname">SetTopWindow</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetTopWindow" title="Permalink to this definition">¶</a></dt> 3396 <dd><p>Set the “main” top level window</p> 3397 </dd></dl> 3398 3399 <dl class="method"> 3400 <dt id="sans.guiframe.gui_manager.ViewApp.SetUseBestVisual"> 3401 <tt class="descname">SetUseBestVisual</tt><big>(</big><em>self</em>, <em>bool flag</em>, <em>bool forceTrueColour=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetUseBestVisual" title="Permalink to this definition">¶</a></dt> 3402 <dd><p>Set whether the app should try to use the best available visual on 3403 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)</p> 3404 </dd></dl> 3405 3406 <dl class="method"> 3407 <dt id="sans.guiframe.gui_manager.ViewApp.SetVendorName"> 3408 <tt class="descname">SetVendorName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.SetVendorName" title="Permalink to this definition">¶</a></dt> 3409 <dd><p>Set the application’s vendor name. This value may be used 3410 automatically by <cite>wx.Config</cite> and such.</p> 3411 </dd></dl> 3412 3413 <dl class="attribute"> 3414 <dt id="sans.guiframe.gui_manager.ViewApp.TopWindow"> 3415 <tt class="descname">TopWindow</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.TopWindow" title="Permalink to this definition">¶</a></dt> 3416 <dd><p>See <cite>GetTopWindow</cite> and <cite>SetTopWindow</cite></p> 3417 </dd></dl> 3418 3419 <dl class="attribute"> 3420 <dt id="sans.guiframe.gui_manager.ViewApp.Traits"> 3421 <tt class="descname">Traits</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Traits" title="Permalink to this definition">¶</a></dt> 3422 <dd><p>See <cite>GetTraits</cite></p> 3423 </dd></dl> 3424 3425 <dl class="method"> 3426 <dt id="sans.guiframe.gui_manager.ViewApp.Unbind"> 3427 <tt class="descname">Unbind</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Unbind" title="Permalink to this definition">¶</a></dt> 3428 <dd><p>Disconnects the event handler binding for event from self. 3429 Returns True if successful.</p> 3430 </dd></dl> 3431 3432 <dl class="attribute"> 3433 <dt id="sans.guiframe.gui_manager.ViewApp.UseBestVisual"> 3434 <tt class="descname">UseBestVisual</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.UseBestVisual" title="Permalink to this definition">¶</a></dt> 3435 <dd><p>See <cite>GetUseBestVisual</cite> and <cite>SetUseBestVisual</cite></p> 3436 </dd></dl> 3437 3438 <dl class="attribute"> 3439 <dt id="sans.guiframe.gui_manager.ViewApp.VendorName"> 3440 <tt class="descname">VendorName</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.VendorName" title="Permalink to this definition">¶</a></dt> 3441 <dd><p>See <cite>GetVendorName</cite> and <cite>SetVendorName</cite></p> 3442 </dd></dl> 3443 3444 <dl class="method"> 3445 <dt id="sans.guiframe.gui_manager.ViewApp.WakeUpIdle"> 3446 <tt class="descname">WakeUpIdle</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.WakeUpIdle" title="Permalink to this definition">¶</a></dt> 3447 <dd><p>Make sure that idle events are sent again. 3448 :see: <cite>wx.WakeUpIdle</cite></p> 3449 </dd></dl> 3450 3451 <dl class="method"> 3452 <dt id="sans.guiframe.gui_manager.ViewApp.Yield"> 3453 <tt class="descname">Yield</tt><big>(</big><em>self</em>, <em>bool onlyIfNeeded=False</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.Yield" title="Permalink to this definition">¶</a></dt> 3454 <dd><p>Process all currently pending events right now, instead of waiting 3455 until return to the event loop. It is an error to call <tt class="docutils literal"><span class="pre">Yield</span></tt> 3456 recursively unless the value of <tt class="docutils literal"><span class="pre">onlyIfNeeded</span></tt> is True.</p> 3457 <table class="docutils field-list" frame="void" rules="none"> 3458 <col class="field-name" /> 3459 <col class="field-body" /> 3460 <tbody valign="top"> 3461 <tr class="field-odd field"><th class="field-name">Warning :</th><td class="field-body">This function is dangerous as it can lead to unexpected 3462 reentrancies (i.e. when called from an event handler it may 3463 result in calling the same event handler again), use with 3464 extreme care or, better, don’t use at all!</td> 3465 </tr> 3466 <tr class="field-even field"><th class="field-name">See :</th><td class="field-body"><cite>wx.Yield</cite>, <cite>wx.YieldIfNeeded</cite>, <cite>wx.SafeYield</cite></td> 3467 </tr> 3468 </tbody> 3469 </table> 3470 </dd></dl> 3471 3472 <dl class="method"> 3473 <dt id="sans.guiframe.gui_manager.ViewApp._BootstrapApp"> 3474 <tt class="descname">_BootstrapApp</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp._BootstrapApp" title="Permalink to this definition">¶</a></dt> 3475 <dd><p>For internal use only</p> 3476 </dd></dl> 3477 3478 <dl class="attribute"> 3479 <dt id="sans.guiframe.gui_manager.ViewApp.__class__"> 3480 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__class__" title="Permalink to this definition">¶</a></dt> 3481 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 3482 </dd></dl> 3483 3484 <dl class="method"> 3485 <dt id="sans.guiframe.gui_manager.ViewApp.__del__"> 3486 <tt class="descname">__del__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__del__" title="Permalink to this definition">¶</a></dt> 3487 <dd></dd></dl> 3488 3489 <dl class="attribute"> 3490 <dt id="sans.guiframe.gui_manager.ViewApp.__delattr__"> 3491 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__delattr__" title="Permalink to this definition">¶</a></dt> 3492 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 3493 </dd></dl> 3494 3495 <dl class="attribute"> 3496 <dt id="sans.guiframe.gui_manager.ViewApp.__dict__"> 3497 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x04DAC4B0></em><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__dict__" title="Permalink to this definition">¶</a></dt> 3498 <dd></dd></dl> 3499 3500 <dl class="attribute"> 3501 <dt id="sans.guiframe.gui_manager.ViewApp.__getattribute__"> 3502 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__getattribute__" title="Permalink to this definition">¶</a></dt> 3503 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 3504 </dd></dl> 3505 3506 <dl class="attribute"> 3507 <dt id="sans.guiframe.gui_manager.ViewApp.__hash__"> 3508 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__hash__" title="Permalink to this definition">¶</a></dt> 3509 <dd><p>x.__hash__() <==> hash(x)</p> 3510 </dd></dl> 3511 3512 <dl class="method"> 3513 <dt id="sans.guiframe.gui_manager.ViewApp.__init__"> 3514 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__init__" title="Permalink to this definition">¶</a></dt> 3515 <dd><p>Construct a <tt class="docutils literal"><span class="pre">wx.App</span></tt> object.</p> 3516 <table class="docutils field-list" frame="void" rules="none"> 3517 <col class="field-name" /> 3518 <col class="field-body" /> 3519 <tbody valign="top"> 3520 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 3521 <li><strong>redirect</strong> – Should <tt class="docutils literal"><span class="pre">sys.stdout</span></tt> and <tt class="docutils literal"><span class="pre">sys.stderr</span></tt> be 3522 redirected? Defaults to True on Windows and Mac, False 3523 otherwise. If <cite>filename</cite> is None then output will be 3524 redirected to a window that pops up as needed. (You can 3525 control what kind of window is created for the output by 3526 resetting the class variable <tt class="docutils literal"><span class="pre">outputWindowClass</span></tt> to a 3527 class of your choosing.)</li> 3528 <li><strong>filename</strong> – The name of a file to redirect output to, if 3529 redirect is True.</li> 3530 <li><strong>useBestVisual</strong> – Should the app try to use the best 3531 available visual provided by the system (only relevant on 3532 systems that have more than one visual.) This parameter 3533 must be used instead of calling <cite>SetUseBestVisual</cite> later 3534 on because it must be set before the underlying GUI 3535 toolkit is initialized.</li> 3536 <li><strong>clearSigInt</strong> – Should SIGINT be cleared? This allows the 3537 app to terminate upon a Ctrl-C in the console like other 3538 GUI apps will.</li> 3539 </ul> 3540 </td> 3541 </tr> 3542 <tr class="field-even field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">You should override OnInit to do applicaition 3543 initialization to ensure that the system, toolkit and 3544 wxWidgets are fully initialized.</p> 3545 </td> 3546 </tr> 3547 </tbody> 3548 </table> 3549 </dd></dl> 3550 3551 <dl class="attribute"> 3552 <dt id="sans.guiframe.gui_manager.ViewApp.__module__"> 3553 <tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.gui_manager'</em><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__module__" title="Permalink to this definition">¶</a></dt> 3554 <dd></dd></dl> 3555 3556 <dl class="staticmethod"> 3557 <dt id="sans.guiframe.gui_manager.ViewApp.__new__"> 3558 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__new__" title="Permalink to this definition">¶</a></dt> 3559 <dd></dd></dl> 3560 3561 <dl class="method"> 3562 <dt id="sans.guiframe.gui_manager.ViewApp.__reduce__"> 3563 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__reduce__" title="Permalink to this definition">¶</a></dt> 3564 <dd><p>helper for pickle</p> 3565 </dd></dl> 3566 3567 <dl class="method"> 3568 <dt id="sans.guiframe.gui_manager.ViewApp.__reduce_ex__"> 3569 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 3570 <dd><p>helper for pickle</p> 3571 </dd></dl> 3572 3573 <dl class="method"> 3574 <dt id="sans.guiframe.gui_manager.ViewApp.__repr__"> 3575 <tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__repr__" title="Permalink to this definition">¶</a></dt> 3576 <dd></dd></dl> 3577 3578 <dl class="attribute"> 3579 <dt id="sans.guiframe.gui_manager.ViewApp.__setattr__"> 3580 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__setattr__" title="Permalink to this definition">¶</a></dt> 3581 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 3582 </dd></dl> 3583 3584 <dl class="attribute"> 3585 <dt id="sans.guiframe.gui_manager.ViewApp.__str__"> 3586 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__str__" title="Permalink to this definition">¶</a></dt> 3587 <dd><p>x.__str__() <==> str(x)</p> 3588 </dd></dl> 3589 3590 <dl class="method"> 3591 <dt id="sans.guiframe.gui_manager.ViewApp.__swig_destroy__"> 3592 <tt class="descname">__swig_destroy__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__swig_destroy__" title="Permalink to this definition">¶</a></dt> 3593 <dd></dd></dl> 3594 3595 <dl class="attribute"> 3596 <dt id="sans.guiframe.gui_manager.ViewApp.__weakref__"> 3597 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.__weakref__" title="Permalink to this definition">¶</a></dt> 3598 <dd><p>list of weak references to the object (if defined)</p> 3599 </dd></dl> 3600 3601 <dl class="method"> 3602 <dt id="sans.guiframe.gui_manager.ViewApp._setCallbackInfo"> 3603 <tt class="descname">_setCallbackInfo</tt><big>(</big><em>self</em>, <em>PyObject self</em>, <em>PyObject _class</em>, <em>bool incref=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp._setCallbackInfo" title="Permalink to this definition">¶</a></dt> 3604 <dd></dd></dl> 3605 3606 <dl class="method"> 3607 <dt id="sans.guiframe.gui_manager.ViewApp._setOORInfo"> 3608 <tt class="descname">_setOORInfo</tt><big>(</big><em>self</em>, <em>PyObject _self</em>, <em>bool incref=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp._setOORInfo" title="Permalink to this definition">¶</a></dt> 3609 <dd></dd></dl> 3610 3611 <dl class="method"> 3612 <dt id="sans.guiframe.gui_manager.ViewApp.add_perspective"> 3613 <tt class="descname">add_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.add_perspective" title="Permalink to this definition">¶</a></dt> 3614 <dd><p>Manually add a perspective to the application GUI</p> 3615 </dd></dl> 3616 3617 <dl class="method"> 3618 <dt id="sans.guiframe.gui_manager.ViewApp.build_gui"> 3619 <tt class="descname">build_gui</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.build_gui" title="Permalink to this definition">¶</a></dt> 3620 <dd><p>Build the GUI</p> 3621 </dd></dl> 3622 3623 <dl class="method"> 3624 <dt id="sans.guiframe.gui_manager.ViewApp.display_splash_screen"> 3625 <tt class="descname">display_splash_screen</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.display_splash_screen" title="Permalink to this definition">¶</a></dt> 3626 <dd><p>Displays the splash screen. It will exactly cover the main frame.</p> 3627 </dd></dl> 3628 3629 <dl class="method"> 3630 <dt id="sans.guiframe.gui_manager.ViewApp.on_close_splash_screen"> 3631 <tt class="descname">on_close_splash_screen</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.on_close_splash_screen" title="Permalink to this definition">¶</a></dt> 3632 <dd></dd></dl> 3633 3634 <dl class="method"> 3635 <dt id="sans.guiframe.gui_manager.ViewApp.open_file"> 3636 <tt class="descname">open_file</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.open_file" title="Permalink to this definition">¶</a></dt> 3637 <dd><p>open a state file at the start of the application</p> 3638 </dd></dl> 3639 3640 <dl class="attribute"> 3641 <dt id="sans.guiframe.gui_manager.ViewApp.outputWindowClass"> 3642 <tt class="descname">outputWindowClass</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.outputWindowClass" title="Permalink to this definition">¶</a></dt> 3643 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">PyOnDemandOutputWindow</span></tt></p> 3644 </dd></dl> 3645 3646 <dl class="method"> 3647 <dt id="sans.guiframe.gui_manager.ViewApp.set_manager"> 3648 <tt class="descname">set_manager</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.set_manager" title="Permalink to this definition">¶</a></dt> 3649 <dd><p>Sets a reference to the application manager 3650 of the GUI manager (Frame)</p> 3651 </dd></dl> 3652 3653 <dl class="method"> 3654 <dt id="sans.guiframe.gui_manager.ViewApp.set_welcome_panel"> 3655 <tt class="descname">set_welcome_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.set_welcome_panel" title="Permalink to this definition">¶</a></dt> 3656 <dd><p>Set the welcome panel</p> 3657 <table class="docutils field-list" frame="void" rules="none"> 3658 <col class="field-name" /> 3659 <col class="field-body" /> 3660 <tbody valign="top"> 3661 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>panel_class</strong> – class of the welcome panel to be instantiated</td> 3662 </tr> 3663 </tbody> 3664 </table> 3665 </dd></dl> 3666 3667 <dl class="attribute"> 3668 <dt id="sans.guiframe.gui_manager.ViewApp.thisown"> 3669 <tt class="descname">thisown</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.thisown" title="Permalink to this definition">¶</a></dt> 3670 <dd><p>The membership flag</p> 3671 </dd></dl> 3672 3673 <dl class="method"> 3674 <dt id="sans.guiframe.gui_manager.ViewApp.window_placement"> 3675 <tt class="descname">window_placement</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewApp.window_placement" title="Permalink to this definition">¶</a></dt> 3676 <dd><p>Determines the position and size of the application frame such that it 3677 fits on the user’s screen without obstructing (or being obstructed by) 3678 the Windows task bar. The maximum initial size in pixels is bounded by 3679 WIDTH x HEIGHT. For most monitors, the application 3680 will be centered on the screen; for very large monitors it will be 3681 placed on the left side of the screen.</p> 3682 </dd></dl> 3683 3684 </dd></dl> 3685 3686 <dl class="class"> 3687 <dt id="sans.guiframe.gui_manager.ViewerFrame"> 3688 <em class="property">class </em><tt class="descclassname">sans.guiframe.gui_manager.</tt><tt class="descname">ViewerFrame</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame" title="Permalink to this definition">¶</a></dt> 3689 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p> 3690 <p>Main application frame</p> 3691 <dl class="attribute"> 3692 <dt id="sans.guiframe.gui_manager.ViewerFrame.AcceleratorTable"> 3693 <tt class="descname">AcceleratorTable</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.AcceleratorTable" title="Permalink to this definition">¶</a></dt> 3694 <dd><p>See <cite>GetAcceleratorTable</cite> and <cite>SetAcceleratorTable</cite></p> 3695 </dd></dl> 3696 3697 <dl class="method"> 3698 <dt id="sans.guiframe.gui_manager.ViewerFrame.AcceptsFocus"> 3699 <tt class="descname">AcceptsFocus</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.AcceptsFocus" title="Permalink to this definition">¶</a></dt> 3700 <dd><p>Can this window have focus?</p> 3701 </dd></dl> 3702 3703 <dl class="method"> 3704 <dt id="sans.guiframe.gui_manager.ViewerFrame.AcceptsFocusFromKeyboard"> 3705 <tt class="descname">AcceptsFocusFromKeyboard</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.AcceptsFocusFromKeyboard" title="Permalink to this definition">¶</a></dt> 3706 <dd><p>Can this window be given focus by keyboard navigation? if not, the 3707 only way to give it focus (provided it accepts it at all) is to click 3708 it.</p> 3709 </dd></dl> 3710 3711 <dl class="method"> 3712 <dt id="sans.guiframe.gui_manager.ViewerFrame.AddChild"> 3713 <tt class="descname">AddChild</tt><big>(</big><em>self</em>, <em>Window child</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.AddChild" title="Permalink to this definition">¶</a></dt> 3714 <dd><p>Adds a child window. This is called automatically by window creation 3715 functions so should not be required by the application programmer.</p> 3716 </dd></dl> 3717 3718 <dl class="method"> 3719 <dt id="sans.guiframe.gui_manager.ViewerFrame.AddPendingEvent"> 3720 <tt class="descname">AddPendingEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.AddPendingEvent" title="Permalink to this definition">¶</a></dt> 3721 <dd></dd></dl> 3722 3723 <dl class="method"> 3724 <dt id="sans.guiframe.gui_manager.ViewerFrame.AdjustForLayoutDirection"> 3725 <tt class="descname">AdjustForLayoutDirection</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int width</em>, <em>int widthTotal</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.AdjustForLayoutDirection" title="Permalink to this definition">¶</a></dt> 3726 <dd><p>Mirror coordinates for RTL layout if this window uses it and if the 3727 mirroring is not done automatically like Win32.</p> 3728 </dd></dl> 3729 3730 <dl class="method"> 3731 <dt id="sans.guiframe.gui_manager.ViewerFrame.AssociateHandle"> 3732 <tt class="descname">AssociateHandle</tt><big>(</big><em>self</em>, <em>long handle</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.AssociateHandle" title="Permalink to this definition">¶</a></dt> 3733 <dd><p>Associate the window with a new native handle</p> 3734 </dd></dl> 3735 3736 <dl class="attribute"> 3737 <dt id="sans.guiframe.gui_manager.ViewerFrame.AutoLayout"> 3738 <tt class="descname">AutoLayout</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.AutoLayout" title="Permalink to this definition">¶</a></dt> 3739 <dd><p>See <cite>GetAutoLayout</cite> and <cite>SetAutoLayout</cite></p> 3740 </dd></dl> 3741 3742 <dl class="attribute"> 3743 <dt id="sans.guiframe.gui_manager.ViewerFrame.BackgroundColour"> 3744 <tt class="descname">BackgroundColour</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.BackgroundColour" title="Permalink to this definition">¶</a></dt> 3745 <dd><p>See <cite>GetBackgroundColour</cite> and <cite>SetBackgroundColour</cite></p> 3746 </dd></dl> 3747 3748 <dl class="attribute"> 3749 <dt id="sans.guiframe.gui_manager.ViewerFrame.BackgroundStyle"> 3750 <tt class="descname">BackgroundStyle</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.BackgroundStyle" title="Permalink to this definition">¶</a></dt> 3751 <dd><p>See <cite>GetBackgroundStyle</cite> and <cite>SetBackgroundStyle</cite></p> 3752 </dd></dl> 3753 3754 <dl class="attribute"> 3755 <dt id="sans.guiframe.gui_manager.ViewerFrame.BestSize"> 3756 <tt class="descname">BestSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.BestSize" title="Permalink to this definition">¶</a></dt> 3757 <dd><p>See <cite>GetBestSize</cite></p> 3758 </dd></dl> 3759 3760 <dl class="attribute"> 3761 <dt id="sans.guiframe.gui_manager.ViewerFrame.BestVirtualSize"> 3762 <tt class="descname">BestVirtualSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.BestVirtualSize" title="Permalink to this definition">¶</a></dt> 3763 <dd><p>See <cite>GetBestVirtualSize</cite></p> 3764 </dd></dl> 3765 3766 <dl class="method"> 3767 <dt id="sans.guiframe.gui_manager.ViewerFrame.Bind"> 3768 <tt class="descname">Bind</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Bind" title="Permalink to this definition">¶</a></dt> 3769 <dd><p>Bind an event to an event handler.</p> 3770 <table class="docutils field-list" frame="void" rules="none"> 3771 <col class="field-name" /> 3772 <col class="field-body" /> 3773 <tbody valign="top"> 3774 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 3775 <li><strong>event</strong> – One of the EVT_* objects that specifies the 3776 type of event to bind,</li> 3777 <li><strong>handler</strong> – A callable object to be invoked when the 3778 event is delivered to self. Pass None to 3779 disconnect an event handler.</li> 3780 <li><strong>source</strong> – Sometimes the event originates from a 3781 different window than self, but you still 3782 want to catch it in self. (For example, a 3783 button event delivered to a frame.) By 3784 passing the source of the event, the event 3785 handling system is able to differentiate 3786 between the same event type from different 3787 controls.</li> 3788 <li><strong>id</strong> – Used to spcify the event source by ID instead 3789 of instance.</li> 3790 <li><strong>id2</strong> – Used when it is desirable to bind a handler 3791 to a range of IDs, such as with EVT_MENU_RANGE.</li> 3792 </ul> 3793 </td> 3794 </tr> 3795 </tbody> 3796 </table> 3797 </dd></dl> 3798 3799 <dl class="attribute"> 3800 <dt id="sans.guiframe.gui_manager.ViewerFrame.Border"> 3801 <tt class="descname">Border</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Border" title="Permalink to this definition">¶</a></dt> 3802 <dd><p>See <cite>GetBorder</cite></p> 3803 </dd></dl> 3804 3805 <dl class="method"> 3806 <dt id="sans.guiframe.gui_manager.ViewerFrame.CacheBestSize"> 3807 <tt class="descname">CacheBestSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CacheBestSize" title="Permalink to this definition">¶</a></dt> 3808 <dd><p>Cache the best size so it doesn’t need to be calculated again, (at least until 3809 some properties of the window change.)</p> 3810 </dd></dl> 3811 3812 <dl class="method"> 3813 <dt id="sans.guiframe.gui_manager.ViewerFrame.CanSetTransparent"> 3814 <tt class="descname">CanSetTransparent</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CanSetTransparent" title="Permalink to this definition">¶</a></dt> 3815 <dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the platform supports setting the transparency for 3816 this window. Note that this method will err on the side of caution, 3817 so it is possible that this will return <tt class="docutils literal"><span class="pre">False</span></tt> when it is in fact 3818 possible to set the transparency.</p> 3819 <p>NOTE: On X-windows systems the X server must have the composite 3820 extension loaded, and there must be a composite manager program (such 3821 as xcompmgr) running.</p> 3822 </dd></dl> 3823 3824 <dl class="method"> 3825 <dt id="sans.guiframe.gui_manager.ViewerFrame.CaptureMouse"> 3826 <tt class="descname">CaptureMouse</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CaptureMouse" title="Permalink to this definition">¶</a></dt> 3827 <dd><p>Directs all mouse input to this window. Call wx.Window.ReleaseMouse to 3828 release the capture.</p> 3829 <p>Note that wxWindows maintains the stack of windows having captured the 3830 mouse and when the mouse is released the capture returns to the window 3831 which had had captured it previously and it is only really released if 3832 there were no previous window. In particular, this means that you must 3833 release the mouse as many times as you capture it, unless the window 3834 receives the <cite>wx.MouseCaptureLostEvent</cite> event.</p> 3835 <p>Any application which captures the mouse in the beginning of some 3836 operation <em>must</em> handle <cite>wx.MouseCaptureLostEvent</cite> and cancel this 3837 operation when it receives the event. The event handler must not 3838 recapture mouse.</p> 3839 </dd></dl> 3840 3841 <dl class="attribute"> 3842 <dt id="sans.guiframe.gui_manager.ViewerFrame.Caret"> 3843 <tt class="descname">Caret</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Caret" title="Permalink to this definition">¶</a></dt> 3844 <dd><p>See <cite>GetCaret</cite> and <cite>SetCaret</cite></p> 3845 </dd></dl> 3846 3847 <dl class="method"> 3848 <dt id="sans.guiframe.gui_manager.ViewerFrame.Center"> 3849 <tt class="descname">Center</tt><big>(</big><em>self</em>, <em>int direction=BOTH</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Center" title="Permalink to this definition">¶</a></dt> 3850 <dd><p>Centers the window. The parameter specifies the direction for 3851 centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 3852 also include wx.CENTER_ON_SCREEN flag if you want to center the window 3853 on the entire screen and not on its parent window. If it is a 3854 top-level window and has no parent then it will always be centered 3855 relative to the screen.</p> 3856 </dd></dl> 3857 3858 <dl class="method"> 3859 <dt id="sans.guiframe.gui_manager.ViewerFrame.CenterOnParent"> 3860 <tt class="descname">CenterOnParent</tt><big>(</big><em>self</em>, <em>int dir=BOTH</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CenterOnParent" title="Permalink to this definition">¶</a></dt> 3861 <dd><p>Center with respect to the the parent window</p> 3862 </dd></dl> 3863 3864 <dl class="method"> 3865 <dt id="sans.guiframe.gui_manager.ViewerFrame.CenterOnScreen"> 3866 <tt class="descname">CenterOnScreen</tt><big>(</big><em>self</em>, <em>int dir=BOTH</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CenterOnScreen" title="Permalink to this definition">¶</a></dt> 3867 <dd><p>Center the window on screen</p> 3868 </dd></dl> 3869 3870 <dl class="method"> 3871 <dt id="sans.guiframe.gui_manager.ViewerFrame.Centre"> 3872 <tt class="descname">Centre</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Centre" title="Permalink to this definition">¶</a></dt> 3873 <dd><p>Center(self, int direction=BOTH)</p> 3874 <p>Centers the window. The parameter specifies the direction for 3875 centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may 3876 also include wx.CENTER_ON_SCREEN flag if you want to center the window 3877 on the entire screen and not on its parent window. If it is a 3878 top-level window and has no parent then it will always be centered 3879 relative to the screen.</p> 3880 </dd></dl> 3881 3882 <dl class="method"> 3883 <dt id="sans.guiframe.gui_manager.ViewerFrame.CentreOnParent"> 3884 <tt class="descname">CentreOnParent</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CentreOnParent" title="Permalink to this definition">¶</a></dt> 3885 <dd><p>CenterOnParent(self, int dir=BOTH)</p> 3886 <p>Center with respect to the the parent window</p> 3887 </dd></dl> 3888 3889 <dl class="method"> 3890 <dt id="sans.guiframe.gui_manager.ViewerFrame.CentreOnScreen"> 3891 <tt class="descname">CentreOnScreen</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CentreOnScreen" title="Permalink to this definition">¶</a></dt> 3892 <dd><p>CenterOnScreen(self, int dir=BOTH)</p> 3893 <p>Center the window on screen</p> 3894 </dd></dl> 3895 3896 <dl class="attribute"> 3897 <dt id="sans.guiframe.gui_manager.ViewerFrame.CharHeight"> 3898 <tt class="descname">CharHeight</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CharHeight" title="Permalink to this definition">¶</a></dt> 3899 <dd><p>See <cite>GetCharHeight</cite></p> 3900 </dd></dl> 3901 3902 <dl class="attribute"> 3903 <dt id="sans.guiframe.gui_manager.ViewerFrame.CharWidth"> 3904 <tt class="descname">CharWidth</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CharWidth" title="Permalink to this definition">¶</a></dt> 3905 <dd><p>See <cite>GetCharWidth</cite></p> 3906 </dd></dl> 3907 3908 <dl class="attribute"> 3909 <dt id="sans.guiframe.gui_manager.ViewerFrame.Children"> 3910 <tt class="descname">Children</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Children" title="Permalink to this definition">¶</a></dt> 3911 <dd><p>See <cite>GetChildren</cite></p> 3912 </dd></dl> 3913 3914 <dl class="attribute"> 3915 <dt id="sans.guiframe.gui_manager.ViewerFrame.ClassName"> 3916 <tt class="descname">ClassName</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ClassName" title="Permalink to this definition">¶</a></dt> 3917 <dd><p>See <cite>GetClassName</cite></p> 3918 </dd></dl> 3919 3920 <dl class="method"> 3921 <dt id="sans.guiframe.gui_manager.ViewerFrame.ClearBackground"> 3922 <tt class="descname">ClearBackground</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ClearBackground" title="Permalink to this definition">¶</a></dt> 3923 <dd><p>Clears the window by filling it with the current background 3924 colour. Does not cause an erase background event to be generated.</p> 3925 </dd></dl> 3926 3927 <dl class="attribute"> 3928 <dt id="sans.guiframe.gui_manager.ViewerFrame.ClientAreaOrigin"> 3929 <tt class="descname">ClientAreaOrigin</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ClientAreaOrigin" title="Permalink to this definition">¶</a></dt> 3930 <dd><p>See <cite>GetClientAreaOrigin</cite></p> 3931 </dd></dl> 3932 3933 <dl class="attribute"> 3934 <dt id="sans.guiframe.gui_manager.ViewerFrame.ClientRect"> 3935 <tt class="descname">ClientRect</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ClientRect" title="Permalink to this definition">¶</a></dt> 3936 <dd><p>See <cite>GetClientRect</cite> and <cite>SetClientRect</cite></p> 3937 </dd></dl> 3938 3939 <dl class="attribute"> 3940 <dt id="sans.guiframe.gui_manager.ViewerFrame.ClientSize"> 3941 <tt class="descname">ClientSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ClientSize" title="Permalink to this definition">¶</a></dt> 3942 <dd><p>See <cite>GetClientSize</cite> and <cite>SetClientSize</cite></p> 3943 </dd></dl> 3944 3945 <dl class="method"> 3946 <dt id="sans.guiframe.gui_manager.ViewerFrame.ClientToScreen"> 3947 <tt class="descname">ClientToScreen</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ClientToScreen" title="Permalink to this definition">¶</a></dt> 3948 <dd><p>Converts to screen coordinates from coordinates relative to this window.</p> 3949 </dd></dl> 3950 3951 <dl class="method"> 3952 <dt id="sans.guiframe.gui_manager.ViewerFrame.ClientToScreenXY"> 3953 <tt class="descname">ClientToScreenXY</tt><big>(</big><em>int x</em>, <em>int y) -> (x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ClientToScreenXY" title="Permalink to this definition">¶</a></dt> 3954 <dd><p>Converts to screen coordinates from coordinates relative to this window.</p> 3955 </dd></dl> 3956 3957 <dl class="method"> 3958 <dt id="sans.guiframe.gui_manager.ViewerFrame.ClientToWindowSize"> 3959 <tt class="descname">ClientToWindowSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ClientToWindowSize" title="Permalink to this definition">¶</a></dt> 3960 <dd></dd></dl> 3961 3962 <dl class="method"> 3963 <dt id="sans.guiframe.gui_manager.ViewerFrame.Close"> 3964 <tt class="descname">Close</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Close" title="Permalink to this definition">¶</a></dt> 3965 <dd><p>Quit the application</p> 3966 </dd></dl> 3967 3968 <dl class="method"> 3969 <dt id="sans.guiframe.gui_manager.ViewerFrame.Command"> 3970 <tt class="descname">Command</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Command" title="Permalink to this definition">¶</a></dt> 3971 <dd><p>ProcessCommand(self, int winid) -> bool</p> 3972 </dd></dl> 3973 3974 <dl class="method"> 3975 <dt id="sans.guiframe.gui_manager.ViewerFrame.Connect"> 3976 <tt class="descname">Connect</tt><big>(</big><em>self</em>, <em>int id</em>, <em>int lastId</em>, <em>int eventType</em>, <em>PyObject func</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Connect" title="Permalink to this definition">¶</a></dt> 3977 <dd></dd></dl> 3978 3979 <dl class="attribute"> 3980 <dt id="sans.guiframe.gui_manager.ViewerFrame.Constraints"> 3981 <tt class="descname">Constraints</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Constraints" title="Permalink to this definition">¶</a></dt> 3982 <dd><p>See <cite>GetConstraints</cite> and <cite>SetConstraints</cite></p> 3983 </dd></dl> 3984 3985 <dl class="attribute"> 3986 <dt id="sans.guiframe.gui_manager.ViewerFrame.ContainingSizer"> 3987 <tt class="descname">ContainingSizer</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ContainingSizer" title="Permalink to this definition">¶</a></dt> 3988 <dd><p>See <cite>GetContainingSizer</cite> and <cite>SetContainingSizer</cite></p> 3989 </dd></dl> 3990 3991 <dl class="method"> 3992 <dt id="sans.guiframe.gui_manager.ViewerFrame.ConvertDialogPointToPixels"> 3993 <tt class="descname">ConvertDialogPointToPixels</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ConvertDialogPointToPixels" title="Permalink to this definition">¶</a></dt> 3994 <dd><p>Converts a point or size from dialog units to pixels. Dialog units 3995 are used for maintaining a dialog’s proportions even if the font 3996 changes. For the x dimension, the dialog units are multiplied by the 3997 average character width and then divided by 4. For the y dimension, 3998 the dialog units are multiplied by the average character height and 3999 then divided by 8.</p> 4000 </dd></dl> 4001 4002 <dl class="method"> 4003 <dt id="sans.guiframe.gui_manager.ViewerFrame.ConvertDialogSizeToPixels"> 4004 <tt class="descname">ConvertDialogSizeToPixels</tt><big>(</big><em>self</em>, <em>Size sz</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ConvertDialogSizeToPixels" title="Permalink to this definition">¶</a></dt> 4005 <dd><p>Converts a point or size from dialog units to pixels. Dialog units 4006 are used for maintaining a dialog’s proportions even if the font 4007 changes. For the x dimension, the dialog units are multiplied by the 4008 average character width and then divided by 4. For the y dimension, 4009 the dialog units are multiplied by the average character height and 4010 then divided by 8.</p> 4011 </dd></dl> 4012 4013 <dl class="method"> 4014 <dt id="sans.guiframe.gui_manager.ViewerFrame.ConvertPixelPointToDialog"> 4015 <tt class="descname">ConvertPixelPointToDialog</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ConvertPixelPointToDialog" title="Permalink to this definition">¶</a></dt> 4016 <dd></dd></dl> 4017 4018 <dl class="method"> 4019 <dt id="sans.guiframe.gui_manager.ViewerFrame.ConvertPixelSizeToDialog"> 4020 <tt class="descname">ConvertPixelSizeToDialog</tt><big>(</big><em>self</em>, <em>Size sz</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ConvertPixelSizeToDialog" title="Permalink to this definition">¶</a></dt> 4021 <dd></dd></dl> 4022 4023 <dl class="method"> 4024 <dt id="sans.guiframe.gui_manager.ViewerFrame.Create"> 4025 <tt class="descname">Create</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Create" title="Permalink to this definition">¶</a></dt> 4026 <dd><p>Create(self, Window parent, int id=-1, String title=EmptyString, 4027 Point pos=DefaultPosition, Size size=DefaultSize, 4028 long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> bool</p> 4029 </dd></dl> 4030 4031 <dl class="method"> 4032 <dt id="sans.guiframe.gui_manager.ViewerFrame.CreateStatusBar"> 4033 <tt class="descname">CreateStatusBar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CreateStatusBar" title="Permalink to this definition">¶</a></dt> 4034 <dd><p>CreateStatusBar(self, int number=1, long style=DEFAULT_STATUSBAR_STYLE, int winid=0, 4035 String name=StatusLineNameStr) -> StatusBar</p> 4036 </dd></dl> 4037 4038 <dl class="method"> 4039 <dt id="sans.guiframe.gui_manager.ViewerFrame.CreateToolBar"> 4040 <tt class="descname">CreateToolBar</tt><big>(</big><em>self</em>, <em>long style=-1</em>, <em>int winid=-1</em>, <em>String name=ToolBarNameStr</em><big>)</big> → wxToolBar<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.CreateToolBar" title="Permalink to this definition">¶</a></dt> 4041 <dd></dd></dl> 4042 4043 <dl class="attribute"> 4044 <dt id="sans.guiframe.gui_manager.ViewerFrame.Cursor"> 4045 <tt class="descname">Cursor</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Cursor" title="Permalink to this definition">¶</a></dt> 4046 <dd><p>See <cite>GetCursor</cite> and <cite>SetCursor</cite></p> 4047 </dd></dl> 4048 4049 <dl class="method"> 4050 <dt id="sans.guiframe.gui_manager.ViewerFrame.DLG_PNT"> 4051 <tt class="descname">DLG_PNT</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DLG_PNT" title="Permalink to this definition">¶</a></dt> 4052 <dd><p>Converts a point or size from dialog units to pixels. Dialog units 4053 are used for maintaining a dialog’s proportions even if the font 4054 changes. For the x dimension, the dialog units are multiplied by the 4055 average character width and then divided by 4. For the y dimension, 4056 the dialog units are multiplied by the average character height and 4057 then divided by 8.</p> 4058 </dd></dl> 4059 4060 <dl class="method"> 4061 <dt id="sans.guiframe.gui_manager.ViewerFrame.DLG_SZE"> 4062 <tt class="descname">DLG_SZE</tt><big>(</big><em>self</em>, <em>Size sz</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DLG_SZE" title="Permalink to this definition">¶</a></dt> 4063 <dd><p>Converts a point or size from dialog units to pixels. Dialog units 4064 are used for maintaining a dialog’s proportions even if the font 4065 changes. For the x dimension, the dialog units are multiplied by the 4066 average character width and then divided by 4. For the y dimension, 4067 the dialog units are multiplied by the average character height and 4068 then divided by 8.</p> 4069 </dd></dl> 4070 4071 <dl class="attribute"> 4072 <dt id="sans.guiframe.gui_manager.ViewerFrame.DefaultAttributes"> 4073 <tt class="descname">DefaultAttributes</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DefaultAttributes" title="Permalink to this definition">¶</a></dt> 4074 <dd><p>See <cite>GetDefaultAttributes</cite></p> 4075 </dd></dl> 4076 4077 <dl class="attribute"> 4078 <dt id="sans.guiframe.gui_manager.ViewerFrame.DefaultItem"> 4079 <tt class="descname">DefaultItem</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DefaultItem" title="Permalink to this definition">¶</a></dt> 4080 <dd><p>See <cite>GetDefaultItem</cite> and <cite>SetDefaultItem</cite></p> 4081 </dd></dl> 4082 4083 <dl class="method"> 4084 <dt id="sans.guiframe.gui_manager.ViewerFrame.Destroy"> 4085 <tt class="descname">Destroy</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Destroy" title="Permalink to this definition">¶</a></dt> 4086 <dd><p>Destroys the window safely. Frames and dialogs are not destroyed 4087 immediately when this function is called – they are added to a list 4088 of windows to be deleted on idle time, when all the window’s events 4089 have been processed. This prevents problems with events being sent to 4090 non-existent windows.</p> 4091 <p>Returns True if the window has either been successfully deleted, or it 4092 has been added to the list of windows pending real deletion.</p> 4093 </dd></dl> 4094 4095 <dl class="method"> 4096 <dt id="sans.guiframe.gui_manager.ViewerFrame.DestroyChildren"> 4097 <tt class="descname">DestroyChildren</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DestroyChildren" title="Permalink to this definition">¶</a></dt> 4098 <dd><p>Destroys all children of a window. Called automatically by the 4099 destructor.</p> 4100 </dd></dl> 4101 4102 <dl class="method"> 4103 <dt id="sans.guiframe.gui_manager.ViewerFrame.Disable"> 4104 <tt class="descname">Disable</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Disable" title="Permalink to this definition">¶</a></dt> 4105 <dd><p>Disables the window, same as Enable(false).</p> 4106 </dd></dl> 4107 4108 <dl class="method"> 4109 <dt id="sans.guiframe.gui_manager.ViewerFrame.Disconnect"> 4110 <tt class="descname">Disconnect</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Disconnect" title="Permalink to this definition">¶</a></dt> 4111 <dd><p>Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, 4112 PyObject func=None) -> bool</p> 4113 </dd></dl> 4114 4115 <dl class="method"> 4116 <dt id="sans.guiframe.gui_manager.ViewerFrame.DissociateHandle"> 4117 <tt class="descname">DissociateHandle</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DissociateHandle" title="Permalink to this definition">¶</a></dt> 4118 <dd><p>Dissociate the current native handle from the window</p> 4119 </dd></dl> 4120 4121 <dl class="method"> 4122 <dt id="sans.guiframe.gui_manager.ViewerFrame.DoGiveHelp"> 4123 <tt class="descname">DoGiveHelp</tt><big>(</big><em>self</em>, <em>String text</em>, <em>bool show</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DoGiveHelp" title="Permalink to this definition">¶</a></dt> 4124 <dd></dd></dl> 4125 4126 <dl class="method"> 4127 <dt id="sans.guiframe.gui_manager.ViewerFrame.DoMenuUpdates"> 4128 <tt class="descname">DoMenuUpdates</tt><big>(</big><em>self</em>, <em>Menu menu=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DoMenuUpdates" title="Permalink to this definition">¶</a></dt> 4129 <dd></dd></dl> 4130 4131 <dl class="method"> 4132 <dt id="sans.guiframe.gui_manager.ViewerFrame.DragAcceptFiles"> 4133 <tt class="descname">DragAcceptFiles</tt><big>(</big><em>self</em>, <em>bool accept</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DragAcceptFiles" title="Permalink to this definition">¶</a></dt> 4134 <dd><p>Enables or disables eligibility for drop file events, EVT_DROP_FILES.</p> 4135 </dd></dl> 4136 4137 <dl class="attribute"> 4138 <dt id="sans.guiframe.gui_manager.ViewerFrame.DropTarget"> 4139 <tt class="descname">DropTarget</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.DropTarget" title="Permalink to this definition">¶</a></dt> 4140 <dd><p>See <cite>GetDropTarget</cite> and <cite>SetDropTarget</cite></p> 4141 </dd></dl> 4142 4143 <dl class="attribute"> 4144 <dt id="sans.guiframe.gui_manager.ViewerFrame.EffectiveMinSize"> 4145 <tt class="descname">EffectiveMinSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.EffectiveMinSize" title="Permalink to this definition">¶</a></dt> 4146 <dd><p>See <cite>GetEffectiveMinSize</cite></p> 4147 </dd></dl> 4148 4149 <dl class="method"> 4150 <dt id="sans.guiframe.gui_manager.ViewerFrame.Enable"> 4151 <tt class="descname">Enable</tt><big>(</big><em>self</em>, <em>bool enable=True</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Enable" title="Permalink to this definition">¶</a></dt> 4152 <dd><p>Enable or disable the window for user input. Note that when a parent 4153 window is disabled, all of its children are disabled as well and they 4154 are reenabled again when the parent is. Returns true if the window 4155 has been enabled or disabled, false if nothing was done, i.e. if the 4156 window had already been in the specified state.</p> 4157 </dd></dl> 4158 4159 <dl class="method"> 4160 <dt id="sans.guiframe.gui_manager.ViewerFrame.EnableCloseButton"> 4161 <tt class="descname">EnableCloseButton</tt><big>(</big><em>self</em>, <em>bool enable</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.EnableCloseButton" title="Permalink to this definition">¶</a></dt> 4162 <dd></dd></dl> 4163 4164 <dl class="attribute"> 4165 <dt id="sans.guiframe.gui_manager.ViewerFrame.Enabled"> 4166 <tt class="descname">Enabled</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Enabled" title="Permalink to this definition">¶</a></dt> 4167 <dd><p>See <cite>IsEnabled</cite> and <cite>Enable</cite></p> 4168 </dd></dl> 4169 4170 <dl class="attribute"> 4171 <dt id="sans.guiframe.gui_manager.ViewerFrame.EventHandler"> 4172 <tt class="descname">EventHandler</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.EventHandler" title="Permalink to this definition">¶</a></dt> 4173 <dd><p>See <cite>GetEventHandler</cite> and <cite>SetEventHandler</cite></p> 4174 </dd></dl> 4175 4176 <dl class="attribute"> 4177 <dt id="sans.guiframe.gui_manager.ViewerFrame.EvtHandlerEnabled"> 4178 <tt class="descname">EvtHandlerEnabled</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.EvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 4179 <dd><p>See <cite>GetEvtHandlerEnabled</cite> and <cite>SetEvtHandlerEnabled</cite></p> 4180 </dd></dl> 4181 4182 <dl class="attribute"> 4183 <dt id="sans.guiframe.gui_manager.ViewerFrame.ExtraStyle"> 4184 <tt class="descname">ExtraStyle</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ExtraStyle" title="Permalink to this definition">¶</a></dt> 4185 <dd><p>See <cite>GetExtraStyle</cite> and <cite>SetExtraStyle</cite></p> 4186 </dd></dl> 4187 4188 <dl class="staticmethod"> 4189 <dt id="sans.guiframe.gui_manager.ViewerFrame.FindFocus"> 4190 <em class="property">static </em><tt class="descname">FindFocus</tt><big>(</big><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.FindFocus" title="Permalink to this definition">¶</a></dt> 4191 <dd><p>Returns the window or control that currently has the keyboard focus, 4192 or None.</p> 4193 </dd></dl> 4194 4195 <dl class="method"> 4196 <dt id="sans.guiframe.gui_manager.ViewerFrame.FindWindowById"> 4197 <tt class="descname">FindWindowById</tt><big>(</big><em>self</em>, <em>long winid</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.FindWindowById" title="Permalink to this definition">¶</a></dt> 4198 <dd><p>Find a child of this window by window ID</p> 4199 </dd></dl> 4200 4201 <dl class="method"> 4202 <dt id="sans.guiframe.gui_manager.ViewerFrame.FindWindowByLabel"> 4203 <tt class="descname">FindWindowByLabel</tt><big>(</big><em>self</em>, <em>String label</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.FindWindowByLabel" title="Permalink to this definition">¶</a></dt> 4204 <dd><p>Find a child of this window by label</p> 4205 </dd></dl> 4206 4207 <dl class="method"> 4208 <dt id="sans.guiframe.gui_manager.ViewerFrame.FindWindowByName"> 4209 <tt class="descname">FindWindowByName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.FindWindowByName" title="Permalink to this definition">¶</a></dt> 4210 <dd><p>Find a child of this window by name</p> 4211 </dd></dl> 4212 4213 <dl class="method"> 4214 <dt id="sans.guiframe.gui_manager.ViewerFrame.Fit"> 4215 <tt class="descname">Fit</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Fit" title="Permalink to this definition">¶</a></dt> 4216 <dd><p>Sizes the window so that it fits around its subwindows. This function 4217 won’t do anything if there are no subwindows and will only really work 4218 correctly if sizers are used for the subwindows layout. Also, if the 4219 window has exactly one subwindow it is better (faster and the result 4220 is more precise as Fit adds some margin to account for fuzziness of 4221 its calculations) to call window.SetClientSize(child.GetSize()) 4222 instead of calling Fit.</p> 4223 </dd></dl> 4224 4225 <dl class="method"> 4226 <dt id="sans.guiframe.gui_manager.ViewerFrame.FitInside"> 4227 <tt class="descname">FitInside</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.FitInside" title="Permalink to this definition">¶</a></dt> 4228 <dd><p>Similar to Fit, but sizes the interior (virtual) size of a 4229 window. Mainly useful with scrolled windows to reset scrollbars after 4230 sizing changes that do not trigger a size event, and/or scrolled 4231 windows without an interior sizer. This function similarly won’t do 4232 anything if there are no subwindows.</p> 4233 </dd></dl> 4234 4235 <dl class="attribute"> 4236 <dt id="sans.guiframe.gui_manager.ViewerFrame.Font"> 4237 <tt class="descname">Font</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Font" title="Permalink to this definition">¶</a></dt> 4238 <dd><p>See <cite>GetFont</cite> and <cite>SetFont</cite></p> 4239 </dd></dl> 4240 4241 <dl class="attribute"> 4242 <dt id="sans.guiframe.gui_manager.ViewerFrame.ForegroundColour"> 4243 <tt class="descname">ForegroundColour</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ForegroundColour" title="Permalink to this definition">¶</a></dt> 4244 <dd><p>See <cite>GetForegroundColour</cite> and <cite>SetForegroundColour</cite></p> 4245 </dd></dl> 4246 4247 <dl class="method"> 4248 <dt id="sans.guiframe.gui_manager.ViewerFrame.Freeze"> 4249 <tt class="descname">Freeze</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Freeze" title="Permalink to this definition">¶</a></dt> 4250 <dd><p>Freezes the window or, in other words, prevents any updates from 4251 taking place on screen, the window is not redrawn at all. Thaw must be 4252 called to reenable window redrawing. Calls to Freeze/Thaw may be 4253 nested, with the actual Thaw being delayed until all the nesting has 4254 been undone.</p> 4255 <p>This method is useful for visual appearance optimization (for example, 4256 it is a good idea to use it before inserting large amount of text into 4257 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor 4258 for all controls so it is mostly just a hint to wxWindows and not a 4259 mandatory directive.</p> 4260 </dd></dl> 4261 4262 <dl class="method"> 4263 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetAcceleratorTable"> 4264 <tt class="descname">GetAcceleratorTable</tt><big>(</big><em>self</em><big>)</big> → AcceleratorTable<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetAcceleratorTable" title="Permalink to this definition">¶</a></dt> 4265 <dd><p>Gets the accelerator table for this window.</p> 4266 </dd></dl> 4267 4268 <dl class="method"> 4269 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetAdjustedBestSize"> 4270 <tt class="descname">GetAdjustedBestSize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetAdjustedBestSize" title="Permalink to this definition">¶</a></dt> 4271 <dd><p>Use <cite>GetEffectiveMinSize</cite> instead.</p> 4272 </dd></dl> 4273 4274 <dl class="method"> 4275 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetAutoLayout"> 4276 <tt class="descname">GetAutoLayout</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetAutoLayout" title="Permalink to this definition">¶</a></dt> 4277 <dd><p>Returns the current autoLayout setting</p> 4278 </dd></dl> 4279 4280 <dl class="method"> 4281 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetBackgroundColour"> 4282 <tt class="descname">GetBackgroundColour</tt><big>(</big><em>self</em><big>)</big> → Colour<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetBackgroundColour" title="Permalink to this definition">¶</a></dt> 4283 <dd><p>Returns the background colour of the window.</p> 4284 </dd></dl> 4285 4286 <dl class="method"> 4287 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetBackgroundStyle"> 4288 <tt class="descname">GetBackgroundStyle</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetBackgroundStyle" title="Permalink to this definition">¶</a></dt> 4289 <dd><p>Returns the background style of the window.</p> 4290 <table class="docutils field-list" frame="void" rules="none"> 4291 <col class="field-name" /> 4292 <col class="field-body" /> 4293 <tbody valign="top"> 4294 <tr class="field-odd field"><th class="field-name">See :</th><td class="field-body"><cite>SetBackgroundStyle</cite></td> 4295 </tr> 4296 </tbody> 4297 </table> 4298 </dd></dl> 4299 4300 <dl class="method"> 4301 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetBestFittingSize"> 4302 <tt class="descname">GetBestFittingSize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetBestFittingSize" title="Permalink to this definition">¶</a></dt> 4303 <dd><p>Use <cite>GetEffectiveMinSize</cite> instead.</p> 4304 </dd></dl> 4305 4306 <dl class="method"> 4307 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetBestSize"> 4308 <tt class="descname">GetBestSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetBestSize" title="Permalink to this definition">¶</a></dt> 4309 <dd><p>This function returns the best acceptable minimal size for the 4310 window, if applicable. For example, for a static text control, it will 4311 be the minimal size such that the control label is not truncated. For 4312 windows containing subwindows (such as wx.Panel), the size returned by 4313 this function will be the same as the size the window would have had 4314 after calling Fit.</p> 4315 </dd></dl> 4316 4317 <dl class="method"> 4318 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetBestSizeTuple"> 4319 <tt class="descname">GetBestSizeTuple</tt><big>(</big><em>) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetBestSizeTuple" title="Permalink to this definition">¶</a></dt> 4320 <dd><p>This function returns the best acceptable minimal size for the 4321 window, if applicable. For example, for a static text control, it will 4322 be the minimal size such that the control label is not truncated. For 4323 windows containing subwindows (such as wx.Panel), the size returned by 4324 this function will be the same as the size the window would have had 4325 after calling Fit.</p> 4326 </dd></dl> 4327 4328 <dl class="method"> 4329 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetBestVirtualSize"> 4330 <tt class="descname">GetBestVirtualSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetBestVirtualSize" title="Permalink to this definition">¶</a></dt> 4331 <dd><p>Return the largest of ClientSize and BestSize (as determined by a 4332 sizer, interior children, or other means)</p> 4333 </dd></dl> 4334 4335 <dl class="method"> 4336 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetBorder"> 4337 <tt class="descname">GetBorder</tt><big>(</big><em>self</em>, <em>long flags</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetBorder" title="Permalink to this definition">¶</a></dt> 4338 <dd><p>GetBorder(self) -> int</p> 4339 <p>Get border for the flags of this window</p> 4340 </dd></dl> 4341 4342 <dl class="staticmethod"> 4343 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetCapture"> 4344 <em class="property">static </em><tt class="descname">GetCapture</tt><big>(</big><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetCapture" title="Permalink to this definition">¶</a></dt> 4345 <dd><p>Returns the window which currently captures the mouse or None</p> 4346 </dd></dl> 4347 4348 <dl class="method"> 4349 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetCaret"> 4350 <tt class="descname">GetCaret</tt><big>(</big><em>self</em><big>)</big> → Caret<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetCaret" title="Permalink to this definition">¶</a></dt> 4351 <dd><p>Returns the caret associated with the window.</p> 4352 </dd></dl> 4353 4354 <dl class="method"> 4355 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetCharHeight"> 4356 <tt class="descname">GetCharHeight</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetCharHeight" title="Permalink to this definition">¶</a></dt> 4357 <dd><p>Get the (average) character size for the current font.</p> 4358 </dd></dl> 4359 4360 <dl class="method"> 4361 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetCharWidth"> 4362 <tt class="descname">GetCharWidth</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetCharWidth" title="Permalink to this definition">¶</a></dt> 4363 <dd><p>Get the (average) character size for the current font.</p> 4364 </dd></dl> 4365 4366 <dl class="method"> 4367 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetChildren"> 4368 <tt class="descname">GetChildren</tt><big>(</big><em>self</em><big>)</big> → WindowList<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetChildren" title="Permalink to this definition">¶</a></dt> 4369 <dd><p>Returns an object containing a list of the window’s children. The 4370 object provides a Python sequence-like interface over the internal 4371 list maintained by the window..</p> 4372 </dd></dl> 4373 4374 <dl class="staticmethod"> 4375 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetClassDefaultAttributes"> 4376 <em class="property">static </em><tt class="descname">GetClassDefaultAttributes</tt><big>(</big><em>int variant=WINDOW_VARIANT_NORMAL</em><big>)</big> → VisualAttributes<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetClassDefaultAttributes" title="Permalink to this definition">¶</a></dt> 4377 <dd><p>Get the default attributes for this class. This is useful if you want 4378 to use the same font or colour in your own control as in a standard 4379 control – which is a much better idea than hard coding specific 4380 colours or fonts which might look completely out of place on the 4381 user’s system, especially if it uses themes.</p> 4382 <p>The variant parameter is only relevant under Mac currently and is 4383 ignore under other platforms. Under Mac, it will change the size of 4384 the returned font. See <cite>wx.Window.SetWindowVariant</cite> for more about 4385 this.</p> 4386 </dd></dl> 4387 4388 <dl class="method"> 4389 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetClassName"> 4390 <tt class="descname">GetClassName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetClassName" title="Permalink to this definition">¶</a></dt> 4391 <dd><p>Returns the class name of the C++ class using wxRTTI.</p> 4392 </dd></dl> 4393 4394 <dl class="method"> 4395 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetClientAreaOrigin"> 4396 <tt class="descname">GetClientAreaOrigin</tt><big>(</big><em>self</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetClientAreaOrigin" title="Permalink to this definition">¶</a></dt> 4397 <dd><p>Get the origin of the client area of the window relative to the 4398 window’s top left corner (the client area may be shifted because of 4399 the borders, scrollbars, other decorations...)</p> 4400 </dd></dl> 4401 4402 <dl class="method"> 4403 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetClientRect"> 4404 <tt class="descname">GetClientRect</tt><big>(</big><em>self</em><big>)</big> → Rect<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetClientRect" title="Permalink to this definition">¶</a></dt> 4405 <dd><p>Get the client area position and size as a <cite>wx.Rect</cite> object.</p> 4406 </dd></dl> 4407 4408 <dl class="method"> 4409 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetClientSize"> 4410 <tt class="descname">GetClientSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetClientSize" title="Permalink to this definition">¶</a></dt> 4411 <dd><p>This gets the size of the window’s ‘client area’ in pixels. The client 4412 area is the area which may be drawn on by the programmer, excluding 4413 title bar, border, scrollbars, etc.</p> 4414 </dd></dl> 4415 4416 <dl class="method"> 4417 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetClientSizeTuple"> 4418 <tt class="descname">GetClientSizeTuple</tt><big>(</big><em>) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetClientSizeTuple" title="Permalink to this definition">¶</a></dt> 4419 <dd><p>This gets the size of the window’s ‘client area’ in pixels. The client 4420 area is the area which may be drawn on by the programmer, excluding 4421 title bar, border, scrollbars, etc.</p> 4422 </dd></dl> 4423 4424 <dl class="method"> 4425 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetConstraints"> 4426 <tt class="descname">GetConstraints</tt><big>(</big><em>self</em><big>)</big> → LayoutConstraints<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetConstraints" title="Permalink to this definition">¶</a></dt> 4427 <dd><p>Returns a pointer to the window’s layout constraints, or None if there 4428 are none.</p> 4429 </dd></dl> 4430 4431 <dl class="method"> 4432 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetContainingSizer"> 4433 <tt class="descname">GetContainingSizer</tt><big>(</big><em>self</em><big>)</big> → Sizer<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetContainingSizer" title="Permalink to this definition">¶</a></dt> 4434 <dd><p>Return the sizer that this window is a member of, if any, otherwise None.</p> 4435 </dd></dl> 4436 4437 <dl class="method"> 4438 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetCursor"> 4439 <tt class="descname">GetCursor</tt><big>(</big><em>self</em><big>)</big> → Cursor<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetCursor" title="Permalink to this definition">¶</a></dt> 4440 <dd><p>Return the cursor associated with this window.</p> 4441 </dd></dl> 4442 4443 <dl class="method"> 4444 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetDefaultAttributes"> 4445 <tt class="descname">GetDefaultAttributes</tt><big>(</big><em>self</em><big>)</big> → VisualAttributes<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetDefaultAttributes" title="Permalink to this definition">¶</a></dt> 4446 <dd><p>Get the default attributes for an instance of this class. This is 4447 useful if you want to use the same font or colour in your own control 4448 as in a standard control – which is a much better idea than hard 4449 coding specific colours or fonts which might look completely out of 4450 place on the user’s system, especially if it uses themes.</p> 4451 </dd></dl> 4452 4453 <dl class="method"> 4454 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetDefaultItem"> 4455 <tt class="descname">GetDefaultItem</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetDefaultItem" title="Permalink to this definition">¶</a></dt> 4456 <dd><p>Get the default child of this parent, i.e. the one which is activated 4457 by pressing <Enter> such as the OK button on a wx.Dialog.</p> 4458 </dd></dl> 4459 4460 <dl class="method"> 4461 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetDropTarget"> 4462 <tt class="descname">GetDropTarget</tt><big>(</big><em>self</em><big>)</big> → DropTarget<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetDropTarget" title="Permalink to this definition">¶</a></dt> 4463 <dd><p>Returns the associated drop target, which may be None.</p> 4464 </dd></dl> 4465 4466 <dl class="method"> 4467 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetEffectiveMinSize"> 4468 <tt class="descname">GetEffectiveMinSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetEffectiveMinSize" title="Permalink to this definition">¶</a></dt> 4469 <dd><p>This function will merge the window’s best size into the window’s 4470 minimum size, giving priority to the min size components, and returns 4471 the results.</p> 4472 </dd></dl> 4473 4474 <dl class="method"> 4475 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetEventHandler"> 4476 <tt class="descname">GetEventHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetEventHandler" title="Permalink to this definition">¶</a></dt> 4477 <dd><p>Returns the event handler for this window. By default, the window is 4478 its own event handler.</p> 4479 </dd></dl> 4480 4481 <dl class="method"> 4482 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetEvtHandlerEnabled"> 4483 <tt class="descname">GetEvtHandlerEnabled</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 4484 <dd></dd></dl> 4485 4486 <dl class="method"> 4487 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetExtraStyle"> 4488 <tt class="descname">GetExtraStyle</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetExtraStyle" title="Permalink to this definition">¶</a></dt> 4489 <dd><p>Returns the extra style bits for the window.</p> 4490 </dd></dl> 4491 4492 <dl class="method"> 4493 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetFont"> 4494 <tt class="descname">GetFont</tt><big>(</big><em>self</em><big>)</big> → Font<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetFont" title="Permalink to this definition">¶</a></dt> 4495 <dd><p>Returns the default font used for this window.</p> 4496 </dd></dl> 4497 4498 <dl class="method"> 4499 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetForegroundColour"> 4500 <tt class="descname">GetForegroundColour</tt><big>(</big><em>self</em><big>)</big> → Colour<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetForegroundColour" title="Permalink to this definition">¶</a></dt> 4501 <dd><p>Returns the foreground colour of the window. The interpretation of 4502 foreground colour is dependent on the window class; it may be the text 4503 colour or other colour, or it may not be used at all.</p> 4504 </dd></dl> 4505 4506 <dl class="method"> 4507 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetFullTextExtent"> 4508 <tt class="descname">GetFullTextExtent</tt><big>(</big><em>String string</em>, <em>Font font=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetFullTextExtent" title="Permalink to this definition">¶</a></dt> 4509 <dd><blockquote> 4510 <div>(width, height, descent, externalLeading)</div></blockquote> 4511 <p>Get the width, height, decent and leading of the text using the 4512 current or specified font.</p> 4513 </dd></dl> 4514 4515 <dl class="method"> 4516 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetGrandParent"> 4517 <tt class="descname">GetGrandParent</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetGrandParent" title="Permalink to this definition">¶</a></dt> 4518 <dd><p>Returns the parent of the parent of this window, or None if there 4519 isn’t one.</p> 4520 </dd></dl> 4521 4522 <dl class="method"> 4523 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetGtkWidget"> 4524 <tt class="descname">GetGtkWidget</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetGtkWidget" title="Permalink to this definition">¶</a></dt> 4525 <dd><p>On wxGTK returns a pointer to the GtkWidget for this window as a long 4526 integer. On the other platforms this method returns zero.</p> 4527 </dd></dl> 4528 4529 <dl class="method"> 4530 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetHandle"> 4531 <tt class="descname">GetHandle</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetHandle" title="Permalink to this definition">¶</a></dt> 4532 <dd><p>Returns the platform-specific handle (as a long integer) of the 4533 physical window. On wxMSW this is the win32 window handle, on wxGTK 4534 it is the XWindow ID, and on wxMac it is the ControlRef.</p> 4535 </dd></dl> 4536 4537 <dl class="method"> 4538 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetHelpText"> 4539 <tt class="descname">GetHelpText</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetHelpText" title="Permalink to this definition">¶</a></dt> 4540 <dd><p>Gets the help text to be used as context-sensitive help for this 4541 window. Note that the text is actually stored by the current 4542 <cite>wx.HelpProvider</cite> implementation, and not in the window object itself.</p> 4543 </dd></dl> 4544 4545 <dl class="method"> 4546 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetHelpTextAtPoint"> 4547 <tt class="descname">GetHelpTextAtPoint</tt><big>(</big><em>self</em>, <em>Point pt</em>, <em>wxHelpEvent::Origin origin</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetHelpTextAtPoint" title="Permalink to this definition">¶</a></dt> 4548 <dd><p>Get the help string associated with the given position in this window.</p> 4549 <p>Notice that pt may be invalid if event origin is keyboard or unknown 4550 and this method should return the global window help text then</p> 4551 </dd></dl> 4552 4553 <dl class="method"> 4554 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetIcon"> 4555 <tt class="descname">GetIcon</tt><big>(</big><em>self</em><big>)</big> → Icon<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetIcon" title="Permalink to this definition">¶</a></dt> 4556 <dd></dd></dl> 4557 4558 <dl class="method"> 4559 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetId"> 4560 <tt class="descname">GetId</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetId" title="Permalink to this definition">¶</a></dt> 4561 <dd><p>Returns the identifier of the window. Each window has an integer 4562 identifier. If the application has not provided one (or the default Id 4563 -1 is used) then an unique identifier with a negative value will be 4564 generated.</p> 4565 </dd></dl> 4566 4567 <dl class="method"> 4568 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetLabel"> 4569 <tt class="descname">GetLabel</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetLabel" title="Permalink to this definition">¶</a></dt> 4570 <dd><p>Generic way of getting a label from any window, for identification 4571 purposes. The interpretation of this function differs from class to 4572 class. For frames and dialogs, the value returned is the title. For 4573 buttons or static text controls, it is the button text. This function 4574 can be useful for meta-programs such as testing tools or special-needs 4575 access programs)which need to identify windows by name.</p> 4576 </dd></dl> 4577 4578 <dl class="method"> 4579 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetLayoutDirection"> 4580 <tt class="descname">GetLayoutDirection</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetLayoutDirection" title="Permalink to this definition">¶</a></dt> 4581 <dd><p>Get the layout direction (LTR or RTL) for this window. Returns 4582 <tt class="docutils literal"><span class="pre">wx.Layout_Default</span></tt> if layout direction is not supported.</p> 4583 </dd></dl> 4584 4585 <dl class="method"> 4586 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetMaxHeight"> 4587 <tt class="descname">GetMaxHeight</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetMaxHeight" title="Permalink to this definition">¶</a></dt> 4588 <dd></dd></dl> 4589 4590 <dl class="method"> 4591 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetMaxSize"> 4592 <tt class="descname">GetMaxSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetMaxSize" title="Permalink to this definition">¶</a></dt> 4593 <dd></dd></dl> 4594 4595 <dl class="method"> 4596 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetMaxWidth"> 4597 <tt class="descname">GetMaxWidth</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetMaxWidth" title="Permalink to this definition">¶</a></dt> 4598 <dd></dd></dl> 4599 4600 <dl class="method"> 4601 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetMenuBar"> 4602 <tt class="descname">GetMenuBar</tt><big>(</big><em>self</em><big>)</big> → MenuBar<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetMenuBar" title="Permalink to this definition">¶</a></dt> 4603 <dd></dd></dl> 4604 4605 <dl class="method"> 4606 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetMinHeight"> 4607 <tt class="descname">GetMinHeight</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetMinHeight" title="Permalink to this definition">¶</a></dt> 4608 <dd></dd></dl> 4609 4610 <dl class="method"> 4611 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetMinSize"> 4612 <tt class="descname">GetMinSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetMinSize" title="Permalink to this definition">¶</a></dt> 4613 <dd></dd></dl> 4614 4615 <dl class="method"> 4616 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetMinWidth"> 4617 <tt class="descname">GetMinWidth</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetMinWidth" title="Permalink to this definition">¶</a></dt> 4618 <dd></dd></dl> 4619 4620 <dl class="method"> 4621 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetName"> 4622 <tt class="descname">GetName</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetName" title="Permalink to this definition">¶</a></dt> 4623 <dd><p>Returns the windows name. This name is not guaranteed to be unique; 4624 it is up to the programmer to supply an appropriate name in the window 4625 constructor or via wx.Window.SetName.</p> 4626 </dd></dl> 4627 4628 <dl class="method"> 4629 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetNextHandler"> 4630 <tt class="descname">GetNextHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetNextHandler" title="Permalink to this definition">¶</a></dt> 4631 <dd></dd></dl> 4632 4633 <dl class="method"> 4634 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetParent"> 4635 <tt class="descname">GetParent</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetParent" title="Permalink to this definition">¶</a></dt> 4636 <dd><p>Returns the parent window of this window, or None if there isn’t one.</p> 4637 </dd></dl> 4638 4639 <dl class="method"> 4640 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetPosition"> 4641 <tt class="descname">GetPosition</tt><big>(</big><em>self</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetPosition" title="Permalink to this definition">¶</a></dt> 4642 <dd><p>Get the window’s position. Notice that the position is in client 4643 coordinates for child windows and screen coordinates for the top level 4644 ones, use <cite>GetScreenPosition</cite> if you need screen coordinates for all 4645 kinds of windows.</p> 4646 </dd></dl> 4647 4648 <dl class="method"> 4649 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetPositionTuple"> 4650 <tt class="descname">GetPositionTuple</tt><big>(</big><em>) -> (x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetPositionTuple" title="Permalink to this definition">¶</a></dt> 4651 <dd><p>Get the window’s position. Notice that the position is in client 4652 coordinates for child windows and screen coordinates for the top level 4653 ones, use <cite>GetScreenPosition</cite> if you need screen coordinates for all 4654 kinds of windows.</p> 4655 </dd></dl> 4656 4657 <dl class="method"> 4658 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetPreviousHandler"> 4659 <tt class="descname">GetPreviousHandler</tt><big>(</big><em>self</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetPreviousHandler" title="Permalink to this definition">¶</a></dt> 4660 <dd></dd></dl> 4661 4662 <dl class="method"> 4663 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetRect"> 4664 <tt class="descname">GetRect</tt><big>(</big><em>self</em><big>)</big> → Rect<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetRect" title="Permalink to this definition">¶</a></dt> 4665 <dd><p>Returns the size and position of the window as a <cite>wx.Rect</cite> object.</p> 4666 </dd></dl> 4667 4668 <dl class="method"> 4669 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetScreenPosition"> 4670 <tt class="descname">GetScreenPosition</tt><big>(</big><em>self</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetScreenPosition" title="Permalink to this definition">¶</a></dt> 4671 <dd><p>Get the position of the window in screen coordinantes.</p> 4672 </dd></dl> 4673 4674 <dl class="method"> 4675 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetScreenPositionTuple"> 4676 <tt class="descname">GetScreenPositionTuple</tt><big>(</big><em>) -> (x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetScreenPositionTuple" title="Permalink to this definition">¶</a></dt> 4677 <dd><p>Get the position of the window in screen coordinantes.</p> 4678 </dd></dl> 4679 4680 <dl class="method"> 4681 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetScreenRect"> 4682 <tt class="descname">GetScreenRect</tt><big>(</big><em>self</em><big>)</big> → Rect<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetScreenRect" title="Permalink to this definition">¶</a></dt> 4683 <dd><p>Returns the size and position of the window in screen coordinantes as 4684 a <cite>wx.Rect</cite> object.</p> 4685 </dd></dl> 4686 4687 <dl class="method"> 4688 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetScrollPos"> 4689 <tt class="descname">GetScrollPos</tt><big>(</big><em>self</em>, <em>int orientation</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetScrollPos" title="Permalink to this definition">¶</a></dt> 4690 <dd><p>Returns the built-in scrollbar position.</p> 4691 </dd></dl> 4692 4693 <dl class="method"> 4694 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetScrollRange"> 4695 <tt class="descname">GetScrollRange</tt><big>(</big><em>self</em>, <em>int orientation</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetScrollRange" title="Permalink to this definition">¶</a></dt> 4696 <dd><p>Returns the built-in scrollbar range.</p> 4697 </dd></dl> 4698 4699 <dl class="method"> 4700 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetScrollThumb"> 4701 <tt class="descname">GetScrollThumb</tt><big>(</big><em>self</em>, <em>int orientation</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetScrollThumb" title="Permalink to this definition">¶</a></dt> 4702 <dd><p>Returns the built-in scrollbar thumb size.</p> 4703 </dd></dl> 4704 4705 <dl class="method"> 4706 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetSize"> 4707 <tt class="descname">GetSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetSize" title="Permalink to this definition">¶</a></dt> 4708 <dd><p>Get the window size.</p> 4709 </dd></dl> 4710 4711 <dl class="method"> 4712 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetSizeTuple"> 4713 <tt class="descname">GetSizeTuple</tt><big>(</big><em>) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetSizeTuple" title="Permalink to this definition">¶</a></dt> 4714 <dd><p>Get the window size.</p> 4715 </dd></dl> 4716 4717 <dl class="method"> 4718 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetSizer"> 4719 <tt class="descname">GetSizer</tt><big>(</big><em>self</em><big>)</big> → Sizer<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetSizer" title="Permalink to this definition">¶</a></dt> 4720 <dd><p>Return the sizer associated with the window by a previous call to 4721 SetSizer or None if there isn’t one.</p> 4722 </dd></dl> 4723 4724 <dl class="method"> 4725 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetStatusBar"> 4726 <tt class="descname">GetStatusBar</tt><big>(</big><em>self</em><big>)</big> → StatusBar<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetStatusBar" title="Permalink to this definition">¶</a></dt> 4727 <dd></dd></dl> 4728 4729 <dl class="method"> 4730 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetStatusBarPane"> 4731 <tt class="descname">GetStatusBarPane</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetStatusBarPane" title="Permalink to this definition">¶</a></dt> 4732 <dd></dd></dl> 4733 4734 <dl class="method"> 4735 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetTextExtent"> 4736 <tt class="descname">GetTextExtent</tt><big>(</big><em>String string) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetTextExtent" title="Permalink to this definition">¶</a></dt> 4737 <dd><p>Get the width and height of the text using the current font.</p> 4738 </dd></dl> 4739 4740 <dl class="method"> 4741 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetThemeEnabled"> 4742 <tt class="descname">GetThemeEnabled</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetThemeEnabled" title="Permalink to this definition">¶</a></dt> 4743 <dd><p>Return the themeEnabled flag.</p> 4744 </dd></dl> 4745 4746 <dl class="method"> 4747 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetTitle"> 4748 <tt class="descname">GetTitle</tt><big>(</big><em>self</em><big>)</big> → String<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetTitle" title="Permalink to this definition">¶</a></dt> 4749 <dd></dd></dl> 4750 4751 <dl class="method"> 4752 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetTmpDefaultItem"> 4753 <tt class="descname">GetTmpDefaultItem</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetTmpDefaultItem" title="Permalink to this definition">¶</a></dt> 4754 <dd><p>Return the temporary default item, which can be None.</p> 4755 </dd></dl> 4756 4757 <dl class="method"> 4758 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetToolBar"> 4759 <tt class="descname">GetToolBar</tt><big>(</big><em>self</em><big>)</big> → wxToolBar<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetToolBar" title="Permalink to this definition">¶</a></dt> 4760 <dd></dd></dl> 4761 4762 <dl class="method"> 4763 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetToolTip"> 4764 <tt class="descname">GetToolTip</tt><big>(</big><em>self</em><big>)</big> → ToolTip<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetToolTip" title="Permalink to this definition">¶</a></dt> 4765 <dd><p>get the associated tooltip or None if none</p> 4766 </dd></dl> 4767 4768 <dl class="method"> 4769 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetTopLevelParent"> 4770 <tt class="descname">GetTopLevelParent</tt><big>(</big><em>self</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetTopLevelParent" title="Permalink to this definition">¶</a></dt> 4771 <dd><p>Returns the first frame or dialog in this window’s parental hierarchy.</p> 4772 </dd></dl> 4773 4774 <dl class="method"> 4775 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetUpdateClientRect"> 4776 <tt class="descname">GetUpdateClientRect</tt><big>(</big><em>self</em><big>)</big> → Rect<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetUpdateClientRect" title="Permalink to this definition">¶</a></dt> 4777 <dd><p>Get the update rectangle region bounding box in client coords.</p> 4778 </dd></dl> 4779 4780 <dl class="method"> 4781 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetUpdateRegion"> 4782 <tt class="descname">GetUpdateRegion</tt><big>(</big><em>self</em><big>)</big> → Region<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetUpdateRegion" title="Permalink to this definition">¶</a></dt> 4783 <dd><p>Returns the region specifying which parts of the window have been 4784 damaged. Should only be called within an EVT_PAINT handler.</p> 4785 </dd></dl> 4786 4787 <dl class="method"> 4788 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetValidator"> 4789 <tt class="descname">GetValidator</tt><big>(</big><em>self</em><big>)</big> → Validator<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetValidator" title="Permalink to this definition">¶</a></dt> 4790 <dd><p>Returns a pointer to the current validator for the window, or None if 4791 there is none.</p> 4792 </dd></dl> 4793 4794 <dl class="method"> 4795 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetVirtualSize"> 4796 <tt class="descname">GetVirtualSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetVirtualSize" title="Permalink to this definition">¶</a></dt> 4797 <dd><p>Get the the virtual size of the window in pixels. For most windows 4798 this is just the client area of the window, but for some like scrolled 4799 windows it is more or less independent of the screen window size.</p> 4800 </dd></dl> 4801 4802 <dl class="method"> 4803 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetVirtualSizeTuple"> 4804 <tt class="descname">GetVirtualSizeTuple</tt><big>(</big><em>) -> (width</em>, <em>height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetVirtualSizeTuple" title="Permalink to this definition">¶</a></dt> 4805 <dd><p>Get the the virtual size of the window in pixels. For most windows 4806 this is just the client area of the window, but for some like scrolled 4807 windows it is more or less independent of the screen window size.</p> 4808 </dd></dl> 4809 4810 <dl class="method"> 4811 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetWindowBorderSize"> 4812 <tt class="descname">GetWindowBorderSize</tt><big>(</big><em>self</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetWindowBorderSize" title="Permalink to this definition">¶</a></dt> 4813 <dd><p>Return the size of the left/right and top/bottom borders.</p> 4814 </dd></dl> 4815 4816 <dl class="method"> 4817 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetWindowStyle"> 4818 <tt class="descname">GetWindowStyle</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetWindowStyle" title="Permalink to this definition">¶</a></dt> 4819 <dd><p>GetWindowStyleFlag(self) -> long</p> 4820 <p>Gets the window style that was passed to the constructor or Create 4821 method.</p> 4822 </dd></dl> 4823 4824 <dl class="method"> 4825 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetWindowStyleFlag"> 4826 <tt class="descname">GetWindowStyleFlag</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetWindowStyleFlag" title="Permalink to this definition">¶</a></dt> 4827 <dd><p>Gets the window style that was passed to the constructor or Create 4828 method.</p> 4829 </dd></dl> 4830 4831 <dl class="method"> 4832 <dt id="sans.guiframe.gui_manager.ViewerFrame.GetWindowVariant"> 4833 <tt class="descname">GetWindowVariant</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GetWindowVariant" title="Permalink to this definition">¶</a></dt> 4834 <dd></dd></dl> 4835 4836 <dl class="attribute"> 4837 <dt id="sans.guiframe.gui_manager.ViewerFrame.GrandParent"> 4838 <tt class="descname">GrandParent</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GrandParent" title="Permalink to this definition">¶</a></dt> 4839 <dd><p>See <cite>GetGrandParent</cite></p> 4840 </dd></dl> 4841 4842 <dl class="attribute"> 4843 <dt id="sans.guiframe.gui_manager.ViewerFrame.GtkWidget"> 4844 <tt class="descname">GtkWidget</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.GtkWidget" title="Permalink to this definition">¶</a></dt> 4845 <dd><p>GetGtkWidget(self) -> long</p> 4846 <p>On wxGTK returns a pointer to the GtkWidget for this window as a long 4847 integer. On the other platforms this method returns zero.</p> 4848 </dd></dl> 4849 4850 <dl class="attribute"> 4851 <dt id="sans.guiframe.gui_manager.ViewerFrame.Handle"> 4852 <tt class="descname">Handle</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Handle" title="Permalink to this definition">¶</a></dt> 4853 <dd><p>See <cite>GetHandle</cite></p> 4854 </dd></dl> 4855 4856 <dl class="method"> 4857 <dt id="sans.guiframe.gui_manager.ViewerFrame.HasCapture"> 4858 <tt class="descname">HasCapture</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.HasCapture" title="Permalink to this definition">¶</a></dt> 4859 <dd><p>Returns true if this window has the current mouse capture.</p> 4860 </dd></dl> 4861 4862 <dl class="method"> 4863 <dt id="sans.guiframe.gui_manager.ViewerFrame.HasFlag"> 4864 <tt class="descname">HasFlag</tt><big>(</big><em>self</em>, <em>int flag</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.HasFlag" title="Permalink to this definition">¶</a></dt> 4865 <dd><p>Test if the given style is set for this window.</p> 4866 </dd></dl> 4867 4868 <dl class="method"> 4869 <dt id="sans.guiframe.gui_manager.ViewerFrame.HasMultiplePages"> 4870 <tt class="descname">HasMultiplePages</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.HasMultiplePages" title="Permalink to this definition">¶</a></dt> 4871 <dd></dd></dl> 4872 4873 <dl class="method"> 4874 <dt id="sans.guiframe.gui_manager.ViewerFrame.HasScrollbar"> 4875 <tt class="descname">HasScrollbar</tt><big>(</big><em>self</em>, <em>int orient</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.HasScrollbar" title="Permalink to this definition">¶</a></dt> 4876 <dd><p>Does the window have the scrollbar for this orientation?</p> 4877 </dd></dl> 4878 4879 <dl class="method"> 4880 <dt id="sans.guiframe.gui_manager.ViewerFrame.HasTransparentBackground"> 4881 <tt class="descname">HasTransparentBackground</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.HasTransparentBackground" title="Permalink to this definition">¶</a></dt> 4882 <dd><p>Returns True if this window’s background is transparent (as, for 4883 example, for <cite>wx.StaticText</cite>) and should show the parent window’s 4884 background.</p> 4885 <p>This method is mostly used internally by the library itself and you 4886 normally shouldn’t have to call it. You may, however, have to override 4887 it in your custom control classes to ensure that background is painted 4888 correctly.</p> 4889 </dd></dl> 4890 4891 <dl class="attribute"> 4892 <dt id="sans.guiframe.gui_manager.ViewerFrame.HelpText"> 4893 <tt class="descname">HelpText</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.HelpText" title="Permalink to this definition">¶</a></dt> 4894 <dd><p>See <cite>GetHelpText</cite> and <cite>SetHelpText</cite></p> 4895 </dd></dl> 4896 4897 <dl class="method"> 4898 <dt id="sans.guiframe.gui_manager.ViewerFrame.Hide"> 4899 <tt class="descname">Hide</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Hide" title="Permalink to this definition">¶</a></dt> 4900 <dd><p>Equivalent to calling Show(False).</p> 4901 </dd></dl> 4902 4903 <dl class="method"> 4904 <dt id="sans.guiframe.gui_manager.ViewerFrame.HitTest"> 4905 <tt class="descname">HitTest</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.HitTest" title="Permalink to this definition">¶</a></dt> 4906 <dd><p>Test where the given (in client coords) point lies</p> 4907 </dd></dl> 4908 4909 <dl class="method"> 4910 <dt id="sans.guiframe.gui_manager.ViewerFrame.HitTestXY"> 4911 <tt class="descname">HitTestXY</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int y</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.HitTestXY" title="Permalink to this definition">¶</a></dt> 4912 <dd><p>Test where the given (in client coords) point lies</p> 4913 </dd></dl> 4914 4915 <dl class="attribute"> 4916 <dt id="sans.guiframe.gui_manager.ViewerFrame.Icon"> 4917 <tt class="descname">Icon</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Icon" title="Permalink to this definition">¶</a></dt> 4918 <dd><p>See <cite>GetIcon</cite> and <cite>SetIcon</cite></p> 4919 </dd></dl> 4920 4921 <dl class="method"> 4922 <dt id="sans.guiframe.gui_manager.ViewerFrame.Iconize"> 4923 <tt class="descname">Iconize</tt><big>(</big><em>self</em>, <em>bool iconize=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Iconize" title="Permalink to this definition">¶</a></dt> 4924 <dd></dd></dl> 4925 4926 <dl class="attribute"> 4927 <dt id="sans.guiframe.gui_manager.ViewerFrame.Id"> 4928 <tt class="descname">Id</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Id" title="Permalink to this definition">¶</a></dt> 4929 <dd><p>See <cite>GetId</cite> and <cite>SetId</cite></p> 4930 </dd></dl> 4931 4932 <dl class="method"> 4933 <dt id="sans.guiframe.gui_manager.ViewerFrame.InheritAttributes"> 4934 <tt class="descname">InheritAttributes</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.InheritAttributes" title="Permalink to this definition">¶</a></dt> 4935 <dd><p>This function is (or should be, in case of custom controls) called 4936 during window creation to intelligently set up the window visual 4937 attributes, that is the font and the foreground and background 4938 colours.</p> 4939 <p>By ‘intelligently’ the following is meant: by default, all windows use 4940 their own default attributes. However if some of the parent’s 4941 attributes are explicitly changed (that is, using SetFont and not 4942 SetOwnFont) and if the corresponding attribute hadn’t been 4943 explicitly set for this window itself, then this window takes the same 4944 value as used by the parent. In addition, if the window overrides 4945 ShouldInheritColours to return false, the colours will not be changed 4946 no matter what and only the font might.</p> 4947 <p>This rather complicated logic is necessary in order to accommodate the 4948 different usage scenarios. The most common one is when all default 4949 attributes are used and in this case, nothing should be inherited as 4950 in modern GUIs different controls use different fonts (and colours) 4951 than their siblings so they can’t inherit the same value from the 4952 parent. However it was also deemed desirable to allow to simply change 4953 the attributes of all children at once by just changing the font or 4954 colour of their common parent, hence in this case we do inherit the 4955 parents attributes.</p> 4956 </dd></dl> 4957 4958 <dl class="method"> 4959 <dt id="sans.guiframe.gui_manager.ViewerFrame.InheritsBackgroundColour"> 4960 <tt class="descname">InheritsBackgroundColour</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.InheritsBackgroundColour" title="Permalink to this definition">¶</a></dt> 4961 <dd></dd></dl> 4962 4963 <dl class="method"> 4964 <dt id="sans.guiframe.gui_manager.ViewerFrame.InitDialog"> 4965 <tt class="descname">InitDialog</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.InitDialog" title="Permalink to this definition">¶</a></dt> 4966 <dd><p>Sends an EVT_INIT_DIALOG event, whose handler usually transfers data 4967 to the dialog via validators.</p> 4968 </dd></dl> 4969 4970 <dl class="method"> 4971 <dt id="sans.guiframe.gui_manager.ViewerFrame.InvalidateBestSize"> 4972 <tt class="descname">InvalidateBestSize</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.InvalidateBestSize" title="Permalink to this definition">¶</a></dt> 4973 <dd><p>Reset the cached best size value so it will be recalculated the next 4974 time it is needed.</p> 4975 </dd></dl> 4976 4977 <dl class="method"> 4978 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsActive"> 4979 <tt class="descname">IsActive</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsActive" title="Permalink to this definition">¶</a></dt> 4980 <dd></dd></dl> 4981 4982 <dl class="method"> 4983 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsAlwaysMaximized"> 4984 <tt class="descname">IsAlwaysMaximized</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsAlwaysMaximized" title="Permalink to this definition">¶</a></dt> 4985 <dd></dd></dl> 4986 4987 <dl class="method"> 4988 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsBeingDeleted"> 4989 <tt class="descname">IsBeingDeleted</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsBeingDeleted" title="Permalink to this definition">¶</a></dt> 4990 <dd><p>Is the window in the process of being deleted?</p> 4991 </dd></dl> 4992 4993 <dl class="method"> 4994 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsDoubleBuffered"> 4995 <tt class="descname">IsDoubleBuffered</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsDoubleBuffered" title="Permalink to this definition">¶</a></dt> 4996 <dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the window contents is double-buffered by the 4997 system, i.e. if any drawing done on the window is really done on a 4998 temporary backing surface and transferred to the screen all at once 4999 later.</p> 5000 </dd></dl> 5001 5002 <dl class="method"> 5003 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsEnabled"> 5004 <tt class="descname">IsEnabled</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsEnabled" title="Permalink to this definition">¶</a></dt> 5005 <dd><p>Returns true if the window is enabled for input, false otherwise.</p> 5006 </dd></dl> 5007 5008 <dl class="method"> 5009 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsExposed"> 5010 <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> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsExposed" title="Permalink to this definition">¶</a></dt> 5011 <dd><p>Returns true if the given point or rectangle area has been exposed 5012 since the last repaint. Call this in an paint event handler to 5013 optimize redrawing by only redrawing those areas, which have been 5014 exposed.</p> 5015 </dd></dl> 5016 5017 <dl class="method"> 5018 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsExposedPoint"> 5019 <tt class="descname">IsExposedPoint</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsExposedPoint" title="Permalink to this definition">¶</a></dt> 5020 <dd><p>Returns true if the given point or rectangle area has been exposed 5021 since the last repaint. Call this in an paint event handler to 5022 optimize redrawing by only redrawing those areas, which have been 5023 exposed.</p> 5024 </dd></dl> 5025 5026 <dl class="method"> 5027 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsExposedRect"> 5028 <tt class="descname">IsExposedRect</tt><big>(</big><em>self</em>, <em>Rect rect</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsExposedRect" title="Permalink to this definition">¶</a></dt> 5029 <dd><p>Returns true if the given point or rectangle area has been exposed 5030 since the last repaint. Call this in an paint event handler to 5031 optimize redrawing by only redrawing those areas, which have been 5032 exposed.</p> 5033 </dd></dl> 5034 5035 <dl class="method"> 5036 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsFrozen"> 5037 <tt class="descname">IsFrozen</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsFrozen" title="Permalink to this definition">¶</a></dt> 5038 <dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the window has been frozen and not thawed yet.</p> 5039 <table class="docutils field-list" frame="void" rules="none"> 5040 <col class="field-name" /> 5041 <col class="field-body" /> 5042 <tbody valign="top"> 5043 <tr class="field-odd field"><th class="field-name">See :</th><td class="field-body"><cite>Freeze</cite> and <cite>Thaw</cite></td> 5044 </tr> 5045 </tbody> 5046 </table> 5047 </dd></dl> 5048 5049 <dl class="method"> 5050 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsFullScreen"> 5051 <tt class="descname">IsFullScreen</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsFullScreen" title="Permalink to this definition">¶</a></dt> 5052 <dd></dd></dl> 5053 5054 <dl class="method"> 5055 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsIconized"> 5056 <tt class="descname">IsIconized</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsIconized" title="Permalink to this definition">¶</a></dt> 5057 <dd></dd></dl> 5058 5059 <dl class="method"> 5060 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsMaximized"> 5061 <tt class="descname">IsMaximized</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsMaximized" title="Permalink to this definition">¶</a></dt> 5062 <dd></dd></dl> 5063 5064 <dl class="method"> 5065 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsRetained"> 5066 <tt class="descname">IsRetained</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsRetained" title="Permalink to this definition">¶</a></dt> 5067 <dd><p>Returns true if the window is retained, false otherwise. Retained 5068 windows are only available on X platforms.</p> 5069 </dd></dl> 5070 5071 <dl class="method"> 5072 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsSameAs"> 5073 <tt class="descname">IsSameAs</tt><big>(</big><em>self</em>, <em>Object p</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsSameAs" title="Permalink to this definition">¶</a></dt> 5074 <dd><p>For wx.Objects that use C++ reference counting internally, this method 5075 can be used to determine if two objects are referencing the same data 5076 object.</p> 5077 </dd></dl> 5078 5079 <dl class="method"> 5080 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsShown"> 5081 <tt class="descname">IsShown</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsShown" title="Permalink to this definition">¶</a></dt> 5082 <dd><p>Returns true if the window is shown, false if it has been hidden.</p> 5083 </dd></dl> 5084 5085 <dl class="method"> 5086 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsShownOnScreen"> 5087 <tt class="descname">IsShownOnScreen</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsShownOnScreen" title="Permalink to this definition">¶</a></dt> 5088 <dd><p>Returns <tt class="docutils literal"><span class="pre">True</span></tt> if the window is physically visible on the screen, 5089 i.e. it is shown and all its parents up to the toplevel window are 5090 shown as well.</p> 5091 </dd></dl> 5092 5093 <dl class="method"> 5094 <dt id="sans.guiframe.gui_manager.ViewerFrame.IsTopLevel"> 5095 <tt class="descname">IsTopLevel</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.IsTopLevel" title="Permalink to this definition">¶</a></dt> 5096 <dd><p>Returns true if the given window is a top-level one. Currently all 5097 frames and dialogs are always considered to be top-level windows (even 5098 if they have a parent window).</p> 5099 </dd></dl> 5100 5101 <dl class="attribute"> 5102 <dt id="sans.guiframe.gui_manager.ViewerFrame.Label"> 5103 <tt class="descname">Label</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Label" title="Permalink to this definition">¶</a></dt> 5104 <dd><p>See <cite>GetLabel</cite> and <cite>SetLabel</cite></p> 5105 </dd></dl> 5106 5107 <dl class="method"> 5108 <dt id="sans.guiframe.gui_manager.ViewerFrame.Layout"> 5109 <tt class="descname">Layout</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Layout" title="Permalink to this definition">¶</a></dt> 5110 <dd><p>Invokes the constraint-based layout algorithm or the sizer-based 5111 algorithm for this window. See SetAutoLayout: when auto layout is on, 5112 this function gets called automatically by the default EVT_SIZE 5113 handler when the window is resized.</p> 5114 </dd></dl> 5115 5116 <dl class="attribute"> 5117 <dt id="sans.guiframe.gui_manager.ViewerFrame.LayoutDirection"> 5118 <tt class="descname">LayoutDirection</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.LayoutDirection" title="Permalink to this definition">¶</a></dt> 5119 <dd><p>See <cite>GetLayoutDirection</cite> and <cite>SetLayoutDirection</cite></p> 5120 </dd></dl> 5121 5122 <dl class="method"> 5123 <dt id="sans.guiframe.gui_manager.ViewerFrame.LineDown"> 5124 <tt class="descname">LineDown</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.LineDown" title="Permalink to this definition">¶</a></dt> 5125 <dd><p>This is just a wrapper for ScrollLines(1).</p> 5126 </dd></dl> 5127 5128 <dl class="method"> 5129 <dt id="sans.guiframe.gui_manager.ViewerFrame.LineUp"> 5130 <tt class="descname">LineUp</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.LineUp" title="Permalink to this definition">¶</a></dt> 5131 <dd><p>This is just a wrapper for ScrollLines(-1).</p> 5132 </dd></dl> 5133 5134 <dl class="method"> 5135 <dt id="sans.guiframe.gui_manager.ViewerFrame.Lower"> 5136 <tt class="descname">Lower</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Lower" title="Permalink to this definition">¶</a></dt> 5137 <dd><p>Lowers the window to the bottom of the window hierarchy. In current 5138 version of wxWidgets this works both for managed and child windows.</p> 5139 </dd></dl> 5140 5141 <dl class="method"> 5142 <dt id="sans.guiframe.gui_manager.ViewerFrame.MacGetMetalAppearance"> 5143 <tt class="descname">MacGetMetalAppearance</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MacGetMetalAppearance" title="Permalink to this definition">¶</a></dt> 5144 <dd></dd></dl> 5145 5146 <dl class="method"> 5147 <dt id="sans.guiframe.gui_manager.ViewerFrame.MacGetTopLevelWindowRef"> 5148 <tt class="descname">MacGetTopLevelWindowRef</tt><big>(</big><em>self</em><big>)</big> → long<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MacGetTopLevelWindowRef" title="Permalink to this definition">¶</a></dt> 5149 <dd></dd></dl> 5150 5151 <dl class="method"> 5152 <dt id="sans.guiframe.gui_manager.ViewerFrame.MacGetUnifiedAppearance"> 5153 <tt class="descname">MacGetUnifiedAppearance</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MacGetUnifiedAppearance" title="Permalink to this definition">¶</a></dt> 5154 <dd></dd></dl> 5155 5156 <dl class="method"> 5157 <dt id="sans.guiframe.gui_manager.ViewerFrame.MacSetMetalAppearance"> 5158 <tt class="descname">MacSetMetalAppearance</tt><big>(</big><em>self</em>, <em>bool on</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MacSetMetalAppearance" title="Permalink to this definition">¶</a></dt> 5159 <dd></dd></dl> 5160 5161 <dl class="method"> 5162 <dt id="sans.guiframe.gui_manager.ViewerFrame.MakeModal"> 5163 <tt class="descname">MakeModal</tt><big>(</big><em>self</em>, <em>bool modal=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MakeModal" title="Permalink to this definition">¶</a></dt> 5164 <dd><p>Disables all other windows in the application so that the user can 5165 only interact with this window. Passing False will reverse this 5166 effect.</p> 5167 </dd></dl> 5168 5169 <dl class="attribute"> 5170 <dt id="sans.guiframe.gui_manager.ViewerFrame.MaxHeight"> 5171 <tt class="descname">MaxHeight</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MaxHeight" title="Permalink to this definition">¶</a></dt> 5172 <dd><p>See <cite>GetMaxHeight</cite></p> 5173 </dd></dl> 5174 5175 <dl class="attribute"> 5176 <dt id="sans.guiframe.gui_manager.ViewerFrame.MaxSize"> 5177 <tt class="descname">MaxSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MaxSize" title="Permalink to this definition">¶</a></dt> 5178 <dd><p>See <cite>GetMaxSize</cite> and <cite>SetMaxSize</cite></p> 5179 </dd></dl> 5180 5181 <dl class="attribute"> 5182 <dt id="sans.guiframe.gui_manager.ViewerFrame.MaxWidth"> 5183 <tt class="descname">MaxWidth</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MaxWidth" title="Permalink to this definition">¶</a></dt> 5184 <dd><p>See <cite>GetMaxWidth</cite></p> 5185 </dd></dl> 5186 5187 <dl class="method"> 5188 <dt id="sans.guiframe.gui_manager.ViewerFrame.Maximize"> 5189 <tt class="descname">Maximize</tt><big>(</big><em>self</em>, <em>bool maximize=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Maximize" title="Permalink to this definition">¶</a></dt> 5190 <dd></dd></dl> 5191 5192 <dl class="attribute"> 5193 <dt id="sans.guiframe.gui_manager.ViewerFrame.MenuBar"> 5194 <tt class="descname">MenuBar</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MenuBar" title="Permalink to this definition">¶</a></dt> 5195 <dd><p>See <cite>GetMenuBar</cite> and <cite>SetMenuBar</cite></p> 5196 </dd></dl> 5197 5198 <dl class="attribute"> 5199 <dt id="sans.guiframe.gui_manager.ViewerFrame.MinHeight"> 5200 <tt class="descname">MinHeight</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MinHeight" title="Permalink to this definition">¶</a></dt> 5201 <dd><p>See <cite>GetMinHeight</cite></p> 5202 </dd></dl> 5203 5204 <dl class="attribute"> 5205 <dt id="sans.guiframe.gui_manager.ViewerFrame.MinSize"> 5206 <tt class="descname">MinSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MinSize" title="Permalink to this definition">¶</a></dt> 5207 <dd><p>See <cite>GetMinSize</cite> and <cite>SetMinSize</cite></p> 5208 </dd></dl> 5209 5210 <dl class="attribute"> 5211 <dt id="sans.guiframe.gui_manager.ViewerFrame.MinWidth"> 5212 <tt class="descname">MinWidth</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MinWidth" title="Permalink to this definition">¶</a></dt> 5213 <dd><p>See <cite>GetMinWidth</cite></p> 5214 </dd></dl> 5215 5216 <dl class="method"> 5217 <dt id="sans.guiframe.gui_manager.ViewerFrame.Move"> 5218 <tt class="descname">Move</tt><big>(</big><em>self</em>, <em>Point pt</em>, <em>int flags=SIZE_USE_EXISTING</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Move" title="Permalink to this definition">¶</a></dt> 5219 <dd><p>Moves the window to the given position.</p> 5220 </dd></dl> 5221 5222 <dl class="method"> 5223 <dt id="sans.guiframe.gui_manager.ViewerFrame.MoveAfterInTabOrder"> 5224 <tt class="descname">MoveAfterInTabOrder</tt><big>(</big><em>self</em>, <em>Window win</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MoveAfterInTabOrder" title="Permalink to this definition">¶</a></dt> 5225 <dd><p>Moves this window in the tab navigation order after the specified 5226 sibling window. This means that when the user presses the TAB key on 5227 that other window, the focus switches to this window.</p> 5228 <p>The default tab order is the same as creation order. This function 5229 and <cite>MoveBeforeInTabOrder</cite> allow to change it after creating all the 5230 windows.</p> 5231 </dd></dl> 5232 5233 <dl class="method"> 5234 <dt id="sans.guiframe.gui_manager.ViewerFrame.MoveBeforeInTabOrder"> 5235 <tt class="descname">MoveBeforeInTabOrder</tt><big>(</big><em>self</em>, <em>Window win</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MoveBeforeInTabOrder" title="Permalink to this definition">¶</a></dt> 5236 <dd><p>Same as <cite>MoveAfterInTabOrder</cite> except that it inserts this window just 5237 before win instead of putting it right after it.</p> 5238 </dd></dl> 5239 5240 <dl class="method"> 5241 <dt id="sans.guiframe.gui_manager.ViewerFrame.MoveXY"> 5242 <tt class="descname">MoveXY</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int y</em>, <em>int flags=SIZE_USE_EXISTING</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.MoveXY" title="Permalink to this definition">¶</a></dt> 5243 <dd><p>Moves the window to the given position.</p> 5244 </dd></dl> 5245 5246 <dl class="attribute"> 5247 <dt id="sans.guiframe.gui_manager.ViewerFrame.Name"> 5248 <tt class="descname">Name</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Name" title="Permalink to this definition">¶</a></dt> 5249 <dd><p>See <cite>GetName</cite> and <cite>SetName</cite></p> 5250 </dd></dl> 5251 5252 <dl class="method"> 5253 <dt id="sans.guiframe.gui_manager.ViewerFrame.Navigate"> 5254 <tt class="descname">Navigate</tt><big>(</big><em>self</em>, <em>int flags=NavigationKeyEvent.IsForward</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Navigate" title="Permalink to this definition">¶</a></dt> 5255 <dd><p>Does keyboard navigation from this window to another, by sending a 5256 <cite>wx.NavigationKeyEvent</cite>.</p> 5257 </dd></dl> 5258 5259 <dl class="staticmethod"> 5260 <dt id="sans.guiframe.gui_manager.ViewerFrame.NewControlId"> 5261 <em class="property">static </em><tt class="descname">NewControlId</tt><big>(</big><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.NewControlId" title="Permalink to this definition">¶</a></dt> 5262 <dd><p>Generate a control id for the controls which were not given one.</p> 5263 </dd></dl> 5264 5265 <dl class="staticmethod"> 5266 <dt id="sans.guiframe.gui_manager.ViewerFrame.NextControlId"> 5267 <em class="property">static </em><tt class="descname">NextControlId</tt><big>(</big><em>int winid</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.NextControlId" title="Permalink to this definition">¶</a></dt> 5268 <dd><p>Get the id of the control following the one with the given 5269 autogenerated) id</p> 5270 </dd></dl> 5271 5272 <dl class="attribute"> 5273 <dt id="sans.guiframe.gui_manager.ViewerFrame.NextHandler"> 5274 <tt class="descname">NextHandler</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.NextHandler" title="Permalink to this definition">¶</a></dt> 5275 <dd><p>See <cite>GetNextHandler</cite> and <cite>SetNextHandler</cite></p> 5276 </dd></dl> 5277 5278 <dl class="method"> 5279 <dt id="sans.guiframe.gui_manager.ViewerFrame.OnPaint"> 5280 <tt class="descname">OnPaint</tt><big>(</big><em>self</em>, <em>PaintEvent event</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.OnPaint" title="Permalink to this definition">¶</a></dt> 5281 <dd></dd></dl> 5282 5283 <dl class="method"> 5284 <dt id="sans.guiframe.gui_manager.ViewerFrame.PageDown"> 5285 <tt class="descname">PageDown</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PageDown" title="Permalink to this definition">¶</a></dt> 5286 <dd><p>This is just a wrapper for ScrollPages(1).</p> 5287 </dd></dl> 5288 5289 <dl class="method"> 5290 <dt id="sans.guiframe.gui_manager.ViewerFrame.PageUp"> 5291 <tt class="descname">PageUp</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PageUp" title="Permalink to this definition">¶</a></dt> 5292 <dd><p>This is just a wrapper for ScrollPages(-1).</p> 5293 </dd></dl> 5294 5295 <dl class="attribute"> 5296 <dt id="sans.guiframe.gui_manager.ViewerFrame.Parent"> 5297 <tt class="descname">Parent</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Parent" title="Permalink to this definition">¶</a></dt> 5298 <dd><p>See <cite>GetParent</cite></p> 5299 </dd></dl> 5300 5301 <dl class="method"> 5302 <dt id="sans.guiframe.gui_manager.ViewerFrame.PopEventHandler"> 5303 <tt class="descname">PopEventHandler</tt><big>(</big><em>self</em>, <em>bool deleteHandler=False</em><big>)</big> → EvtHandler<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PopEventHandler" title="Permalink to this definition">¶</a></dt> 5304 <dd><p>Removes and returns the top-most event handler on the event handler 5305 stack. If deleteHandler is True then the wx.EvtHandler object will be 5306 destroyed after it is popped, and <tt class="docutils literal"><span class="pre">None</span></tt> will be returned instead.</p> 5307 </dd></dl> 5308 5309 <dl class="method"> 5310 <dt id="sans.guiframe.gui_manager.ViewerFrame.PopStatusText"> 5311 <tt class="descname">PopStatusText</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PopStatusText" title="Permalink to this definition">¶</a></dt> 5312 <dd></dd></dl> 5313 5314 <dl class="method"> 5315 <dt id="sans.guiframe.gui_manager.ViewerFrame.PopupMenu"> 5316 <tt class="descname">PopupMenu</tt><big>(</big><em>self</em>, <em>Menu menu</em>, <em>Point pos=DefaultPosition</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PopupMenu" title="Permalink to this definition">¶</a></dt> 5317 <dd><p>Pops up the given menu at the specified coordinates, relative to this window, 5318 and returns control when the user has dismissed the menu. If a menu item is 5319 selected, the corresponding menu event is generated and will be processed as 5320 usual. If the default position is given then the current position of the 5321 mouse cursor will be used.</p> 5322 </dd></dl> 5323 5324 <dl class="method"> 5325 <dt id="sans.guiframe.gui_manager.ViewerFrame.PopupMenuXY"> 5326 <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> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PopupMenuXY" title="Permalink to this definition">¶</a></dt> 5327 <dd><p>Pops up the given menu at the specified coordinates, relative to this window, 5328 and returns control when the user has dismissed the menu. If a menu item is 5329 selected, the corresponding menu event is generated and will be processed as 5330 usual. If the default position is given then the current position of the 5331 mouse cursor will be used.</p> 5332 </dd></dl> 5333 5334 <dl class="attribute"> 5335 <dt id="sans.guiframe.gui_manager.ViewerFrame.Position"> 5336 <tt class="descname">Position</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Position" title="Permalink to this definition">¶</a></dt> 5337 <dd><p>See <cite>GetPosition</cite> and <cite>SetPosition</cite></p> 5338 </dd></dl> 5339 5340 <dl class="method"> 5341 <dt id="sans.guiframe.gui_manager.ViewerFrame.PostCreate"> 5342 <tt class="descname">PostCreate</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PostCreate" title="Permalink to this definition">¶</a></dt> 5343 <dd><p>Phase 3 of the 2-phase create <wink!> 5344 Call this method after precreating the window with the 2-phase create method.</p> 5345 </dd></dl> 5346 5347 <dl class="method"> 5348 <dt id="sans.guiframe.gui_manager.ViewerFrame.PrepareDC"> 5349 <tt class="descname">PrepareDC</tt><big>(</big><em>self</em>, <em>DC dc</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PrepareDC" title="Permalink to this definition">¶</a></dt> 5350 <dd><p>Call this function to prepare the device context for drawing a 5351 scrolled image. It sets the device origin according to the current 5352 scroll position.</p> 5353 </dd></dl> 5354 5355 <dl class="staticmethod"> 5356 <dt id="sans.guiframe.gui_manager.ViewerFrame.PrevControlId"> 5357 <em class="property">static </em><tt class="descname">PrevControlId</tt><big>(</big><em>int winid</em><big>)</big> → int<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PrevControlId" title="Permalink to this definition">¶</a></dt> 5358 <dd><p>Get the id of the control preceding the one with the given 5359 autogenerated) id</p> 5360 </dd></dl> 5361 5362 <dl class="attribute"> 5363 <dt id="sans.guiframe.gui_manager.ViewerFrame.PreviousHandler"> 5364 <tt class="descname">PreviousHandler</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PreviousHandler" title="Permalink to this definition">¶</a></dt> 5365 <dd><p>See <cite>GetPreviousHandler</cite> and <cite>SetPreviousHandler</cite></p> 5366 </dd></dl> 5367 5368 <dl class="method"> 5369 <dt id="sans.guiframe.gui_manager.ViewerFrame.ProcessCommand"> 5370 <tt class="descname">ProcessCommand</tt><big>(</big><em>self</em>, <em>int winid</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ProcessCommand" title="Permalink to this definition">¶</a></dt> 5371 <dd></dd></dl> 5372 5373 <dl class="method"> 5374 <dt id="sans.guiframe.gui_manager.ViewerFrame.ProcessEvent"> 5375 <tt class="descname">ProcessEvent</tt><big>(</big><em>self</em>, <em>Event event</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ProcessEvent" title="Permalink to this definition">¶</a></dt> 5376 <dd></dd></dl> 5377 5378 <dl class="method"> 5379 <dt id="sans.guiframe.gui_manager.ViewerFrame.ProcessPendingEvents"> 5380 <tt class="descname">ProcessPendingEvents</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ProcessPendingEvents" title="Permalink to this definition">¶</a></dt> 5381 <dd></dd></dl> 5382 5383 <dl class="method"> 5384 <dt id="sans.guiframe.gui_manager.ViewerFrame.PushEventHandler"> 5385 <tt class="descname">PushEventHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PushEventHandler" title="Permalink to this definition">¶</a></dt> 5386 <dd><p>Pushes this event handler onto the event handler stack for the window. 5387 An event handler is an object that is capable of processing the events 5388 sent to a window. (In other words, is able to dispatch the events to a 5389 handler function.) By default, the window is its own event handler, 5390 but an application may wish to substitute another, for example to 5391 allow central implementation of event-handling for a variety of 5392 different window classes.</p> 5393 <p>wx.Window.PushEventHandler allows an application to set up a chain of 5394 event handlers, where an event not handled by one event handler is 5395 handed to the next one in the chain. Use <cite>wx.Window.PopEventHandler</cite> 5396 to remove the event handler. Ownership of the handler is <em>not</em> given 5397 to the window, so you should be sure to pop the handler before the 5398 window is destroyed and either let PopEventHandler destroy it, or call 5399 its Destroy method yourself.</p> 5400 </dd></dl> 5401 5402 <dl class="method"> 5403 <dt id="sans.guiframe.gui_manager.ViewerFrame.PushStatusText"> 5404 <tt class="descname">PushStatusText</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.PushStatusText" title="Permalink to this definition">¶</a></dt> 5405 <dd></dd></dl> 5406 5407 <dl class="method"> 5408 <dt id="sans.guiframe.gui_manager.ViewerFrame.Raise"> 5409 <tt class="descname">Raise</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Raise" title="Permalink to this definition">¶</a></dt> 5410 <dd><p>Raises the window to the top of the window hierarchy. In current 5411 version of wxWidgets this works both for managed and child windows.</p> 5412 </dd></dl> 5413 5414 <dl class="attribute"> 5415 <dt id="sans.guiframe.gui_manager.ViewerFrame.Rect"> 5416 <tt class="descname">Rect</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Rect" title="Permalink to this definition">¶</a></dt> 5417 <dd><p>See <cite>GetRect</cite> and <cite>SetRect</cite></p> 5418 </dd></dl> 5419 5420 <dl class="method"> 5421 <dt id="sans.guiframe.gui_manager.ViewerFrame.Refresh"> 5422 <tt class="descname">Refresh</tt><big>(</big><em>self</em>, <em>bool eraseBackground=True</em>, <em>Rect rect=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Refresh" title="Permalink to this definition">¶</a></dt> 5423 <dd><p>Mark the specified rectangle (or the whole window) as “dirty” so it 5424 will be repainted. Causes an EVT_PAINT event to be generated and sent 5425 to the window.</p> 5426 </dd></dl> 5427 5428 <dl class="method"> 5429 <dt id="sans.guiframe.gui_manager.ViewerFrame.RefreshRect"> 5430 <tt class="descname">RefreshRect</tt><big>(</big><em>self</em>, <em>Rect rect</em>, <em>bool eraseBackground=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.RefreshRect" title="Permalink to this definition">¶</a></dt> 5431 <dd><p>Redraws the contents of the given rectangle: the area inside it will 5432 be repainted. This is the same as Refresh but has a nicer syntax.</p> 5433 </dd></dl> 5434 5435 <dl class="method"> 5436 <dt id="sans.guiframe.gui_manager.ViewerFrame.RegisterHotKey"> 5437 <tt class="descname">RegisterHotKey</tt><big>(</big><em>self</em>, <em>int hotkeyId</em>, <em>int modifiers</em>, <em>int keycode</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.RegisterHotKey" title="Permalink to this definition">¶</a></dt> 5438 <dd><p>Registers a system wide hotkey. Every time the user presses the hotkey 5439 registered here, this window will receive a hotkey event. It will 5440 receive the event even if the application is in the background and 5441 does not have the input focus because the user is working with some 5442 other application. To bind an event handler function to this hotkey 5443 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the 5444 hotkey was registered successfully.</p> 5445 </dd></dl> 5446 5447 <dl class="method"> 5448 <dt id="sans.guiframe.gui_manager.ViewerFrame.ReleaseMouse"> 5449 <tt class="descname">ReleaseMouse</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ReleaseMouse" title="Permalink to this definition">¶</a></dt> 5450 <dd><p>Releases mouse input captured with wx.Window.CaptureMouse.</p> 5451 </dd></dl> 5452 5453 <dl class="method"> 5454 <dt id="sans.guiframe.gui_manager.ViewerFrame.RemoveChild"> 5455 <tt class="descname">RemoveChild</tt><big>(</big><em>self</em>, <em>Window child</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.RemoveChild" title="Permalink to this definition">¶</a></dt> 5456 <dd><p>Removes a child window. This is called automatically by window 5457 deletion functions so should not be required by the application 5458 programmer.</p> 5459 </dd></dl> 5460 5461 <dl class="method"> 5462 <dt id="sans.guiframe.gui_manager.ViewerFrame.RemoveEventHandler"> 5463 <tt class="descname">RemoveEventHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.RemoveEventHandler" title="Permalink to this definition">¶</a></dt> 5464 <dd><p>Find the given handler in the event handler chain and remove (but not 5465 delete) it from the event handler chain, returns True if it was found 5466 and False otherwise (this also results in an assert failure so this 5467 function should only be called when the handler is supposed to be 5468 there.)</p> 5469 </dd></dl> 5470 5471 <dl class="method"> 5472 <dt id="sans.guiframe.gui_manager.ViewerFrame.Reparent"> 5473 <tt class="descname">Reparent</tt><big>(</big><em>self</em>, <em>Window newParent</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Reparent" title="Permalink to this definition">¶</a></dt> 5474 <dd><p>Reparents the window, i.e the window will be removed from its current 5475 parent window (e.g. a non-standard toolbar in a wxFrame) and then 5476 re-inserted into another. Available on Windows and GTK. Returns True 5477 if the parent was changed, False otherwise (error or newParent == 5478 oldParent)</p> 5479 </dd></dl> 5480 5481 <dl class="method"> 5482 <dt id="sans.guiframe.gui_manager.ViewerFrame.RequestUserAttention"> 5483 <tt class="descname">RequestUserAttention</tt><big>(</big><em>self</em>, <em>int flags=USER_ATTENTION_INFO</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.RequestUserAttention" title="Permalink to this definition">¶</a></dt> 5484 <dd></dd></dl> 5485 5486 <dl class="method"> 5487 <dt id="sans.guiframe.gui_manager.ViewerFrame.Restore"> 5488 <tt class="descname">Restore</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Restore" title="Permalink to this definition">¶</a></dt> 5489 <dd></dd></dl> 5490 5491 <dl class="attribute"> 5492 <dt id="sans.guiframe.gui_manager.ViewerFrame.ScreenPosition"> 5493 <tt class="descname">ScreenPosition</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ScreenPosition" title="Permalink to this definition">¶</a></dt> 5494 <dd><p>See <cite>GetScreenPosition</cite></p> 5495 </dd></dl> 5496 5497 <dl class="attribute"> 5498 <dt id="sans.guiframe.gui_manager.ViewerFrame.ScreenRect"> 5499 <tt class="descname">ScreenRect</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ScreenRect" title="Permalink to this definition">¶</a></dt> 5500 <dd><p>See <cite>GetScreenRect</cite></p> 5501 </dd></dl> 5502 5503 <dl class="method"> 5504 <dt id="sans.guiframe.gui_manager.ViewerFrame.ScreenToClient"> 5505 <tt class="descname">ScreenToClient</tt><big>(</big><em>self</em>, <em>Point pt</em><big>)</big> → Point<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ScreenToClient" title="Permalink to this definition">¶</a></dt> 5506 <dd><p>Converts from screen to client window coordinates.</p> 5507 </dd></dl> 5508 5509 <dl class="method"> 5510 <dt id="sans.guiframe.gui_manager.ViewerFrame.ScreenToClientXY"> 5511 <tt class="descname">ScreenToClientXY</tt><big>(</big><em>int x</em>, <em>int y) -> (x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ScreenToClientXY" title="Permalink to this definition">¶</a></dt> 5512 <dd><p>Converts from screen to client window coordinates.</p> 5513 </dd></dl> 5514 5515 <dl class="method"> 5516 <dt id="sans.guiframe.gui_manager.ViewerFrame.ScrollLines"> 5517 <tt class="descname">ScrollLines</tt><big>(</big><em>self</em>, <em>int lines</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ScrollLines" title="Permalink to this definition">¶</a></dt> 5518 <dd><p>If the platform and window class supports it, scrolls the window by 5519 the given number of lines down, if lines is positive, or up if lines 5520 is negative. Returns True if the window was scrolled, False if it was 5521 already on top/bottom and nothing was done.</p> 5522 </dd></dl> 5523 5524 <dl class="method"> 5525 <dt id="sans.guiframe.gui_manager.ViewerFrame.ScrollPages"> 5526 <tt class="descname">ScrollPages</tt><big>(</big><em>self</em>, <em>int pages</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ScrollPages" title="Permalink to this definition">¶</a></dt> 5527 <dd><p>If the platform and window class supports it, scrolls the window by 5528 the given number of pages down, if pages is positive, or up if pages 5529 is negative. Returns True if the window was scrolled, False if it was 5530 already on top/bottom and nothing was done.</p> 5531 </dd></dl> 5532 5533 <dl class="method"> 5534 <dt id="sans.guiframe.gui_manager.ViewerFrame.ScrollWindow"> 5535 <tt class="descname">ScrollWindow</tt><big>(</big><em>self</em>, <em>int dx</em>, <em>int dy</em>, <em>Rect rect=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ScrollWindow" title="Permalink to this definition">¶</a></dt> 5536 <dd><p>Physically scrolls the pixels in the window and move child windows 5537 accordingly. Use this function to optimise your scrolling 5538 implementations, to minimise the area that must be redrawn. Note that 5539 it is rarely required to call this function from a user program.</p> 5540 </dd></dl> 5541 5542 <dl class="method"> 5543 <dt id="sans.guiframe.gui_manager.ViewerFrame.SendSizeEvent"> 5544 <tt class="descname">SendSizeEvent</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SendSizeEvent" title="Permalink to this definition">¶</a></dt> 5545 <dd></dd></dl> 5546 5547 <dl class="method"> 5548 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetAcceleratorTable"> 5549 <tt class="descname">SetAcceleratorTable</tt><big>(</big><em>self</em>, <em>AcceleratorTable accel</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetAcceleratorTable" title="Permalink to this definition">¶</a></dt> 5550 <dd><p>Sets the accelerator table for this window.</p> 5551 </dd></dl> 5552 5553 <dl class="method"> 5554 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetAutoLayout"> 5555 <tt class="descname">SetAutoLayout</tt><big>(</big><em>self</em>, <em>bool autoLayout</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetAutoLayout" title="Permalink to this definition">¶</a></dt> 5556 <dd><p>Determines whether the Layout function will be called automatically 5557 when the window is resized. lease note that this only happens for the 5558 windows usually used to contain children, namely <cite>wx.Panel</cite> and 5559 <cite>wx.TopLevelWindow</cite> (and the classes deriving from them).</p> 5560 <p>This method is called implicitly by <cite>SetSizer</cite> but if you use 5561 <cite>SetConstraints</cite> you should call it manually or otherwise the window 5562 layout won’t be correctly updated when its size changes.</p> 5563 </dd></dl> 5564 5565 <dl class="method"> 5566 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetBackgroundColour"> 5567 <tt class="descname">SetBackgroundColour</tt><big>(</big><em>self</em>, <em>Colour colour</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetBackgroundColour" title="Permalink to this definition">¶</a></dt> 5568 <dd><p>Sets the background colour of the window. Returns True if the colour 5569 was changed. The background colour is usually painted by the default 5570 EVT_ERASE_BACKGROUND event handler function under Windows and 5571 automatically under GTK. Using <cite>wx.NullColour</cite> will reset the window 5572 to the default background colour.</p> 5573 <p>Note that setting the background colour may not cause an immediate 5574 refresh, so you may wish to call <cite>ClearBackground</cite> or <cite>Refresh</cite> after 5575 calling this function.</p> 5576 <p>Using this function will disable attempts to use themes for this 5577 window, if the system supports them. Use with care since usually the 5578 themes represent the appearance chosen by the user to be used for all 5579 applications on the system.</p> 5580 </dd></dl> 5581 5582 <dl class="method"> 5583 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetBackgroundStyle"> 5584 <tt class="descname">SetBackgroundStyle</tt><big>(</big><em>self</em>, <em>int style</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetBackgroundStyle" title="Permalink to this definition">¶</a></dt> 5585 <dd><p>Returns the background style of the window. The background style 5586 indicates how the background of the window is drawn.</p> 5587 <blockquote> 5588 <div><table border="1" class="docutils"> 5589 <colgroup> 5590 <col width="35%" /> 5591 <col width="65%" /> 5592 </colgroup> 5593 <tbody valign="top"> 5594 <tr class="row-odd"><td>wx.BG_STYLE_SYSTEM</td> 5595 <td>The background colour or pattern should 5596 be determined by the system</td> 5597 </tr> 5598 <tr class="row-even"><td>wx.BG_STYLE_COLOUR</td> 5599 <td>The background should be a solid colour</td> 5600 </tr> 5601 <tr class="row-odd"><td>wx.BG_STYLE_CUSTOM</td> 5602 <td>The background will be implemented by the 5603 application.</td> 5604 </tr> 5605 </tbody> 5606 </table> 5607 </div></blockquote> 5608 <p>On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of 5609 a custom background, such as a tiled bitmap. Currently the style has 5610 no effect on other platforms.</p> 5611 <table class="docutils field-list" frame="void" rules="none"> 5612 <col class="field-name" /> 5613 <col class="field-body" /> 5614 <tbody valign="top"> 5615 <tr class="field-odd field"><th class="field-name">See :</th><td class="field-body"><cite>GetBackgroundStyle</cite>, <cite>SetBackgroundColour</cite></td> 5616 </tr> 5617 </tbody> 5618 </table> 5619 </dd></dl> 5620 5621 <dl class="method"> 5622 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetBestFittingSize"> 5623 <tt class="descname">SetBestFittingSize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetBestFittingSize" title="Permalink to this definition">¶</a></dt> 5624 <dd><p>Use <cite>SetInitialSize</cite></p> 5625 </dd></dl> 5626 5627 <dl class="method"> 5628 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetCaret"> 5629 <tt class="descname">SetCaret</tt><big>(</big><em>self</em>, <em>Caret caret</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetCaret" title="Permalink to this definition">¶</a></dt> 5630 <dd><p>Sets the caret associated with the window.</p> 5631 </dd></dl> 5632 5633 <dl class="method"> 5634 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetClientRect"> 5635 <tt class="descname">SetClientRect</tt><big>(</big><em>self</em>, <em>Rect rect</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetClientRect" title="Permalink to this definition">¶</a></dt> 5636 <dd><p>This sets the size of the window client area in pixels. Using this 5637 function to size a window tends to be more device-independent than 5638 wx.Window.SetSize, since the application need not worry about what 5639 dimensions the border or title bar have when trying to fit the window 5640 around panel items, for example.</p> 5641 </dd></dl> 5642 5643 <dl class="method"> 5644 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetClientSize"> 5645 <tt class="descname">SetClientSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetClientSize" title="Permalink to this definition">¶</a></dt> 5646 <dd><p>This sets the size of the window client area in pixels. Using this 5647 function to size a window tends to be more device-independent than 5648 wx.Window.SetSize, since the application need not worry about what 5649 dimensions the border or title bar have when trying to fit the window 5650 around panel items, for example.</p> 5651 </dd></dl> 5652 5653 <dl class="method"> 5654 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetClientSizeWH"> 5655 <tt class="descname">SetClientSizeWH</tt><big>(</big><em>self</em>, <em>int width</em>, <em>int height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetClientSizeWH" title="Permalink to this definition">¶</a></dt> 5656 <dd><p>This sets the size of the window client area in pixels. Using this 5657 function to size a window tends to be more device-independent than 5658 wx.Window.SetSize, since the application need not worry about what 5659 dimensions the border or title bar have when trying to fit the window 5660 around panel items, for example.</p> 5661 </dd></dl> 5662 5663 <dl class="method"> 5664 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetConstraints"> 5665 <tt class="descname">SetConstraints</tt><big>(</big><em>self</em>, <em>LayoutConstraints constraints</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetConstraints" title="Permalink to this definition">¶</a></dt> 5666 <dd><p>Sets the window to have the given layout constraints. If an existing 5667 layout constraints object is already owned by the window, it will be 5668 deleted. Pass None to disassociate and delete the window’s current 5669 constraints.</p> 5670 <p>You must call SetAutoLayout to tell a window to use the constraints 5671 automatically in its default EVT_SIZE handler; otherwise, you must 5672 handle EVT_SIZE yourself and call Layout() explicitly. When setting 5673 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have 5674 effect.</p> 5675 </dd></dl> 5676 5677 <dl class="method"> 5678 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetContainingSizer"> 5679 <tt class="descname">SetContainingSizer</tt><big>(</big><em>self</em>, <em>Sizer sizer</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetContainingSizer" title="Permalink to this definition">¶</a></dt> 5680 <dd><p>This normally does not need to be called by application code. It is 5681 called internally when a window is added to a sizer, and is used so 5682 the window can remove itself from the sizer when it is destroyed.</p> 5683 </dd></dl> 5684 5685 <dl class="method"> 5686 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetCursor"> 5687 <tt class="descname">SetCursor</tt><big>(</big><em>self</em>, <em>Cursor cursor</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetCursor" title="Permalink to this definition">¶</a></dt> 5688 <dd><p>Sets the window’s cursor. Notice that the window cursor also sets it 5689 for the children of the window implicitly.</p> 5690 <p>The cursor may be wx.NullCursor in which case the window cursor will 5691 be reset back to default.</p> 5692 </dd></dl> 5693 5694 <dl class="method"> 5695 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetDefaultItem"> 5696 <tt class="descname">SetDefaultItem</tt><big>(</big><em>self</em>, <em>Window child</em><big>)</big> → Window<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetDefaultItem" title="Permalink to this definition">¶</a></dt> 5697 <dd><p>Set this child as default, return the old default.</p> 5698 </dd></dl> 5699 5700 <dl class="method"> 5701 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetDimensions"> 5702 <tt class="descname">SetDimensions</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int y</em>, <em>int width</em>, <em>int height</em>, <em>int sizeFlags=SIZE_AUTO</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetDimensions" title="Permalink to this definition">¶</a></dt> 5703 <dd><p>Sets the position and size of the window in pixels. The sizeFlags 5704 parameter indicates the interpretation of the other params if they are 5705 equal to -1.</p> 5706 <blockquote> 5707 <div><table border="1" class="docutils"> 5708 <colgroup> 5709 <col width="39%" /> 5710 <col width="61%" /> 5711 </colgroup> 5712 <tbody valign="top"> 5713 <tr class="row-odd"><td>wx.SIZE_AUTO</td> 5714 <td>A -1 indicates that a class-specific 5715 default should be used.</td> 5716 </tr> 5717 <tr class="row-even"><td>wx.SIZE_USE_EXISTING</td> 5718 <td>Existing dimensions should be used if 5719 -1 values are supplied.</td> 5720 </tr> 5721 <tr class="row-odd"><td>wxSIZE_ALLOW_MINUS_ONE</td> 5722 <td>Allow dimensions of -1 and less to be 5723 interpreted as real dimensions, not 5724 default values.</td> 5725 </tr> 5726 </tbody> 5727 </table> 5728 </div></blockquote> 5729 </dd></dl> 5730 5731 <dl class="method"> 5732 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetDoubleBuffered"> 5733 <tt class="descname">SetDoubleBuffered</tt><big>(</big><em>self</em>, <em>bool on</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetDoubleBuffered" title="Permalink to this definition">¶</a></dt> 5734 <dd><p>Put the native window into double buffered or composited mode.</p> 5735 </dd></dl> 5736 5737 <dl class="method"> 5738 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetDropTarget"> 5739 <tt class="descname">SetDropTarget</tt><big>(</big><em>self</em>, <em>DropTarget dropTarget</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetDropTarget" title="Permalink to this definition">¶</a></dt> 5740 <dd><p>Associates a drop target with this window. If the window already has 5741 a drop target, it is deleted.</p> 5742 </dd></dl> 5743 5744 <dl class="method"> 5745 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetEventHandler"> 5746 <tt class="descname">SetEventHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetEventHandler" title="Permalink to this definition">¶</a></dt> 5747 <dd><p>Sets the event handler for this window. An event handler is an object 5748 that is capable of processing the events sent to a window. (In other 5749 words, is able to dispatch the events to handler function.) By 5750 default, the window is its own event handler, but an application may 5751 wish to substitute another, for example to allow central 5752 implementation of event-handling for a variety of different window 5753 classes.</p> 5754 <p>It is usually better to use <cite>wx.Window.PushEventHandler</cite> since this sets 5755 up a chain of event handlers, where an event not handled by one event 5756 handler is handed off to the next one in the chain.</p> 5757 </dd></dl> 5758 5759 <dl class="method"> 5760 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetEvtHandlerEnabled"> 5761 <tt class="descname">SetEvtHandlerEnabled</tt><big>(</big><em>self</em>, <em>bool enabled</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetEvtHandlerEnabled" title="Permalink to this definition">¶</a></dt> 5762 <dd></dd></dl> 5763 5764 <dl class="method"> 5765 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetExtraStyle"> 5766 <tt class="descname">SetExtraStyle</tt><big>(</big><em>self</em>, <em>long exStyle</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetExtraStyle" title="Permalink to this definition">¶</a></dt> 5767 <dd><p>Sets the extra style bits for the window. Extra styles are the less 5768 often used style bits which can’t be set with the constructor or with 5769 SetWindowStyleFlag()</p> 5770 </dd></dl> 5771 5772 <dl class="method"> 5773 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetFocus"> 5774 <tt class="descname">SetFocus</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetFocus" title="Permalink to this definition">¶</a></dt> 5775 <dd><p>Set’s the focus to this window, allowing it to receive keyboard input.</p> 5776 </dd></dl> 5777 5778 <dl class="method"> 5779 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetFocusFromKbd"> 5780 <tt class="descname">SetFocusFromKbd</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetFocusFromKbd" title="Permalink to this definition">¶</a></dt> 5781 <dd><p>Set focus to this window as the result of a keyboard action. Normally 5782 only called internally.</p> 5783 </dd></dl> 5784 5785 <dl class="method"> 5786 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetFont"> 5787 <tt class="descname">SetFont</tt><big>(</big><em>self</em>, <em>Font font</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetFont" title="Permalink to this definition">¶</a></dt> 5788 <dd><p>Sets the font for this window.</p> 5789 </dd></dl> 5790 5791 <dl class="method"> 5792 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetForegroundColour"> 5793 <tt class="descname">SetForegroundColour</tt><big>(</big><em>self</em>, <em>Colour colour</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetForegroundColour" title="Permalink to this definition">¶</a></dt> 5794 <dd><p>Sets the foreground colour of the window. Returns True is the colour 5795 was changed. The interpretation of foreground colour is dependent on 5796 the window class; it may be the text colour or other colour, or it may 5797 not be used at all.</p> 5798 </dd></dl> 5799 5800 <dl class="method"> 5801 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetHelpText"> 5802 <tt class="descname">SetHelpText</tt><big>(</big><em>self</em>, <em>String text</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetHelpText" title="Permalink to this definition">¶</a></dt> 5803 <dd><p>Sets the help text to be used as context-sensitive help for this 5804 window. Note that the text is actually stored by the current 5805 <cite>wx.HelpProvider</cite> implementation, and not in the window object itself.</p> 5806 </dd></dl> 5807 5808 <dl class="method"> 5809 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetHelpTextForId"> 5810 <tt class="descname">SetHelpTextForId</tt><big>(</big><em>self</em>, <em>String text</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetHelpTextForId" title="Permalink to this definition">¶</a></dt> 5811 <dd><p>Associate this help text with all windows with the same id as this 5812 one.</p> 5813 </dd></dl> 5814 5815 <dl class="method"> 5816 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetIcon"> 5817 <tt class="descname">SetIcon</tt><big>(</big><em>self</em>, <em>Icon icon</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetIcon" title="Permalink to this definition">¶</a></dt> 5818 <dd></dd></dl> 5819 5820 <dl class="method"> 5821 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetIcons"> 5822 <tt class="descname">SetIcons</tt><big>(</big><em>self</em>, <em>wxIconBundle icons</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetIcons" title="Permalink to this definition">¶</a></dt> 5823 <dd></dd></dl> 5824 5825 <dl class="method"> 5826 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetId"> 5827 <tt class="descname">SetId</tt><big>(</big><em>self</em>, <em>int winid</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetId" title="Permalink to this definition">¶</a></dt> 5828 <dd><p>Sets the identifier of the window. Each window has an integer 5829 identifier. If the application has not provided one, an identifier 5830 will be generated. Normally, the identifier should be provided on 5831 creation and should not be modified subsequently.</p> 5832 </dd></dl> 5833 5834 <dl class="method"> 5835 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetInitialSize"> 5836 <tt class="descname">SetInitialSize</tt><big>(</big><em>self</em>, <em>Size size=DefaultSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetInitialSize" title="Permalink to this definition">¶</a></dt> 5837 <dd><p>A ‘Smart’ SetSize that will fill in default size components with the 5838 window’s <em>best size</em> values. Also set’s the minsize for use with sizers.</p> 5839 </dd></dl> 5840 5841 <dl class="method"> 5842 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetLabel"> 5843 <tt class="descname">SetLabel</tt><big>(</big><em>self</em>, <em>String label</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetLabel" title="Permalink to this definition">¶</a></dt> 5844 <dd><p>Set the text which the window shows in its label if applicable.</p> 5845 </dd></dl> 5846 5847 <dl class="method"> 5848 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetLayoutDirection"> 5849 <tt class="descname">SetLayoutDirection</tt><big>(</big><em>self</em>, <em>int dir</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetLayoutDirection" title="Permalink to this definition">¶</a></dt> 5850 <dd><p>Set the layout direction (LTR or RTL) for this window.</p> 5851 </dd></dl> 5852 5853 <dl class="method"> 5854 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetMaxSize"> 5855 <tt class="descname">SetMaxSize</tt><big>(</big><em>self</em>, <em>Size maxSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetMaxSize" title="Permalink to this definition">¶</a></dt> 5856 <dd><p>A more convenient method than <cite>SetSizeHints</cite> for setting just the 5857 max size.</p> 5858 </dd></dl> 5859 5860 <dl class="method"> 5861 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetMenuBar"> 5862 <tt class="descname">SetMenuBar</tt><big>(</big><em>self</em>, <em>MenuBar menubar</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetMenuBar" title="Permalink to this definition">¶</a></dt> 5863 <dd></dd></dl> 5864 5865 <dl class="method"> 5866 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetMinSize"> 5867 <tt class="descname">SetMinSize</tt><big>(</big><em>self</em>, <em>Size minSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetMinSize" title="Permalink to this definition">¶</a></dt> 5868 <dd><p>A more convenient method than <cite>SetSizeHints</cite> for setting just the 5869 min size.</p> 5870 </dd></dl> 5871 5872 <dl class="method"> 5873 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetName"> 5874 <tt class="descname">SetName</tt><big>(</big><em>self</em>, <em>String name</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetName" title="Permalink to this definition">¶</a></dt> 5875 <dd><p>Sets the window’s name. The window name is used for ressource setting 5876 in X, it is not the same as the window title/label</p> 5877 </dd></dl> 5878 5879 <dl class="method"> 5880 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetNextHandler"> 5881 <tt class="descname">SetNextHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetNextHandler" title="Permalink to this definition">¶</a></dt> 5882 <dd></dd></dl> 5883 5884 <dl class="method"> 5885 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetOwnBackgroundColour"> 5886 <tt class="descname">SetOwnBackgroundColour</tt><big>(</big><em>self</em>, <em>Colour colour</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetOwnBackgroundColour" title="Permalink to this definition">¶</a></dt> 5887 <dd></dd></dl> 5888 5889 <dl class="method"> 5890 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetOwnFont"> 5891 <tt class="descname">SetOwnFont</tt><big>(</big><em>self</em>, <em>Font font</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetOwnFont" title="Permalink to this definition">¶</a></dt> 5892 <dd></dd></dl> 5893 5894 <dl class="method"> 5895 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetOwnForegroundColour"> 5896 <tt class="descname">SetOwnForegroundColour</tt><big>(</big><em>self</em>, <em>Colour colour</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetOwnForegroundColour" title="Permalink to this definition">¶</a></dt> 5897 <dd></dd></dl> 5898 5899 <dl class="method"> 5900 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetPosition"> 5901 <tt class="descname">SetPosition</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetPosition" title="Permalink to this definition">¶</a></dt> 5902 <dd><p>Move(self, Point pt, int flags=SIZE_USE_EXISTING)</p> 5903 <p>Moves the window to the given position.</p> 5904 </dd></dl> 5905 5906 <dl class="method"> 5907 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetPreviousHandler"> 5908 <tt class="descname">SetPreviousHandler</tt><big>(</big><em>self</em>, <em>EvtHandler handler</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetPreviousHandler" title="Permalink to this definition">¶</a></dt> 5909 <dd></dd></dl> 5910 5911 <dl class="method"> 5912 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetRect"> 5913 <tt class="descname">SetRect</tt><big>(</big><em>self</em>, <em>Rect rect</em>, <em>int sizeFlags=SIZE_AUTO</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetRect" title="Permalink to this definition">¶</a></dt> 5914 <dd><p>Sets the position and size of the window in pixels using a wx.Rect.</p> 5915 </dd></dl> 5916 5917 <dl class="method"> 5918 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetScrollPos"> 5919 <tt class="descname">SetScrollPos</tt><big>(</big><em>self</em>, <em>int orientation</em>, <em>int pos</em>, <em>bool refresh=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetScrollPos" title="Permalink to this definition">¶</a></dt> 5920 <dd><p>Sets the position of one of the built-in scrollbars.</p> 5921 </dd></dl> 5922 5923 <dl class="method"> 5924 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetScrollbar"> 5925 <tt class="descname">SetScrollbar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetScrollbar" title="Permalink to this definition">¶</a></dt> 5926 <dd><dl class="docutils"> 5927 <dt>SetScrollbar(self, int orientation, int position, int thumbSize, int range, </dt> 5928 <dd>bool refresh=True)</dd> 5929 </dl> 5930 <p>Sets the scrollbar properties of a built-in scrollbar.</p> 5931 </dd></dl> 5932 5933 <dl class="method"> 5934 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetShape"> 5935 <tt class="descname">SetShape</tt><big>(</big><em>self</em>, <em>Region region</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetShape" title="Permalink to this definition">¶</a></dt> 5936 <dd></dd></dl> 5937 5938 <dl class="method"> 5939 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetSize"> 5940 <tt class="descname">SetSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetSize" title="Permalink to this definition">¶</a></dt> 5941 <dd><p>Sets the size of the window in pixels.</p> 5942 </dd></dl> 5943 5944 <dl class="method"> 5945 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetSizeHints"> 5946 <tt class="descname">SetSizeHints</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetSizeHints" title="Permalink to this definition">¶</a></dt> 5947 <dd><dl class="docutils"> 5948 <dt>SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, </dt> 5949 <dd>int incH=-1)</dd> 5950 </dl> 5951 <p>Allows specification of minimum and maximum window sizes, and window 5952 size increments. If a pair of values is not set (or set to -1), the 5953 default values will be used. If this function is called, the user 5954 will not be able to size the window outside the given bounds (if it is 5955 a top-level window.) Sizers will also inspect the minimum window size 5956 and will use that value if set when calculating layout.</p> 5957 <p>The resizing increments are only significant under Motif or Xt.</p> 5958 </dd></dl> 5959 5960 <dl class="method"> 5961 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetSizeHintsSz"> 5962 <tt class="descname">SetSizeHintsSz</tt><big>(</big><em>self</em>, <em>Size minSize</em>, <em>Size maxSize=DefaultSize</em>, <em>Size incSize=DefaultSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetSizeHintsSz" title="Permalink to this definition">¶</a></dt> 5963 <dd><p>Allows specification of minimum and maximum window sizes, and window 5964 size increments. If a pair of values is not set (or set to -1), the 5965 default values will be used. If this function is called, the user 5966 will not be able to size the window outside the given bounds (if it is 5967 a top-level window.) Sizers will also inspect the minimum window size 5968 and will use that value if set when calculating layout.</p> 5969 <p>The resizing increments are only significant under Motif or Xt.</p> 5970 </dd></dl> 5971 5972 <dl class="method"> 5973 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetSizeWH"> 5974 <tt class="descname">SetSizeWH</tt><big>(</big><em>self</em>, <em>int width</em>, <em>int height</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetSizeWH" title="Permalink to this definition">¶</a></dt> 5975 <dd><p>Sets the size of the window in pixels.</p> 5976 </dd></dl> 5977 5978 <dl class="method"> 5979 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetSizer"> 5980 <tt class="descname">SetSizer</tt><big>(</big><em>self</em>, <em>Sizer sizer</em>, <em>bool deleteOld=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetSizer" title="Permalink to this definition">¶</a></dt> 5981 <dd><p>Sets the window to have the given layout sizer. The window will then 5982 own the object, and will take care of its deletion. If an existing 5983 layout sizer object is already owned by the window, it will be deleted 5984 if the deleteOld parameter is true. Note that this function will also 5985 call SetAutoLayout implicitly with a True parameter if the sizer is 5986 non-None, and False otherwise.</p> 5987 </dd></dl> 5988 5989 <dl class="method"> 5990 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetSizerAndFit"> 5991 <tt class="descname">SetSizerAndFit</tt><big>(</big><em>self</em>, <em>Sizer sizer</em>, <em>bool deleteOld=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetSizerAndFit" title="Permalink to this definition">¶</a></dt> 5992 <dd><p>The same as SetSizer, except it also sets the size hints for the 5993 window based on the sizer’s minimum size.</p> 5994 </dd></dl> 5995 5996 <dl class="method"> 5997 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetStatusBar"> 5998 <tt class="descname">SetStatusBar</tt><big>(</big><em>self</em>, <em>StatusBar statBar</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetStatusBar" title="Permalink to this definition">¶</a></dt> 5999 <dd></dd></dl> 6000 6001 <dl class="method"> 6002 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetStatusBarPane"> 6003 <tt class="descname">SetStatusBarPane</tt><big>(</big><em>self</em>, <em>int n</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetStatusBarPane" title="Permalink to this definition">¶</a></dt> 6004 <dd></dd></dl> 6005 6006 <dl class="method"> 6007 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetStatusText"> 6008 <tt class="descname">SetStatusText</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetStatusText" title="Permalink to this definition">¶</a></dt> 6009 <dd></dd></dl> 6010 6011 <dl class="method"> 6012 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetStatusWidths"> 6013 <tt class="descname">SetStatusWidths</tt><big>(</big><em>self</em>, <em>int widths</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetStatusWidths" title="Permalink to this definition">¶</a></dt> 6014 <dd></dd></dl> 6015 6016 <dl class="method"> 6017 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetThemeEnabled"> 6018 <tt class="descname">SetThemeEnabled</tt><big>(</big><em>self</em>, <em>bool enableTheme</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetThemeEnabled" title="Permalink to this definition">¶</a></dt> 6019 <dd><dl class="docutils"> 6020 <dt>This function tells a window if it should use the system’s “theme”</dt> 6021 <dd>code to draw the windows’ background instead if its own background 6022 drawing code. This will only have an effect on platforms that support 6023 the notion of themes in user defined windows. One such platform is 6024 GTK+ where windows can have (very colourful) backgrounds defined by a 6025 user’s selected theme.</dd> 6026 </dl> 6027 <p>Dialogs, notebook pages and the status bar have this flag set to true 6028 by default so that the default look and feel is simulated best.</p> 6029 </dd></dl> 6030 6031 <dl class="method"> 6032 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetTitle"> 6033 <tt class="descname">SetTitle</tt><big>(</big><em>self</em>, <em>String title</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetTitle" title="Permalink to this definition">¶</a></dt> 6034 <dd></dd></dl> 6035 6036 <dl class="method"> 6037 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetTmpDefaultItem"> 6038 <tt class="descname">SetTmpDefaultItem</tt><big>(</big><em>self</em>, <em>Window win</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetTmpDefaultItem" title="Permalink to this definition">¶</a></dt> 6039 <dd><p>Set this child as temporary default</p> 6040 </dd></dl> 6041 6042 <dl class="method"> 6043 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetToolBar"> 6044 <tt class="descname">SetToolBar</tt><big>(</big><em>self</em>, <em>wxToolBar toolbar</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetToolBar" title="Permalink to this definition">¶</a></dt> 6045 <dd></dd></dl> 6046 6047 <dl class="method"> 6048 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetToolTip"> 6049 <tt class="descname">SetToolTip</tt><big>(</big><em>self</em>, <em>ToolTip tip</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetToolTip" title="Permalink to this definition">¶</a></dt> 6050 <dd><p>Attach a tooltip to the window.</p> 6051 </dd></dl> 6052 6053 <dl class="method"> 6054 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetToolTipString"> 6055 <tt class="descname">SetToolTipString</tt><big>(</big><em>self</em>, <em>String tip</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetToolTipString" title="Permalink to this definition">¶</a></dt> 6056 <dd><p>Attach a tooltip to the window.</p> 6057 </dd></dl> 6058 6059 <dl class="method"> 6060 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetTransparent"> 6061 <tt class="descname">SetTransparent</tt><big>(</big><em>self</em>, <em>byte alpha</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetTransparent" title="Permalink to this definition">¶</a></dt> 6062 <dd><p>Attempt to set the transparency of this window to the <tt class="docutils literal"><span class="pre">alpha</span></tt> value, 6063 returns True on success. The <tt class="docutils literal"><span class="pre">alpha</span></tt> value is an integer in the 6064 range of 0 to 255, where 0 is fully transparent and 255 is fully 6065 opaque.</p> 6066 </dd></dl> 6067 6068 <dl class="method"> 6069 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetValidator"> 6070 <tt class="descname">SetValidator</tt><big>(</big><em>self</em>, <em>Validator validator</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetValidator" title="Permalink to this definition">¶</a></dt> 6071 <dd><p>Deletes the current validator (if any) and sets the window validator, 6072 having called wx.Validator.Clone to create a new validator of this 6073 type.</p> 6074 </dd></dl> 6075 6076 <dl class="method"> 6077 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetVirtualSize"> 6078 <tt class="descname">SetVirtualSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetVirtualSize" title="Permalink to this definition">¶</a></dt> 6079 <dd><p>Set the the virtual size of a window in pixels. For most windows this 6080 is just the client area of the window, but for some like scrolled 6081 windows it is more or less independent of the screen window size.</p> 6082 </dd></dl> 6083 6084 <dl class="method"> 6085 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetVirtualSizeHints"> 6086 <tt class="descname">SetVirtualSizeHints</tt><big>(</big><em>self</em>, <em>int minW</em>, <em>int minH</em>, <em>int maxW=-1</em>, <em>int maxH=-1</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetVirtualSizeHints" title="Permalink to this definition">¶</a></dt> 6087 <dd><p>Allows specification of minimum and maximum virtual window sizes. If a 6088 pair of values is not set (or set to -1), the default values will be 6089 used. If this function is called, the user will not be able to size 6090 the virtual area of the window outside the given bounds.</p> 6091 </dd></dl> 6092 6093 <dl class="method"> 6094 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetVirtualSizeHintsSz"> 6095 <tt class="descname">SetVirtualSizeHintsSz</tt><big>(</big><em>self</em>, <em>Size minSize</em>, <em>Size maxSize=DefaultSize</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetVirtualSizeHintsSz" title="Permalink to this definition">¶</a></dt> 6096 <dd><p>Allows specification of minimum and maximum virtual window sizes. If a 6097 pair of values is not set (or set to -1), the default values will be 6098 used. If this function is called, the user will not be able to size 6099 the virtual area of the window outside the given bounds.</p> 6100 </dd></dl> 6101 6102 <dl class="method"> 6103 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetVirtualSizeWH"> 6104 <tt class="descname">SetVirtualSizeWH</tt><big>(</big><em>self</em>, <em>int w</em>, <em>int h</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetVirtualSizeWH" title="Permalink to this definition">¶</a></dt> 6105 <dd><p>Set the the virtual size of a window in pixels. For most windows this 6106 is just the client area of the window, but for some like scrolled 6107 windows it is more or less independent of the screen window size.</p> 6108 </dd></dl> 6109 6110 <dl class="method"> 6111 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetWindowStyle"> 6112 <tt class="descname">SetWindowStyle</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetWindowStyle" title="Permalink to this definition">¶</a></dt> 6113 <dd><p>SetWindowStyleFlag(self, long style)</p> 6114 <p>Sets the style of the window. Please note that some styles cannot be 6115 changed after the window creation and that Refresh() might need to be 6116 called after changing the others for the change to take place 6117 immediately.</p> 6118 </dd></dl> 6119 6120 <dl class="method"> 6121 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetWindowStyleFlag"> 6122 <tt class="descname">SetWindowStyleFlag</tt><big>(</big><em>self</em>, <em>long style</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetWindowStyleFlag" title="Permalink to this definition">¶</a></dt> 6123 <dd><p>Sets the style of the window. Please note that some styles cannot be 6124 changed after the window creation and that Refresh() might need to be 6125 called after changing the others for the change to take place 6126 immediately.</p> 6127 </dd></dl> 6128 6129 <dl class="method"> 6130 <dt id="sans.guiframe.gui_manager.ViewerFrame.SetWindowVariant"> 6131 <tt class="descname">SetWindowVariant</tt><big>(</big><em>self</em>, <em>int variant</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.SetWindowVariant" title="Permalink to this definition">¶</a></dt> 6132 <dd><p>Sets the variant of the window/font size to use for this window, if 6133 the platform supports variants, for example, wxMac.</p> 6134 </dd></dl> 6135 6136 <dl class="method"> 6137 <dt id="sans.guiframe.gui_manager.ViewerFrame.ShouldInheritColours"> 6138 <tt class="descname">ShouldInheritColours</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ShouldInheritColours" title="Permalink to this definition">¶</a></dt> 6139 <dd><p>Return true from here to allow the colours of this window to be 6140 changed by InheritAttributes, returning false forbids inheriting them 6141 from the parent window.</p> 6142 <p>The base class version returns false, but this method is overridden in 6143 wxControl where it returns true.</p> 6144 </dd></dl> 6145 6146 <dl class="method"> 6147 <dt id="sans.guiframe.gui_manager.ViewerFrame.Show"> 6148 <tt class="descname">Show</tt><big>(</big><em>self</em>, <em>bool show=True</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Show" title="Permalink to this definition">¶</a></dt> 6149 <dd><p>Shows or hides the window. You may need to call Raise for a top level 6150 window if you want to bring it to top, although this is not needed if 6151 Show is called immediately after the frame creation. Returns True if 6152 the window has been shown or hidden or False if nothing was done 6153 because it already was in the requested state.</p> 6154 </dd></dl> 6155 6156 <dl class="method"> 6157 <dt id="sans.guiframe.gui_manager.ViewerFrame.ShowFullScreen"> 6158 <tt class="descname">ShowFullScreen</tt><big>(</big><em>self</em>, <em>bool show</em>, <em>long style=FULLSCREEN_ALL</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ShowFullScreen" title="Permalink to this definition">¶</a></dt> 6159 <dd></dd></dl> 6160 6161 <dl class="attribute"> 6162 <dt id="sans.guiframe.gui_manager.ViewerFrame.Shown"> 6163 <tt class="descname">Shown</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Shown" title="Permalink to this definition">¶</a></dt> 6164 <dd><p>See <cite>IsShown</cite> and <cite>Show</cite></p> 6165 </dd></dl> 6166 6167 <dl class="attribute"> 6168 <dt id="sans.guiframe.gui_manager.ViewerFrame.Size"> 6169 <tt class="descname">Size</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Size" title="Permalink to this definition">¶</a></dt> 6170 <dd><p>See <cite>GetSize</cite> and <cite>SetSize</cite></p> 6171 </dd></dl> 6172 6173 <dl class="attribute"> 6174 <dt id="sans.guiframe.gui_manager.ViewerFrame.Sizer"> 6175 <tt class="descname">Sizer</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Sizer" title="Permalink to this definition">¶</a></dt> 6176 <dd><p>See <cite>GetSizer</cite> and <cite>SetSizer</cite></p> 6177 </dd></dl> 6178 6179 <dl class="attribute"> 6180 <dt id="sans.guiframe.gui_manager.ViewerFrame.StatusBar"> 6181 <tt class="descname">StatusBar</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.StatusBar" title="Permalink to this definition">¶</a></dt> 6182 <dd><p>See <cite>GetStatusBar</cite> and <cite>SetStatusBar</cite></p> 6183 </dd></dl> 6184 6185 <dl class="attribute"> 6186 <dt id="sans.guiframe.gui_manager.ViewerFrame.StatusBarPane"> 6187 <tt class="descname">StatusBarPane</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.StatusBarPane" title="Permalink to this definition">¶</a></dt> 6188 <dd><p>See <cite>GetStatusBarPane</cite> and <cite>SetStatusBarPane</cite></p> 6189 </dd></dl> 6190 6191 <dl class="method"> 6192 <dt id="sans.guiframe.gui_manager.ViewerFrame.Thaw"> 6193 <tt class="descname">Thaw</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Thaw" title="Permalink to this definition">¶</a></dt> 6194 <dd><p>Reenables window updating after a previous call to Freeze. Calls to 6195 Freeze/Thaw may be nested, so Thaw must be called the same number of 6196 times that Freeze was before the window will be updated.</p> 6197 </dd></dl> 6198 6199 <dl class="attribute"> 6200 <dt id="sans.guiframe.gui_manager.ViewerFrame.ThemeEnabled"> 6201 <tt class="descname">ThemeEnabled</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ThemeEnabled" title="Permalink to this definition">¶</a></dt> 6202 <dd><p>See <cite>GetThemeEnabled</cite> and <cite>SetThemeEnabled</cite></p> 6203 </dd></dl> 6204 6205 <dl class="attribute"> 6206 <dt id="sans.guiframe.gui_manager.ViewerFrame.Title"> 6207 <tt class="descname">Title</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Title" title="Permalink to this definition">¶</a></dt> 6208 <dd><p>See <cite>GetTitle</cite> and <cite>SetTitle</cite></p> 6209 </dd></dl> 6210 6211 <dl class="attribute"> 6212 <dt id="sans.guiframe.gui_manager.ViewerFrame.TmpDefaultItem"> 6213 <tt class="descname">TmpDefaultItem</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.TmpDefaultItem" title="Permalink to this definition">¶</a></dt> 6214 <dd><p>See <cite>GetTmpDefaultItem</cite> and <cite>SetTmpDefaultItem</cite></p> 6215 </dd></dl> 6216 6217 <dl class="method"> 6218 <dt id="sans.guiframe.gui_manager.ViewerFrame.ToggleWindowStyle"> 6219 <tt class="descname">ToggleWindowStyle</tt><big>(</big><em>self</em>, <em>int flag</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ToggleWindowStyle" title="Permalink to this definition">¶</a></dt> 6220 <dd><p>Turn the flag on if it had been turned off before and vice versa, 6221 returns True if the flag is turned on by this function call.</p> 6222 </dd></dl> 6223 6224 <dl class="attribute"> 6225 <dt id="sans.guiframe.gui_manager.ViewerFrame.ToolBar"> 6226 <tt class="descname">ToolBar</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ToolBar" title="Permalink to this definition">¶</a></dt> 6227 <dd><p>See <cite>GetToolBar</cite> and <cite>SetToolBar</cite></p> 6228 </dd></dl> 6229 6230 <dl class="attribute"> 6231 <dt id="sans.guiframe.gui_manager.ViewerFrame.ToolTip"> 6232 <tt class="descname">ToolTip</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.ToolTip" title="Permalink to this definition">¶</a></dt> 6233 <dd><p>See <cite>GetToolTip</cite> and <cite>SetToolTip</cite></p> 6234 </dd></dl> 6235 6236 <dl class="attribute"> 6237 <dt id="sans.guiframe.gui_manager.ViewerFrame.TopLevel"> 6238 <tt class="descname">TopLevel</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.TopLevel" title="Permalink to this definition">¶</a></dt> 6239 <dd><p>See <cite>IsTopLevel</cite></p> 6240 </dd></dl> 6241 6242 <dl class="attribute"> 6243 <dt id="sans.guiframe.gui_manager.ViewerFrame.TopLevelParent"> 6244 <tt class="descname">TopLevelParent</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.TopLevelParent" title="Permalink to this definition">¶</a></dt> 6245 <dd><p>See <cite>GetTopLevelParent</cite></p> 6246 </dd></dl> 6247 6248 <dl class="method"> 6249 <dt id="sans.guiframe.gui_manager.ViewerFrame.TransferDataFromWindow"> 6250 <tt class="descname">TransferDataFromWindow</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.TransferDataFromWindow" title="Permalink to this definition">¶</a></dt> 6251 <dd><p>Transfers values from child controls to data areas specified by their 6252 validators. Returns false if a transfer failed. If the window has 6253 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will 6254 also call TransferDataFromWindow() of all child windows.</p> 6255 </dd></dl> 6256 6257 <dl class="method"> 6258 <dt id="sans.guiframe.gui_manager.ViewerFrame.TransferDataToWindow"> 6259 <tt class="descname">TransferDataToWindow</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.TransferDataToWindow" title="Permalink to this definition">¶</a></dt> 6260 <dd><p>Transfers values to child controls from data areas specified by their 6261 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra 6262 style flag set, the method will also call TransferDataToWindow() of 6263 all child windows.</p> 6264 </dd></dl> 6265 6266 <dl class="method"> 6267 <dt id="sans.guiframe.gui_manager.ViewerFrame.Unbind"> 6268 <tt class="descname">Unbind</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Unbind" title="Permalink to this definition">¶</a></dt> 6269 <dd><p>Disconnects the event handler binding for event from self. 6270 Returns True if successful.</p> 6271 </dd></dl> 6272 6273 <dl class="method"> 6274 <dt id="sans.guiframe.gui_manager.ViewerFrame.UnregisterHotKey"> 6275 <tt class="descname">UnregisterHotKey</tt><big>(</big><em>self</em>, <em>int hotkeyId</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.UnregisterHotKey" title="Permalink to this definition">¶</a></dt> 6276 <dd><p>Unregisters a system wide hotkey.</p> 6277 </dd></dl> 6278 6279 <dl class="method"> 6280 <dt id="sans.guiframe.gui_manager.ViewerFrame.Update"> 6281 <tt class="descname">Update</tt><big>(</big><em>self</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Update" title="Permalink to this definition">¶</a></dt> 6282 <dd><p>Calling this method immediately repaints the invalidated area of the 6283 window instead of waiting for the EVT_PAINT event to happen, (normally 6284 this would usually only happen when the flow of control returns to the 6285 event loop.) Notice that this function doesn’t refresh the window and 6286 does nothing if the window has been already repainted. Use <cite>Refresh</cite> 6287 first if you want to immediately redraw the window (or some portion of 6288 it) unconditionally.</p> 6289 </dd></dl> 6290 6291 <dl class="attribute"> 6292 <dt id="sans.guiframe.gui_manager.ViewerFrame.UpdateClientRect"> 6293 <tt class="descname">UpdateClientRect</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.UpdateClientRect" title="Permalink to this definition">¶</a></dt> 6294 <dd><p>See <cite>GetUpdateClientRect</cite></p> 6295 </dd></dl> 6296 6297 <dl class="attribute"> 6298 <dt id="sans.guiframe.gui_manager.ViewerFrame.UpdateRegion"> 6299 <tt class="descname">UpdateRegion</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.UpdateRegion" title="Permalink to this definition">¶</a></dt> 6300 <dd><p>See <cite>GetUpdateRegion</cite></p> 6301 </dd></dl> 6302 6303 <dl class="method"> 6304 <dt id="sans.guiframe.gui_manager.ViewerFrame.UpdateWindowUI"> 6305 <tt class="descname">UpdateWindowUI</tt><big>(</big><em>self</em>, <em>long flags=UPDATE_UI_NONE</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.UpdateWindowUI" title="Permalink to this definition">¶</a></dt> 6306 <dd><p>This function sends EVT_UPDATE_UI events to the window. The particular 6307 implementation depends on the window; for example a wx.ToolBar will 6308 send an update UI event for each toolbar button, and a wx.Frame will 6309 send an update UI event for each menubar menu item. You can call this 6310 function from your application to ensure that your UI is up-to-date at 6311 a particular point in time (as far as your EVT_UPDATE_UI handlers are 6312 concerned). This may be necessary if you have called 6313 <cite>wx.UpdateUIEvent.SetMode</cite> or <cite>wx.UpdateUIEvent.SetUpdateInterval</cite> to 6314 limit the overhead that wxWindows incurs by sending update UI events 6315 in idle time.</p> 6316 </dd></dl> 6317 6318 <dl class="method"> 6319 <dt id="sans.guiframe.gui_manager.ViewerFrame.UseBgCol"> 6320 <tt class="descname">UseBgCol</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.UseBgCol" title="Permalink to this definition">¶</a></dt> 6321 <dd></dd></dl> 6322 6323 <dl class="method"> 6324 <dt id="sans.guiframe.gui_manager.ViewerFrame.Validate"> 6325 <tt class="descname">Validate</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Validate" title="Permalink to this definition">¶</a></dt> 6326 <dd><p>Validates the current values of the child controls using their 6327 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra 6328 style flag set, the method will also call Validate() of all child 6329 windows. Returns false if any of the validations failed.</p> 6330 </dd></dl> 6331 6332 <dl class="attribute"> 6333 <dt id="sans.guiframe.gui_manager.ViewerFrame.Validator"> 6334 <tt class="descname">Validator</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.Validator" title="Permalink to this definition">¶</a></dt> 6335 <dd><p>See <cite>GetValidator</cite> and <cite>SetValidator</cite></p> 6336 </dd></dl> 6337 6338 <dl class="attribute"> 6339 <dt id="sans.guiframe.gui_manager.ViewerFrame.VirtualSize"> 6340 <tt class="descname">VirtualSize</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.VirtualSize" title="Permalink to this definition">¶</a></dt> 6341 <dd><p>See <cite>GetVirtualSize</cite> and <cite>SetVirtualSize</cite></p> 6342 </dd></dl> 6343 6344 <dl class="method"> 6345 <dt id="sans.guiframe.gui_manager.ViewerFrame.WarpPointer"> 6346 <tt class="descname">WarpPointer</tt><big>(</big><em>self</em>, <em>int x</em>, <em>int y</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.WarpPointer" title="Permalink to this definition">¶</a></dt> 6347 <dd><p>Moves the pointer to the given position on the window.</p> 6348 <p>NOTE: This function is not supported under Mac because Apple Human 6349 Interface Guidelines forbid moving the mouse cursor programmatically.</p> 6350 </dd></dl> 6351 6352 <dl class="attribute"> 6353 <dt id="sans.guiframe.gui_manager.ViewerFrame.WindowStyle"> 6354 <tt class="descname">WindowStyle</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.WindowStyle" title="Permalink to this definition">¶</a></dt> 6355 <dd><p>See <cite>GetWindowStyle</cite> and <cite>SetWindowStyle</cite></p> 6356 </dd></dl> 6357 6358 <dl class="attribute"> 6359 <dt id="sans.guiframe.gui_manager.ViewerFrame.WindowStyleFlag"> 6360 <tt class="descname">WindowStyleFlag</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.WindowStyleFlag" title="Permalink to this definition">¶</a></dt> 6361 <dd><p>See <cite>GetWindowStyleFlag</cite> and <cite>SetWindowStyleFlag</cite></p> 6362 </dd></dl> 6363 6364 <dl class="method"> 6365 <dt id="sans.guiframe.gui_manager.ViewerFrame.WindowToClientSize"> 6366 <tt class="descname">WindowToClientSize</tt><big>(</big><em>self</em>, <em>Size size</em><big>)</big> → Size<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.WindowToClientSize" title="Permalink to this definition">¶</a></dt> 6367 <dd></dd></dl> 6368 6369 <dl class="attribute"> 6370 <dt id="sans.guiframe.gui_manager.ViewerFrame.WindowVariant"> 6371 <tt class="descname">WindowVariant</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.WindowVariant" title="Permalink to this definition">¶</a></dt> 6372 <dd><p>See <cite>GetWindowVariant</cite> and <cite>SetWindowVariant</cite></p> 6373 </dd></dl> 6374 6375 <dl class="attribute"> 6376 <dt id="sans.guiframe.gui_manager.ViewerFrame.__class__"> 6377 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__class__" title="Permalink to this definition">¶</a></dt> 6378 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 6379 </dd></dl> 6380 6381 <dl class="attribute"> 6382 <dt id="sans.guiframe.gui_manager.ViewerFrame.__delattr__"> 6383 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__delattr__" title="Permalink to this definition">¶</a></dt> 6384 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 6385 </dd></dl> 6386 6387 <dl class="attribute"> 6388 <dt id="sans.guiframe.gui_manager.ViewerFrame.__dict__"> 6389 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x04D9B2F0></em><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__dict__" title="Permalink to this definition">¶</a></dt> 6390 <dd></dd></dl> 6391 6392 <dl class="attribute"> 6393 <dt id="sans.guiframe.gui_manager.ViewerFrame.__getattribute__"> 6394 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__getattribute__" title="Permalink to this definition">¶</a></dt> 6395 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 6396 </dd></dl> 6397 6398 <dl class="attribute"> 6399 <dt id="sans.guiframe.gui_manager.ViewerFrame.__hash__"> 6400 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__hash__" title="Permalink to this definition">¶</a></dt> 6401 <dd><p>x.__hash__() <==> hash(x)</p> 6402 </dd></dl> 6403 6404 <dl class="method"> 6405 <dt id="sans.guiframe.gui_manager.ViewerFrame.__init__"> 6406 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__init__" title="Permalink to this definition">¶</a></dt> 6407 <dd><p>Initialize the Frame object</p> 6408 </dd></dl> 6409 6410 <dl class="attribute"> 6411 <dt id="sans.guiframe.gui_manager.ViewerFrame.__module__"> 6412 <tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.gui_manager'</em><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__module__" title="Permalink to this definition">¶</a></dt> 6413 <dd></dd></dl> 6414 6415 <dl class="staticmethod"> 6416 <dt id="sans.guiframe.gui_manager.ViewerFrame.__new__"> 6417 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__new__" title="Permalink to this definition">¶</a></dt> 6418 <dd></dd></dl> 6419 6420 <dl class="method"> 6421 <dt id="sans.guiframe.gui_manager.ViewerFrame.__reduce__"> 6422 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__reduce__" title="Permalink to this definition">¶</a></dt> 6423 <dd><p>helper for pickle</p> 6424 </dd></dl> 6425 6426 <dl class="method"> 6427 <dt id="sans.guiframe.gui_manager.ViewerFrame.__reduce_ex__"> 6428 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 6429 <dd><p>helper for pickle</p> 6430 </dd></dl> 6431 6432 <dl class="method"> 6433 <dt id="sans.guiframe.gui_manager.ViewerFrame.__repr__"> 6434 <tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__repr__" title="Permalink to this definition">¶</a></dt> 6435 <dd></dd></dl> 6436 6437 <dl class="attribute"> 6438 <dt id="sans.guiframe.gui_manager.ViewerFrame.__setattr__"> 6439 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__setattr__" title="Permalink to this definition">¶</a></dt> 6440 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 6441 </dd></dl> 6442 6443 <dl class="attribute"> 6444 <dt id="sans.guiframe.gui_manager.ViewerFrame.__str__"> 6445 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__str__" title="Permalink to this definition">¶</a></dt> 6446 <dd><p>x.__str__() <==> str(x)</p> 6447 </dd></dl> 6448 6449 <dl class="attribute"> 6450 <dt id="sans.guiframe.gui_manager.ViewerFrame.__weakref__"> 6451 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.__weakref__" title="Permalink to this definition">¶</a></dt> 6452 <dd><p>list of weak references to the object (if defined)</p> 6453 </dd></dl> 6454 6455 <dl class="method"> 6456 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_current_plugin_menu"> 6457 <tt class="descname">_add_current_plugin_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_current_plugin_menu" title="Permalink to this definition">¶</a></dt> 6458 <dd><p>add current plugin menu 6459 Look for plug-in menus 6460 Add available plug-in sub-menus.</p> 6461 </dd></dl> 6462 6463 <dl class="method"> 6464 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_help_menu"> 6465 <tt class="descname">_add_help_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_help_menu" title="Permalink to this definition">¶</a></dt> 6466 <dd><p>add help menu</p> 6467 </dd></dl> 6468 6469 <dl class="method"> 6470 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_menu_application"> 6471 <tt class="descname">_add_menu_application</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_menu_application" title="Permalink to this definition">¶</a></dt> 6472 <dd><p># Attach a menu item for each defined perspective or application. 6473 # Only add the perspective menu if there are more than one perspectives 6474 add menu application</p> 6475 </dd></dl> 6476 6477 <dl class="method"> 6478 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_menu_data"> 6479 <tt class="descname">_add_menu_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_menu_data" title="Permalink to this definition">¶</a></dt> 6480 <dd><p>Add menu item item data to menu bar</p> 6481 </dd></dl> 6482 6483 <dl class="method"> 6484 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_menu_edit"> 6485 <tt class="descname">_add_menu_edit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_menu_edit" title="Permalink to this definition">¶</a></dt> 6486 <dd><p>add menu edit</p> 6487 </dd></dl> 6488 6489 <dl class="method"> 6490 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_menu_file"> 6491 <tt class="descname">_add_menu_file</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_menu_file" title="Permalink to this definition">¶</a></dt> 6492 <dd><p>add menu file</p> 6493 </dd></dl> 6494 6495 <dl class="method"> 6496 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_menu_tool"> 6497 <tt class="descname">_add_menu_tool</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_menu_tool" title="Permalink to this definition">¶</a></dt> 6498 <dd><p>Tools menu 6499 Go through plug-ins and find tools to populate the tools menu</p> 6500 </dd></dl> 6501 6502 <dl class="method"> 6503 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_menu_view"> 6504 <tt class="descname">_add_menu_view</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_menu_view" title="Permalink to this definition">¶</a></dt> 6505 <dd><p>add menu items under view menu</p> 6506 </dd></dl> 6507 6508 <dl class="method"> 6509 <dt id="sans.guiframe.gui_manager.ViewerFrame._add_menu_window"> 6510 <tt class="descname">_add_menu_window</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._add_menu_window" title="Permalink to this definition">¶</a></dt> 6511 <dd><p>add a menu window to the menu bar 6512 Window menu 6513 Attach a menu item for each panel in our 6514 panel list that also appears in a plug-in.</p> 6515 <p>Only add the panel menu if there is only one perspective and 6516 it has more than two panels. 6517 Note: the first plug-in is always the plotting plug-in. 6518 The first application 6519 #plug-in is always the second one in the list.</p> 6520 </dd></dl> 6521 6522 <dl class="method"> 6523 <dt id="sans.guiframe.gui_manager.ViewerFrame._check_applications_menu"> 6524 <tt class="descname">_check_applications_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._check_applications_menu" title="Permalink to this definition">¶</a></dt> 6525 <dd><p>check the menu of the current application</p> 6526 </dd></dl> 6527 6528 <dl class="method"> 6529 <dt id="sans.guiframe.gui_manager.ViewerFrame._check_update"> 6530 <tt class="descname">_check_update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._check_update" title="Permalink to this definition">¶</a></dt> 6531 <dd><p>Check with the deployment server whether a new version 6532 of the application is available. 6533 A thread is started for the connecting with the server. The thread calls 6534 a call-back method when the current version number has been obtained.</p> 6535 </dd></dl> 6536 6537 <dl class="method"> 6538 <dt id="sans.guiframe.gui_manager.ViewerFrame._find_plugins"> 6539 <tt class="descname">_find_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._find_plugins" title="Permalink to this definition">¶</a></dt> 6540 <dd><p>Find available perspective plug-ins</p> 6541 <table class="docutils field-list" frame="void" rules="none"> 6542 <col class="field-name" /> 6543 <col class="field-body" /> 6544 <tbody valign="top"> 6545 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dir</strong> – directory in which to look for plug-ins</td> 6546 </tr> 6547 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of plug-ins</td> 6548 </tr> 6549 </tbody> 6550 </table> 6551 </dd></dl> 6552 6553 <dl class="method"> 6554 <dt id="sans.guiframe.gui_manager.ViewerFrame._get_local_plugins"> 6555 <tt class="descname">_get_local_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._get_local_plugins" title="Permalink to this definition">¶</a></dt> 6556 <dd><p>get plugins local to guiframe and others</p> 6557 </dd></dl> 6558 6559 <dl class="method"> 6560 <dt id="sans.guiframe.gui_manager.ViewerFrame._get_panels_size"> 6561 <tt class="descname">_get_panels_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._get_panels_size" title="Permalink to this definition">¶</a></dt> 6562 <dd><p>find the proper size of the current panel 6563 get the proper panel width and height</p> 6564 </dd></dl> 6565 6566 <dl class="method"> 6567 <dt id="sans.guiframe.gui_manager.ViewerFrame._get_plotpanel_captions"> 6568 <tt class="descname">_get_plotpanel_captions</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._get_plotpanel_captions" title="Permalink to this definition">¶</a></dt> 6569 <dd><p>Get all the plotpanel cations</p> 6570 <p>: return: list of captions</p> 6571 </dd></dl> 6572 6573 <dl class="method"> 6574 <dt id="sans.guiframe.gui_manager.ViewerFrame._load_panels"> 6575 <tt class="descname">_load_panels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._load_panels" title="Permalink to this definition">¶</a></dt> 6576 <dd><p>Load all panels in the panels directory</p> 6577 </dd></dl> 6578 6579 <dl class="method"> 6580 <dt id="sans.guiframe.gui_manager.ViewerFrame._onAbout"> 6581 <tt class="descname">_onAbout</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._onAbout" title="Permalink to this definition">¶</a></dt> 6582 <dd><p>Pop up the about dialog</p> 6583 <table class="docutils field-list" frame="void" rules="none"> 6584 <col class="field-name" /> 6585 <col class="field-body" /> 6586 <tbody valign="top"> 6587 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>evt</strong> – menu event</td> 6588 </tr> 6589 </tbody> 6590 </table> 6591 </dd></dl> 6592 6593 <dl class="method"> 6594 <dt id="sans.guiframe.gui_manager.ViewerFrame._onDrawIdle"> 6595 <tt class="descname">_onDrawIdle</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._onDrawIdle" title="Permalink to this definition">¶</a></dt> 6596 <dd><p>ReDraw with axes</p> 6597 </dd></dl> 6598 6599 <dl class="method"> 6600 <dt id="sans.guiframe.gui_manager.ViewerFrame._onTutorial"> 6601 <tt class="descname">_onTutorial</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._onTutorial" title="Permalink to this definition">¶</a></dt> 6602 <dd><p>Pop up the tutorial dialog</p> 6603 <table class="docutils field-list" frame="void" rules="none"> 6604 <col class="field-name" /> 6605 <col class="field-body" /> 6606 <tbody valign="top"> 6607 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>evt</strong> – menu event</td> 6608 </tr> 6609 </tbody> 6610 </table> 6611 </dd></dl> 6612 6613 <dl class="method"> 6614 <dt id="sans.guiframe.gui_manager.ViewerFrame._on_open_state_app_helper"> 6615 <tt class="descname">_on_open_state_app_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._on_open_state_app_helper" title="Permalink to this definition">¶</a></dt> 6616 <dd><p>Helps ‘_on_open_state_application()’ to find the extension of 6617 the current perspective/application</p> 6618 </dd></dl> 6619 6620 <dl class="method"> 6621 <dt id="sans.guiframe.gui_manager.ViewerFrame._on_open_state_application"> 6622 <tt class="descname">_on_open_state_application</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._on_open_state_application" title="Permalink to this definition">¶</a></dt> 6623 <dd></dd></dl> 6624 6625 <dl class="method"> 6626 <dt id="sans.guiframe.gui_manager.ViewerFrame._on_open_state_project"> 6627 <tt class="descname">_on_open_state_project</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._on_open_state_project" title="Permalink to this definition">¶</a></dt> 6628 <dd></dd></dl> 6629 6630 <dl class="method"> 6631 <dt id="sans.guiframe.gui_manager.ViewerFrame._on_preference_menu"> 6632 <tt class="descname">_on_preference_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._on_preference_menu" title="Permalink to this definition">¶</a></dt> 6633 <dd><p>Build a panel to allow to edit Mask</p> 6634 </dd></dl> 6635 6636 <dl class="method"> 6637 <dt id="sans.guiframe.gui_manager.ViewerFrame._on_save_application"> 6638 <tt class="descname">_on_save_application</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._on_save_application" title="Permalink to this definition">¶</a></dt> 6639 <dd><p>save the state of the current active application</p> 6640 </dd></dl> 6641 6642 <dl class="method"> 6643 <dt id="sans.guiframe.gui_manager.ViewerFrame._on_save_project"> 6644 <tt class="descname">_on_save_project</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._on_save_project" title="Permalink to this definition">¶</a></dt> 6645 <dd><p>save the state of the SansView as <a href="#id1"><span class="problematic" id="id2">*</span></a>.svs</p> 6646 </dd></dl> 6647 6648 <dl class="method"> 6649 <dt id="sans.guiframe.gui_manager.ViewerFrame._on_status_event"> 6650 <tt class="descname">_on_status_event</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._on_status_event" title="Permalink to this definition">¶</a></dt> 6651 <dd><p>Display status message</p> 6652 </dd></dl> 6653 6654 <dl class="method"> 6655 <dt id="sans.guiframe.gui_manager.ViewerFrame._on_toggle_toolbar"> 6656 <tt class="descname">_on_toggle_toolbar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._on_toggle_toolbar" title="Permalink to this definition">¶</a></dt> 6657 <dd><p>hide or show toolbar</p> 6658 </dd></dl> 6659 6660 <dl class="method"> 6661 <dt id="sans.guiframe.gui_manager.ViewerFrame._populate_file_menu"> 6662 <tt class="descname">_populate_file_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._populate_file_menu" title="Permalink to this definition">¶</a></dt> 6663 <dd><p>Insert menu item under file menu</p> 6664 </dd></dl> 6665 6666 <dl class="method"> 6667 <dt id="sans.guiframe.gui_manager.ViewerFrame._popup_fixed_panel"> 6668 <tt class="descname">_popup_fixed_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._popup_fixed_panel" title="Permalink to this definition">¶</a></dt> 6669 <dd></dd></dl> 6670 6671 <dl class="method"> 6672 <dt id="sans.guiframe.gui_manager.ViewerFrame._popup_floating_panel"> 6673 <tt class="descname">_popup_floating_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._popup_floating_panel" title="Permalink to this definition">¶</a></dt> 6674 <dd></dd></dl> 6675 6676 <dl class="method"> 6677 <dt id="sans.guiframe.gui_manager.ViewerFrame._process_version"> 6678 <tt class="descname">_process_version</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._process_version" title="Permalink to this definition">¶</a></dt> 6679 <dd><p>Call-back method for the process of checking for updates. 6680 This methods is called by a VersionThread object once the current 6681 version number has been obtained. If the check is being done in the 6682 background, the user will not be notified unless there’s an update.</p> 6683 <table class="docutils field-list" frame="void" rules="none"> 6684 <col class="field-name" /> 6685 <col class="field-body" /> 6686 <tbody valign="top"> 6687 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 6688 <li><strong>version</strong> – version string</li> 6689 <li><strong>standalone</strong> – True of the update is being checked in 6690 the background, False otherwise.</li> 6691 </ul> 6692 </td> 6693 </tr> 6694 </tbody> 6695 </table> 6696 </dd></dl> 6697 6698 <dl class="method"> 6699 <dt id="sans.guiframe.gui_manager.ViewerFrame._redraw_idle"> 6700 <tt class="descname">_redraw_idle</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._redraw_idle" title="Permalink to this definition">¶</a></dt> 6701 <dd><p>Restart Idle</p> 6702 </dd></dl> 6703 6704 <dl class="method"> 6705 <dt id="sans.guiframe.gui_manager.ViewerFrame._remove_res_plot"> 6706 <tt class="descname">_remove_res_plot</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._remove_res_plot" title="Permalink to this definition">¶</a></dt> 6707 <dd><p>Try to remove corresponding res plot</p> 6708 <p>: param id: id of the data</p> 6709 </dd></dl> 6710 6711 <dl class="method"> 6712 <dt id="sans.guiframe.gui_manager.ViewerFrame._setOORInfo"> 6713 <tt class="descname">_setOORInfo</tt><big>(</big><em>self</em>, <em>PyObject _self</em>, <em>bool incref=True</em><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._setOORInfo" title="Permalink to this definition">¶</a></dt> 6714 <dd></dd></dl> 6715 6716 <dl class="method"> 6717 <dt id="sans.guiframe.gui_manager.ViewerFrame._set_title_name"> 6718 <tt class="descname">_set_title_name</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._set_title_name" title="Permalink to this definition">¶</a></dt> 6719 <dd><p>Set the SansView title w/ the current application name</p> 6720 <p>: param name: application name [string]</p> 6721 </dd></dl> 6722 6723 <dl class="method"> 6724 <dt id="sans.guiframe.gui_manager.ViewerFrame._setup_extra_custom"> 6725 <tt class="descname">_setup_extra_custom</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._setup_extra_custom" title="Permalink to this definition">¶</a></dt> 6726 <dd><p>Set up toolbar and welcome view if needed</p> 6727 </dd></dl> 6728 6729 <dl class="method"> 6730 <dt id="sans.guiframe.gui_manager.ViewerFrame._setup_layout"> 6731 <tt class="descname">_setup_layout</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._setup_layout" title="Permalink to this definition">¶</a></dt> 6732 <dd><p>Set up the layout</p> 6733 </dd></dl> 6734 6735 <dl class="method"> 6736 <dt id="sans.guiframe.gui_manager.ViewerFrame._setup_menus"> 6737 <tt class="descname">_setup_menus</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._setup_menus" title="Permalink to this definition">¶</a></dt> 6738 <dd><p>Set up the application menus</p> 6739 </dd></dl> 6740 6741 <dl class="method"> 6742 <dt id="sans.guiframe.gui_manager.ViewerFrame._setup_tool_bar"> 6743 <tt class="descname">_setup_tool_bar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._setup_tool_bar" title="Permalink to this definition">¶</a></dt> 6744 <dd><p>add toolbar to the frame</p> 6745 </dd></dl> 6746 6747 <dl class="method"> 6748 <dt id="sans.guiframe.gui_manager.ViewerFrame._update_toolbar_helper"> 6749 <tt class="descname">_update_toolbar_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame._update_toolbar_helper" title="Permalink to this definition">¶</a></dt> 6750 <dd></dd></dl> 6751 6752 <dl class="method"> 6753 <dt id="sans.guiframe.gui_manager.ViewerFrame.add_data"> 6754 <tt class="descname">add_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.add_data" title="Permalink to this definition">¶</a></dt> 6755 <dd><p>receive a dictionary of data from loader 6756 store them its data manager if possible 6757 send to data the current active perspective if the data panel 6758 is not active. 6759 :param data_list: dictionary of data’s ID and value Data</p> 6760 </dd></dl> 6761 6762 <dl class="method"> 6763 <dt id="sans.guiframe.gui_manager.ViewerFrame.add_data_helper"> 6764 <tt class="descname">add_data_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.add_data_helper" title="Permalink to this definition">¶</a></dt> 6765 <dd></dd></dl> 6766 6767 <dl class="method"> 6768 <dt id="sans.guiframe.gui_manager.ViewerFrame.add_icon"> 6769 <tt class="descname">add_icon</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.add_icon" title="Permalink to this definition">¶</a></dt> 6770 <dd><p>get list of child and attempt to add the default icon</p> 6771 </dd></dl> 6772 6773 <dl class="method"> 6774 <dt id="sans.guiframe.gui_manager.ViewerFrame.add_perspective"> 6775 <tt class="descname">add_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.add_perspective" title="Permalink to this definition">¶</a></dt> 6776 <dd><p>Add a perspective if it doesn’t already 6777 exist.</p> 6778 </dd></dl> 6779 6780 <dl class="method"> 6781 <dt id="sans.guiframe.gui_manager.ViewerFrame.append_bookmark"> 6782 <tt class="descname">append_bookmark</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.append_bookmark" title="Permalink to this definition">¶</a></dt> 6783 <dd><p>Bookmark available information of the panel on focus</p> 6784 </dd></dl> 6785 6786 <dl class="method"> 6787 <dt id="sans.guiframe.gui_manager.ViewerFrame.build_gui"> 6788 <tt class="descname">build_gui</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.build_gui" title="Permalink to this definition">¶</a></dt> 6789 <dd></dd></dl> 6790 6791 <dl class="method"> 6792 <dt id="sans.guiframe.gui_manager.ViewerFrame.check_multimode"> 6793 <tt class="descname">check_multimode</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.check_multimode" title="Permalink to this definition">¶</a></dt> 6794 <dd><p>Check the perspective have batch mode capablitity</p> 6795 </dd></dl> 6796 6797 <dl class="method"> 6798 <dt id="sans.guiframe.gui_manager.ViewerFrame.clear_panel"> 6799 <tt class="descname">clear_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.clear_panel" title="Permalink to this definition">¶</a></dt> 6800 <dd></dd></dl> 6801 6802 <dl class="method"> 6803 <dt id="sans.guiframe.gui_manager.ViewerFrame.create_gui_data"> 6804 <tt class="descname">create_gui_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.create_gui_data" title="Permalink to this definition">¶</a></dt> 6805 <dd></dd></dl> 6806 6807 <dl class="method"> 6808 <dt id="sans.guiframe.gui_manager.ViewerFrame.delete_data"> 6809 <tt class="descname">delete_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.delete_data" title="Permalink to this definition">¶</a></dt> 6810 <dd></dd></dl> 6811 6812 <dl class="method"> 6813 <dt id="sans.guiframe.gui_manager.ViewerFrame.delete_panel"> 6814 <tt class="descname">delete_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.delete_panel" title="Permalink to this definition">¶</a></dt> 6815 <dd><p>delete panel given uid</p> 6816 </dd></dl> 6817 6818 <dl class="method"> 6819 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_add_data"> 6820 <tt class="descname">enable_add_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_add_data" title="Permalink to this definition">¶</a></dt> 6821 <dd><p>Enable append data on a plot panel</p> 6822 </dd></dl> 6823 6824 <dl class="method"> 6825 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_bookmark"> 6826 <tt class="descname">enable_bookmark</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_bookmark" title="Permalink to this definition">¶</a></dt> 6827 <dd><p>Bookmark</p> 6828 </dd></dl> 6829 6830 <dl class="method"> 6831 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_copy"> 6832 <tt class="descname">enable_copy</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_copy" title="Permalink to this definition">¶</a></dt> 6833 <dd><p>enable copy related control</p> 6834 </dd></dl> 6835 6836 <dl class="method"> 6837 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_drag"> 6838 <tt class="descname">enable_drag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_drag" title="Permalink to this definition">¶</a></dt> 6839 <dd><p>drag</p> 6840 </dd></dl> 6841 6842 <dl class="method"> 6843 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_edit_menu"> 6844 <tt class="descname">enable_edit_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_edit_menu" title="Permalink to this definition">¶</a></dt> 6845 <dd><p>enable menu item under edit menu depending on the panel on focus</p> 6846 </dd></dl> 6847 6848 <dl class="method"> 6849 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_paste"> 6850 <tt class="descname">enable_paste</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_paste" title="Permalink to this definition">¶</a></dt> 6851 <dd><p>enable paste</p> 6852 </dd></dl> 6853 6854 <dl class="method"> 6855 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_preview"> 6856 <tt class="descname">enable_preview</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_preview" title="Permalink to this definition">¶</a></dt> 6857 <dd><p>preview</p> 6858 </dd></dl> 6859 6860 <dl class="method"> 6861 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_print"> 6862 <tt class="descname">enable_print</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_print" title="Permalink to this definition">¶</a></dt> 6863 <dd><p>print</p> 6864 </dd></dl> 6865 6866 <dl class="method"> 6867 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_redo"> 6868 <tt class="descname">enable_redo</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_redo" title="Permalink to this definition">¶</a></dt> 6869 <dd><p>enable redo</p> 6870 </dd></dl> 6871 6872 <dl class="method"> 6873 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_reset"> 6874 <tt class="descname">enable_reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_reset" title="Permalink to this definition">¶</a></dt> 6875 <dd><p>reset the current panel</p> 6876 </dd></dl> 6877 6878 <dl class="method"> 6879 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_save"> 6880 <tt class="descname">enable_save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_save" title="Permalink to this definition">¶</a></dt> 6881 <dd><p>save</p> 6882 </dd></dl> 6883 6884 <dl class="method"> 6885 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_undo"> 6886 <tt class="descname">enable_undo</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_undo" title="Permalink to this definition">¶</a></dt> 6887 <dd><p>enable undo related control</p> 6888 </dd></dl> 6889 6890 <dl class="method"> 6891 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_zoom"> 6892 <tt class="descname">enable_zoom</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_zoom" title="Permalink to this definition">¶</a></dt> 6893 <dd><p>zoom</p> 6894 </dd></dl> 6895 6896 <dl class="method"> 6897 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_zoom_in"> 6898 <tt class="descname">enable_zoom_in</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_zoom_in" title="Permalink to this definition">¶</a></dt> 6899 <dd><p>zoom in</p> 6900 </dd></dl> 6901 6902 <dl class="method"> 6903 <dt id="sans.guiframe.gui_manager.ViewerFrame.enable_zoom_out"> 6904 <tt class="descname">enable_zoom_out</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.enable_zoom_out" title="Permalink to this definition">¶</a></dt> 6905 <dd><p>zoom out</p> 6906 </dd></dl> 6907 6908 <dl class="method"> 6909 <dt id="sans.guiframe.gui_manager.ViewerFrame.freeze"> 6910 <tt class="descname">freeze</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.freeze" title="Permalink to this definition">¶</a></dt> 6911 <dd></dd></dl> 6912 6913 <dl class="method"> 6914 <dt id="sans.guiframe.gui_manager.ViewerFrame.full_draw"> 6915 <tt class="descname">full_draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.full_draw" title="Permalink to this definition">¶</a></dt> 6916 <dd><p>Draw the panels with axes in the schedule to full dwar list</p> 6917 </dd></dl> 6918 6919 <dl class="method"> 6920 <dt id="sans.guiframe.gui_manager.ViewerFrame.get_context_menu"> 6921 <tt class="descname">get_context_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.get_context_menu" title="Permalink to this definition">¶</a></dt> 6922 <dd><p>Get the context menu items made available 6923 by the different plug-ins. 6924 This function is used by the plotting module</p> 6925 </dd></dl> 6926 6927 <dl class="method"> 6928 <dt id="sans.guiframe.gui_manager.ViewerFrame.get_current_perspective"> 6929 <tt class="descname">get_current_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.get_current_perspective" title="Permalink to this definition">¶</a></dt> 6930 <dd><p>return the current perspective</p> 6931 </dd></dl> 6932 6933 <dl class="method"> 6934 <dt id="sans.guiframe.gui_manager.ViewerFrame.get_data"> 6935 <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.get_data" title="Permalink to this definition">¶</a></dt> 6936 <dd></dd></dl> 6937 6938 <dl class="method"> 6939 <dt id="sans.guiframe.gui_manager.ViewerFrame.get_data_manager"> 6940 <tt class="descname">get_data_manager</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.get_data_manager" title="Permalink to this definition">¶</a></dt> 6941 <dd></dd></dl> 6942 6943 <dl class="method"> 6944 <dt id="sans.guiframe.gui_manager.ViewerFrame.get_paneinfo"> 6945 <tt class="descname">get_paneinfo</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.get_paneinfo" title="Permalink to this definition">¶</a></dt> 6946 <dd><p>Get pane Caption from window_name</p> 6947 <table class="docutils field-list" frame="void" rules="none"> 6948 <col class="field-name" /> 6949 <col class="field-body" /> 6950 <tbody valign="top"> 6951 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – window_name in AuiPaneInfo</td> 6952 </tr> 6953 </tbody> 6954 </table> 6955 <p>: return: AuiPaneInfo of the name</p> 6956 </dd></dl> 6957 6958 <dl class="method"> 6959 <dt id="sans.guiframe.gui_manager.ViewerFrame.get_schedule"> 6960 <tt class="descname">get_schedule</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.get_schedule" title="Permalink to this definition">¶</a></dt> 6961 <dd><p>Get schedule</p> 6962 </dd></dl> 6963 6964 <dl class="method"> 6965 <dt id="sans.guiframe.gui_manager.ViewerFrame.get_style"> 6966 <tt class="descname">get_style</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.get_style" title="Permalink to this definition">¶</a></dt> 6967 <dd></dd></dl> 6968 6969 <dl class="method"> 6970 <dt id="sans.guiframe.gui_manager.ViewerFrame.get_toolbar"> 6971 <tt class="descname">get_toolbar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.get_toolbar" title="Permalink to this definition">¶</a></dt> 6972 <dd></dd></dl> 6973 6974 <dl class="method"> 6975 <dt id="sans.guiframe.gui_manager.ViewerFrame.hide_all_plotpanels"> 6976 <tt class="descname">hide_all_plotpanels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.hide_all_plotpanels" title="Permalink to this definition">¶</a></dt> 6977 <dd><p>Hide all plotpanels shown</p> 6978 <table class="docutils field-list" frame="void" rules="none"> 6979 <col class="field-name" /> 6980 <col class="field-body" /> 6981 <tbody valign="top"> 6982 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – menu event</td> 6983 </tr> 6984 </tbody> 6985 </table> 6986 </dd></dl> 6987 6988 <dl class="method"> 6989 <dt id="sans.guiframe.gui_manager.ViewerFrame.hide_panel"> 6990 <tt class="descname">hide_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.hide_panel" title="Permalink to this definition">¶</a></dt> 6991 <dd><p>hide panel except default panel</p> 6992 </dd></dl> 6993 6994 <dl class="method"> 6995 <dt id="sans.guiframe.gui_manager.ViewerFrame.load_data"> 6996 <tt class="descname">load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.load_data" title="Permalink to this definition">¶</a></dt> 6997 <dd><p>load data from command line</p> 6998 </dd></dl> 6999 7000 <dl class="method"> 7001 <dt id="sans.guiframe.gui_manager.ViewerFrame.load_folder"> 7002 <tt class="descname">load_folder</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.load_folder" title="Permalink to this definition">¶</a></dt> 7003 <dd><p>Load entire folder</p> 7004 </dd></dl> 7005 7006 <dl class="method"> 7007 <dt id="sans.guiframe.gui_manager.ViewerFrame.load_from_cmd"> 7008 <tt class="descname">load_from_cmd</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.load_from_cmd" title="Permalink to this definition">¶</a></dt> 7009 <dd><p>load data from cmd or application</p> 7010 </dd></dl> 7011 7012 <dl class="method"> 7013 <dt id="sans.guiframe.gui_manager.ViewerFrame.load_state"> 7014 <tt class="descname">load_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.load_state" title="Permalink to this definition">¶</a></dt> 7015 <dd><p>load data from command line or application</p> 7016 </dd></dl> 7017 7018 <dl class="method"> 7019 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_batch_selection"> 7020 <tt class="descname">on_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_batch_selection" title="Permalink to this definition">¶</a></dt> 7021 <dd><table class="docutils field-list" frame="void" rules="none"> 7022 <col class="field-name" /> 7023 <col class="field-body" /> 7024 <tbody valign="top"> 7025 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – contains parameter enable . when enable is set to True</td> 7026 </tr> 7027 </tbody> 7028 </table> 7029 <p>the application is in Batch mode 7030 else the application is default mode(single mode)</p> 7031 </dd></dl> 7032 7033 <dl class="method"> 7034 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_bookmark_panel"> 7035 <tt class="descname">on_bookmark_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_bookmark_panel" title="Permalink to this definition">¶</a></dt> 7036 <dd><p>bookmark panel</p> 7037 </dd></dl> 7038 7039 <dl class="method"> 7040 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_change_caption"> 7041 <tt class="descname">on_change_caption</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_change_caption" title="Permalink to this definition">¶</a></dt> 7042 <dd><p>Change the panel caption</p> 7043 <table class="docutils field-list" frame="void" rules="none"> 7044 <col class="field-name" /> 7045 <col class="field-body" /> 7046 <tbody valign="top"> 7047 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 7048 <li><strong>name</strong> – window_name of the pane</li> 7049 <li><strong>old_caption</strong> – current caption [string]</li> 7050 <li><strong>new_caption</strong> – new caption [string]</li> 7051 </ul> 7052 </td> 7053 </tr> 7054 </tbody> 7055 </table> 7056 </dd></dl> 7057 7058 <dl class="method"> 7059 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_cleanup_dock"> 7060 <tt class="descname">on_cleanup_dock</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_cleanup_dock" title="Permalink to this definition">¶</a></dt> 7061 <dd><p>Set Cleanup Dock option</p> 7062 </dd></dl> 7063 7064 <dl class="method"> 7065 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_close_welcome_panel"> 7066 <tt class="descname">on_close_welcome_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_close_welcome_panel" title="Permalink to this definition">¶</a></dt> 7067 <dd><p>Close the welcome panel</p> 7068 </dd></dl> 7069 7070 <dl class="method"> 7071 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_color_selection"> 7072 <tt class="descname">on_color_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_color_selection" title="Permalink to this definition">¶</a></dt> 7073 <dd><table class="docutils field-list" frame="void" rules="none"> 7074 <col class="field-name" /> 7075 <col class="field-body" /> 7076 <tbody valign="top"> 7077 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – contains parameters for id and color</td> 7078 </tr> 7079 </tbody> 7080 </table> 7081 </dd></dl> 7082 7083 <dl class="method"> 7084 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_copy_panel"> 7085 <tt class="descname">on_copy_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_copy_panel" title="Permalink to this definition">¶</a></dt> 7086 <dd><p>copy the last panel on focus if possible</p> 7087 </dd></dl> 7088 7089 <dl class="method"> 7090 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_drag_panel"> 7091 <tt class="descname">on_drag_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_drag_panel" title="Permalink to this definition">¶</a></dt> 7092 <dd><p>drag apply to the panel on focus</p> 7093 </dd></dl> 7094 7095 <dl class="method"> 7096 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_load_data"> 7097 <tt class="descname">on_load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_load_data" title="Permalink to this definition">¶</a></dt> 7098 <dd><p>received an event to trigger load from data plugin</p> 7099 </dd></dl> 7100 7101 <dl class="method"> 7102 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_paste_panel"> 7103 <tt class="descname">on_paste_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_paste_panel" title="Permalink to this definition">¶</a></dt> 7104 <dd><p>paste clipboard to the last panel on focus</p> 7105 </dd></dl> 7106 7107 <dl class="method"> 7108 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_preview_panel"> 7109 <tt class="descname">on_preview_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_preview_panel" title="Permalink to this definition">¶</a></dt> 7110 <dd><p>preview information on the panel on focus</p> 7111 </dd></dl> 7112 7113 <dl class="method"> 7114 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_print_panel"> 7115 <tt class="descname">on_print_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_print_panel" title="Permalink to this definition">¶</a></dt> 7116 <dd><p>print available information on the last panel on focus</p> 7117 </dd></dl> 7118 7119 <dl class="method"> 7120 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_read_batch_tofile"> 7121 <tt class="descname">on_read_batch_tofile</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_read_batch_tofile" title="Permalink to this definition">¶</a></dt> 7122 <dd><p>Open a file dialog , extract the file to read and display values 7123 into a grid</p> 7124 </dd></dl> 7125 7126 <dl class="method"> 7127 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_redo_panel"> 7128 <tt class="descname">on_redo_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_redo_panel" title="Permalink to this definition">¶</a></dt> 7129 <dd><p>redo the last cancel action done on the last panel on focus</p> 7130 </dd></dl> 7131 7132 <dl class="method"> 7133 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_reset_panel"> 7134 <tt class="descname">on_reset_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_reset_panel" title="Permalink to this definition">¶</a></dt> 7135 <dd><p>reset the current panel</p> 7136 </dd></dl> 7137 7138 <dl class="method"> 7139 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_save_helper"> 7140 <tt class="descname">on_save_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_save_helper" title="Permalink to this definition">¶</a></dt> 7141 <dd><p>Save state into a file</p> 7142 </dd></dl> 7143 7144 <dl class="method"> 7145 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_save_panel"> 7146 <tt class="descname">on_save_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_save_panel" title="Permalink to this definition">¶</a></dt> 7147 <dd><p>save possible information on the current panel</p> 7148 </dd></dl> 7149 7150 <dl class="method"> 7151 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_set_batch_result"> 7152 <tt class="descname">on_set_batch_result</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_set_batch_result" title="Permalink to this definition">¶</a></dt> 7153 <dd><p>Display data into a grid in batch mode and show the grid</p> 7154 </dd></dl> 7155 7156 <dl class="method"> 7157 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_set_plot_focus"> 7158 <tt class="descname">on_set_plot_focus</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_set_plot_focus" title="Permalink to this definition">¶</a></dt> 7159 <dd><p>Set focus on a plot panel</p> 7160 </dd></dl> 7161 7162 <dl class="method"> 7163 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_undo_panel"> 7164 <tt class="descname">on_undo_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_undo_panel" title="Permalink to this definition">¶</a></dt> 7165 <dd><p>undo previous action of the last panel on focus if possible</p> 7166 </dd></dl> 7167 7168 <dl class="method"> 7169 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_view"> 7170 <tt class="descname">on_view</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_view" title="Permalink to this definition">¶</a></dt> 7171 <dd><p>A panel was selected to be shown. If it’s not already 7172 shown, display it.</p> 7173 <table class="docutils field-list" frame="void" rules="none"> 7174 <col class="field-name" /> 7175 <col class="field-body" /> 7176 <tbody valign="top"> 7177 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>evt</strong> – menu event</td> 7178 </tr> 7179 </tbody> 7180 </table> 7181 </dd></dl> 7182 7183 <dl class="method"> 7184 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_zoom_in_panel"> 7185 <tt class="descname">on_zoom_in_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_zoom_in_panel" title="Permalink to this definition">¶</a></dt> 7186 <dd><p>zoom in of the panel on focus</p> 7187 </dd></dl> 7188 7189 <dl class="method"> 7190 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_zoom_out_panel"> 7191 <tt class="descname">on_zoom_out_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_zoom_out_panel" title="Permalink to this definition">¶</a></dt> 7192 <dd><p>zoom out on the panel on focus</p> 7193 </dd></dl> 7194 7195 <dl class="method"> 7196 <dt id="sans.guiframe.gui_manager.ViewerFrame.on_zoom_panel"> 7197 <tt class="descname">on_zoom_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.on_zoom_panel" title="Permalink to this definition">¶</a></dt> 7198 <dd><p>zoom on the current panel if possible</p> 7199 </dd></dl> 7200 7201 <dl class="method"> 7202 <dt id="sans.guiframe.gui_manager.ViewerFrame.onfreeze"> 7203 <tt class="descname">onfreeze</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.onfreeze" title="Permalink to this definition">¶</a></dt> 7204 <dd></dd></dl> 7205 7206 <dl class="method"> 7207 <dt id="sans.guiframe.gui_manager.ViewerFrame.open_with_externalapp"> 7208 <tt class="descname">open_with_externalapp</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.open_with_externalapp" title="Permalink to this definition">¶</a></dt> 7209 <dd><p>Display data in the another application , by default Excel</p> 7210 </dd></dl> 7211 7212 <dl class="method"> 7213 <dt id="sans.guiframe.gui_manager.ViewerFrame.open_with_localapp"> 7214 <tt class="descname">open_with_localapp</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.open_with_localapp" title="Permalink to this definition">¶</a></dt> 7215 <dd><p>Display value of data into the application grid 7216 :param data: dictionary of string and list of items</p> 7217 </dd></dl> 7218 7219 <dl class="method"> 7220 <dt id="sans.guiframe.gui_manager.ViewerFrame.plot_data"> 7221 <tt class="descname">plot_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.plot_data" title="Permalink to this definition">¶</a></dt> 7222 <dd><p>send a list of data to plot</p> 7223 </dd></dl> 7224 7225 <dl class="method"> 7226 <dt id="sans.guiframe.gui_manager.ViewerFrame.popup_panel"> 7227 <tt class="descname">popup_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.popup_panel" title="Permalink to this definition">¶</a></dt> 7228 <dd><p>Add a panel object to the AUI manager</p> 7229 <table class="docutils field-list" frame="void" rules="none"> 7230 <col class="field-name" /> 7231 <col class="field-body" /> 7232 <tbody valign="top"> 7233 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>p</strong> – panel object to add to the AUI manager</td> 7234 </tr> 7235 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the event associated with the new panel [int]</td> 7236 </tr> 7237 </tbody> 7238 </table> 7239 </dd></dl> 7240 7241 <dl class="method"> 7242 <dt id="sans.guiframe.gui_manager.ViewerFrame.post_init"> 7243 <tt class="descname">post_init</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.post_init" title="Permalink to this definition">¶</a></dt> 7244 <dd><p>This initialization method is called after the GUI 7245 has been created and all plug-ins loaded. It calls 7246 the post_init() method of each plug-in (if it exists) 7247 so that final initialization can be done.</p> 7248 </dd></dl> 7249 7250 <dl class="method"> 7251 <dt id="sans.guiframe.gui_manager.ViewerFrame.quit_guiframe"> 7252 <tt class="descname">quit_guiframe</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.quit_guiframe" title="Permalink to this definition">¶</a></dt> 7253 <dd><p>Pop up message to make sure the user wants to quit the application</p> 7254 </dd></dl> 7255 7256 <dl class="method"> 7257 <dt id="sans.guiframe.gui_manager.ViewerFrame.read_batch_tofile"> 7258 <tt class="descname">read_batch_tofile</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.read_batch_tofile" title="Permalink to this definition">¶</a></dt> 7259 <dd><p>Extract value from file name and Display them into a grid</p> 7260 </dd></dl> 7261 7262 <dl class="method"> 7263 <dt id="sans.guiframe.gui_manager.ViewerFrame.remove_data"> 7264 <tt class="descname">remove_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.remove_data" title="Permalink to this definition">¶</a></dt> 7265 <dd><p>Delete data state if data_id is provide 7266 delete theory created with data of id data_id if theory_id is provide 7267 if delete all true: delete the all state 7268 else delete theory</p> 7269 </dd></dl> 7270 7271 <dl class="method"> 7272 <dt id="sans.guiframe.gui_manager.ViewerFrame.reset_bookmark_menu"> 7273 <tt class="descname">reset_bookmark_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.reset_bookmark_menu" title="Permalink to this definition">¶</a></dt> 7274 <dd><p>Reset Bookmark menu list</p> 7275 <p>: param panel: a control panel or tap where the bookmark is</p> 7276 </dd></dl> 7277 7278 <dl class="method"> 7279 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_current_perspective"> 7280 <tt class="descname">set_current_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_current_perspective" title="Permalink to this definition">¶</a></dt> 7281 <dd><p>set the current active perspective</p> 7282 </dd></dl> 7283 7284 <dl class="method"> 7285 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_custom_default_perspective"> 7286 <tt class="descname">set_custom_default_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_custom_default_perspective" title="Permalink to this definition">¶</a></dt> 7287 <dd><p>Set default starting perspective</p> 7288 </dd></dl> 7289 7290 <dl class="method"> 7291 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_data"> 7292 <tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_data" title="Permalink to this definition">¶</a></dt> 7293 <dd><p>set data to current perspective</p> 7294 </dd></dl> 7295 7296 <dl class="method"> 7297 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_default_perspective"> 7298 <tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_default_perspective" title="Permalink to this definition">¶</a></dt> 7299 <dd><p>Choose among the plugin the first plug-in that has 7300 “set_default_perspective” method and its return value is True will be 7301 as a default perspective when the welcome page is closed</p> 7302 </dd></dl> 7303 7304 <dl class="method"> 7305 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_input_file"> 7306 <tt class="descname">set_input_file</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_input_file" title="Permalink to this definition">¶</a></dt> 7307 <dd><table class="docutils field-list" frame="void" rules="none"> 7308 <col class="field-name" /> 7309 <col class="field-body" /> 7310 <tbody valign="top"> 7311 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>input_file</strong> – file to read</td> 7312 </tr> 7313 </tbody> 7314 </table> 7315 </dd></dl> 7316 7317 <dl class="method"> 7318 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_manager"> 7319 <tt class="descname">set_manager</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_manager" title="Permalink to this definition">¶</a></dt> 7320 <dd><p>Sets the application manager for this frame</p> 7321 <table class="docutils field-list" frame="void" rules="none"> 7322 <col class="field-name" /> 7323 <col class="field-body" /> 7324 <tbody valign="top"> 7325 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>manager</strong> – frame manager</td> 7326 </tr> 7327 </tbody> 7328 </table> 7329 </dd></dl> 7330 7331 <dl class="method"> 7332 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_panel_on_focus"> 7333 <tt class="descname">set_panel_on_focus</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_panel_on_focus" title="Permalink to this definition">¶</a></dt> 7334 <dd><p>Store reference to the last panel on focus 7335 update the toolbar if available 7336 update edit menu if available</p> 7337 </dd></dl> 7338 7339 <dl class="method"> 7340 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_panel_on_focus_helper"> 7341 <tt class="descname">set_panel_on_focus_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_panel_on_focus_helper" title="Permalink to this definition">¶</a></dt> 7342 <dd><p>Helper for panel on focus with data_panel</p> 7343 </dd></dl> 7344 7345 <dl class="method"> 7346 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_perspective"> 7347 <tt class="descname">set_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_perspective" title="Permalink to this definition">¶</a></dt> 7348 <dd><p>Sets the perspective of the GUI. 7349 Opens all the panels in the list, and closes 7350 all the others.</p> 7351 <table class="docutils field-list" frame="void" rules="none"> 7352 <col class="field-name" /> 7353 <col class="field-body" /> 7354 <tbody valign="top"> 7355 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>panels</strong> – list of panels</td> 7356 </tr> 7357 </tbody> 7358 </table> 7359 </dd></dl> 7360 7361 <dl class="method"> 7362 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_plot_unfocus"> 7363 <tt class="descname">set_plot_unfocus</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_plot_unfocus" title="Permalink to this definition">¶</a></dt> 7364 <dd><p>Un focus all plot panels</p> 7365 </dd></dl> 7366 7367 <dl class="method"> 7368 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_plotpanel_fixed"> 7369 <tt class="descname">set_plotpanel_fixed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_plotpanel_fixed" title="Permalink to this definition">¶</a></dt> 7370 <dd><p>make the plot panel fixed</p> 7371 </dd></dl> 7372 7373 <dl class="method"> 7374 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_plotpanel_floating"> 7375 <tt class="descname">set_plotpanel_floating</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_plotpanel_floating" title="Permalink to this definition">¶</a></dt> 7376 <dd><p>make the plot panel floatable</p> 7377 </dd></dl> 7378 7379 <dl class="method"> 7380 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_schedule"> 7381 <tt class="descname">set_schedule</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_schedule" title="Permalink to this definition">¶</a></dt> 7382 <dd><p>Set schedule</p> 7383 </dd></dl> 7384 7385 <dl class="method"> 7386 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_schedule_full_draw"> 7387 <tt class="descname">set_schedule_full_draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_schedule_full_draw" title="Permalink to this definition">¶</a></dt> 7388 <dd><p>Add/subtract the schedule full draw list with the panel given</p> 7389 <table class="docutils field-list" frame="void" rules="none"> 7390 <col class="field-name" /> 7391 <col class="field-body" /> 7392 <tbody valign="top"> 7393 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 7394 <li><strong>panel</strong> – plot panel</li> 7395 <li><strong>func</strong> – append or del [string]</li> 7396 </ul> 7397 </td> 7398 </tr> 7399 </tbody> 7400 </table> 7401 </dd></dl> 7402 7403 <dl class="method"> 7404 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_theory"> 7405 <tt class="descname">set_theory</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_theory" title="Permalink to this definition">¶</a></dt> 7406 <dd></dd></dl> 7407 7408 <dl class="method"> 7409 <dt id="sans.guiframe.gui_manager.ViewerFrame.set_welcome_panel"> 7410 <tt class="descname">set_welcome_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.set_welcome_panel" title="Permalink to this definition">¶</a></dt> 7411 <dd><p>Sets the default panel as the given welcome panel</p> 7412 <table class="docutils field-list" frame="void" rules="none"> 7413 <col class="field-name" /> 7414 <col class="field-body" /> 7415 <tbody valign="top"> 7416 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>panel_class</strong> – class of the welcome panel to be instantiated</td> 7417 </tr> 7418 </tbody> 7419 </table> 7420 </dd></dl> 7421 7422 <dl class="method"> 7423 <dt id="sans.guiframe.gui_manager.ViewerFrame.setup_custom_conf"> 7424 <tt class="descname">setup_custom_conf</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.setup_custom_conf" title="Permalink to this definition">¶</a></dt> 7425 <dd><p>Set up custom configuration if exists</p> 7426 </dd></dl> 7427 7428 <dl class="method"> 7429 <dt id="sans.guiframe.gui_manager.ViewerFrame.show_all_plotpanels"> 7430 <tt class="descname">show_all_plotpanels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.show_all_plotpanels" title="Permalink to this definition">¶</a></dt> 7431 <dd><p>Show all plotpanels shown</p> 7432 <table class="docutils field-list" frame="void" rules="none"> 7433 <col class="field-name" /> 7434 <col class="field-body" /> 7435 <tbody valign="top"> 7436 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – menu event</td> 7437 </tr> 7438 </tbody> 7439 </table> 7440 </dd></dl> 7441 7442 <dl class="method"> 7443 <dt id="sans.guiframe.gui_manager.ViewerFrame.show_batch_frame"> 7444 <tt class="descname">show_batch_frame</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.show_batch_frame" title="Permalink to this definition">¶</a></dt> 7445 <dd><p>show the grid of result</p> 7446 </dd></dl> 7447 7448 <dl class="method"> 7449 <dt id="sans.guiframe.gui_manager.ViewerFrame.show_data_panel"> 7450 <tt class="descname">show_data_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.show_data_panel" title="Permalink to this definition">¶</a></dt> 7451 <dd><p>show the data panel</p> 7452 </dd></dl> 7453 7454 <dl class="method"> 7455 <dt id="sans.guiframe.gui_manager.ViewerFrame.show_panel"> 7456 <tt class="descname">show_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.show_panel" title="Permalink to this definition">¶</a></dt> 7457 <dd><p>Shows the panel with the given id</p> 7458 <table class="docutils field-list" frame="void" rules="none"> 7459 <col class="field-name" /> 7460 <col class="field-body" /> 7461 <tbody valign="top"> 7462 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>uid</strong> – unique ID number of the panel to show</td> 7463 </tr> 7464 </tbody> 7465 </table> 7466 </dd></dl> 7467 7468 <dl class="method"> 7469 <dt id="sans.guiframe.gui_manager.ViewerFrame.show_welcome_panel"> 7470 <tt class="descname">show_welcome_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.show_welcome_panel" title="Permalink to this definition">¶</a></dt> 7471 <dd><p>Display the welcome panel</p> 7472 </dd></dl> 7473 7474 <dl class="attribute"> 7475 <dt id="sans.guiframe.gui_manager.ViewerFrame.thisown"> 7476 <tt class="descname">thisown</tt><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.thisown" title="Permalink to this definition">¶</a></dt> 7477 <dd><p>The membership flag</p> 7478 </dd></dl> 7479 7480 <dl class="method"> 7481 <dt id="sans.guiframe.gui_manager.ViewerFrame.update_data"> 7482 <tt class="descname">update_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.update_data" title="Permalink to this definition">¶</a></dt> 7483 <dd></dd></dl> 7484 7485 <dl class="method"> 7486 <dt id="sans.guiframe.gui_manager.ViewerFrame.update_theory"> 7487 <tt class="descname">update_theory</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.update_theory" title="Permalink to this definition">¶</a></dt> 7488 <dd></dd></dl> 7489 7490 <dl class="method"> 7491 <dt id="sans.guiframe.gui_manager.ViewerFrame.write_batch_tofile"> 7492 <tt class="descname">write_batch_tofile</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager.ViewerFrame.write_batch_tofile" title="Permalink to this definition">¶</a></dt> 7493 <dd><p>Helper to write result from batch into cvs file</p> 7494 </dd></dl> 7495 7496 </dd></dl> 7497 7498 <dl class="function"> 7499 <dt id="sans.guiframe.gui_manager._change_current_dir"> 7500 <tt class="descclassname">sans.guiframe.gui_manager.</tt><tt class="descname">_change_current_dir</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager._change_current_dir" title="Permalink to this definition">¶</a></dt> 7501 <dd><p>Get the path of the current ran file and change the application current 7502 directory to the directory of that file</p> 7503 </dd></dl> 7504 7505 <dl class="function"> 7506 <dt id="sans.guiframe.gui_manager._find_local_config"> 7507 <tt class="descclassname">sans.guiframe.gui_manager.</tt><tt class="descname">_find_local_config</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.gui_manager._find_local_config" title="Permalink to this definition">¶</a></dt> 7508 <dd><p>Find configuration file for the current application</p> 7509 </dd></dl> 7510 60 7511 </div> 61 7512 </div> … … 89 7540 <h3>Quick search</h3> 90 7541 <form class="search" action="../search.html" method="get"> 91 <input type="text" name="q" size="18"/>7542 <input type="text" name="q" /> 92 7543 <input type="submit" value="Go" /> 93 7544 <input type="hidden" name="check_keywords" value="yes" /> … … 118 7569 <a href="events.html" title="events" 119 7570 >previous</a> |</li> 120 <li><a href="../index.html">guiframe v0.1.0 documentation</a> »</li>7571 <li><a href="../index.html">guiframe 0.1.0 documentation</a> »</li> 121 7572 <li><a href="index.html" >Reference</a> »</li> 122 7573 </ul> … … 124 7575 <div class="footer"> 125 7576 © Copyright 2010, sans group. 126 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.7577 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 127 7578 </div> 128 7579 </body>
Note: See TracChangeset
for help on using the changeset viewer.