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