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