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