1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.buttonpanel
.. highlight:: python
.. _wx.lib.agw.buttonpanel.ButtonInfo:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.buttonpanel.ButtonInfo**
==========================================================================================================================================
This class holds information about every button that is added to
:class:`ButtonPanel`. It is an auxiliary class that you should use
every time you add a button.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ButtonInfo</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.agw.buttonpanel.ButtonInfo_inheritance.png" alt="Inheritance diagram of ButtonInfo" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="65,83,176,112"/> <area shape="rect" id="node4" href="wx.lib.agw.buttonpanel.Control.html" title="wx.lib.agw.buttonpanel.Control" alt="" coords="14,160,228,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="23,5,104,35"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="129,5,231,35"/> <area shape="rect" id="node5" href="wx.lib.agw.buttonpanel.ButtonInfo.html" title="wx.lib.agw.buttonpanel.ButtonInfo" alt="" coords="4,237,237,267"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.buttonpanel.Control`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.__init__` Default class constructor.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.AddStatus` Add a programmer-defined status in addition to the 5 default status
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.CheckRefresh` Checks whether a :class:`ButtonPanel` repaint is needed or not. This is a convenience function.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.Draw` Draws the button on :class:`ButtonPanel`. Actually the drawing is done in :class:`BPArt`.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.Enable` Enables/disables this instance of :class:`ButtonInfo`.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetBestSize` Returns the best size for the button.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetBitmap` Returns the bitmap associated with this instance of :class:`ButtonInfo`.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetId` Returns the :class:`ButtonInfo` id.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetKind` Returns the button type (standard or toggle).
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetLongHelp` Returns the help string shown in the statusbar.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetRect` Returns the :class:`ButtonInfo` client rectangle.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetShortHelp` Returns the help string shown in a tooltip.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetStatus` Returns the :class:`ButtonInfo` status.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetText` Returns the text associated to the button.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetTextAlignment` Returns the text alignment in the button (bottom or right).
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.GetToggled` Returns whether a ``wx.ITEM_CHECK`` button is toggled or not.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.HasText` Returns whether the button has text or not.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.IsEnabled` Returns ``True`` if this instance of :class:`ButtonInfo` is enabled for input,
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetBitmap` Sets the bitmap associated with this instance of :class:`ButtonInfo`.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetId` Sets the :class:`ButtonInfo` identifier.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetKind` Sets the button type (standard or toggle).
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetLongHelp` Sets the help string to be shown in the statusbar.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetRect` Sets the :class:`ButtonInfo` client rectangle.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetShortHelp` Sets the help string to be shown in a tooltip.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetStatus` Sets the :class:`ButtonInfo` status.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetText` Sets the button label text.
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetTextAlignment` Sets the text alignment in the button (bottom or right).
:meth:`~wx.lib.agw.buttonpanel.ButtonInfo.SetToggled` Sets a ``wx.ITEM_CHECK`` button toggled/not toggled.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.lib.agw.buttonpanel.ButtonInfo.Bitmap` Returns the bitmap associated with this instance of :class:`ButtonInfo`.
:attr:`~wx.lib.agw.buttonpanel.ButtonInfo.Id` Returns the :class:`ButtonInfo` id.
:attr:`~wx.lib.agw.buttonpanel.ButtonInfo.Rect` Returns the :class:`ButtonInfo` client rectangle.
:attr:`~wx.lib.agw.buttonpanel.ButtonInfo.Status` Returns the :class:`ButtonInfo` status.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ButtonInfo(Control)
This class holds information about every button that is added to
:class:`ButtonPanel`. It is an auxiliary class that you should use
every time you add a button.
.. method:: __init__(self, parent, id=wx.ID_ANY, bmp=wx.NullBitmap, status="Normal", text="", kind=wx.ITEM_NORMAL, shortHelp="", longHelp="")
Default class constructor.
:param `parent`: the parent window (:class:`ButtonPanel`);
:param integer `id`: the button id;
:param wx.Bitmap `bmp`: the associated bitmap;
:param string `status`: button status ("Pressed", "Hover", "Normal", "Toggled", "Disabled");
:param string `text`: text to be displayed either below of to the right of the button;
:param integer `kind`: button kind, may be ``wx.ITEM_NORMAL`` for standard buttons or
``wx.ITEM_CHECK`` for toggle buttons;
:param string `shortHelp`: a short help to be shown in the button tooltip;
:param string `longHelp`: this string is shown in the statusbar (if any) of the parent
frame when the mouse pointer is inside the button.
.. method:: AddStatus(self, name="Custom", bmp=wx.NullBitmap)
Add a programmer-defined status in addition to the 5 default status:
- Normal;
- Disabled;
- Hover;
- Pressed;
- Toggled.
:param string `name`: the new status name;
:param wx.Bitmap `bmp`: the bitmap associated with the new status.
.. method:: CheckRefresh(self, status)
Checks whether a :class:`ButtonPanel` repaint is needed or not. This is a convenience function.
:param bool `status`: the status of a newly added :class:`ButtonInfo` or a change in the
:class:`ButtonInfo` status.
.. method:: Draw(self, dc, rect)
Draws the button on :class:`ButtonPanel`. Actually the drawing is done in :class:`BPArt`.
:param `dc`: an instance of :class:`wx.DC`;
:param wx.Rect `rect`: the main caption text client rectangle.
.. method:: Enable(self, enable=True)
Enables/disables this instance of :class:`ButtonInfo`.
:param bool `enable`: ``True`` to enable the button, ``False`` otherwise.
.. method:: GetBestSize(self)
Returns the best size for the button.
:return: An instance of :class:`wx.Size`.
.. method:: GetBitmap(self, status=None)
Returns the bitmap associated with this instance of :class:`ButtonInfo`.
:param string `status`: the :class:`ButtonInfo` status ("Pressed", "Hover", "Normal",
"Toggled", "Disabled").
:return: An instance of :class:`wx.Bitmap`.
.. method:: GetId(self)
Returns the :class:`ButtonInfo` id.
:return: An integer representing the button id.
.. method:: GetKind(self)
Returns the button type (standard or toggle).
:return: An integer representing the button type, one of ``wx.ITEM_NORMAL``, ``wx.ITEM_CHECK``.
.. method:: GetLongHelp(self)
Returns the help string shown in the statusbar.
:return: A string containing the :class:`ButtonInfo` long help string.
.. method:: GetRect(self)
Returns the :class:`ButtonInfo` client rectangle.
:return: An instance of :class:`wx.Rect`.
.. method:: GetShortHelp(self)
Returns the help string shown in a tooltip.
:return: A string containing the :class:`ButtonInfo` short help string.
.. method:: GetStatus(self)
Returns the :class:`ButtonInfo` status.
:return: A string containing the :class:`ButtonInfo` status (one of "Pressed", "Hover", "Normal",
"Toggled", "Disabled").
.. method:: GetText(self)
Returns the text associated to the button.
:return: A string containing the :class:`ButtonInfo` text.
.. method:: GetTextAlignment(self)
Returns the text alignment in the button (bottom or right).
:return: An integer representing the :class:`ButtonInfo` text alignment.
.. method:: GetToggled(self)
Returns whether a ``wx.ITEM_CHECK`` button is toggled or not.
:return: ``True`` if the button is toggled, ``False`` otherwise.
.. method:: HasText(self)
Returns whether the button has text or not.
:return: ``True`` if this :class:`ButtonInfo` instance has a label, ``False`` otherwise.
.. method:: IsEnabled(self)
Returns ``True`` if this instance of :class:`ButtonInfo` is enabled for input,
``False`` otherwise.
.. method:: SetBitmap(self, bmp, status="Normal")
Sets the bitmap associated with this instance of :class:`ButtonInfo`.
:param `bmp`: a valid :class:`wx.Bitmap` object;
:param string `status`: the :class:`ButtonInfo` status ("Pressed", "Hover", "Normal",
"Toggled", "Disabled").
.. method:: SetId(self, id)
Sets the :class:`ButtonInfo` identifier.
:param integer `id`: the identifier of the window.
.. method:: SetKind(self, kind=wx.ITEM_NORMAL)
Sets the button type (standard or toggle).
:param integer `kind`: one of ``wx.ITEM_NORMAL``, ``wx.ITEM_CHECK``.
.. method:: SetLongHelp(self, help="")
Sets the help string to be shown in the statusbar.
:param string `help`: the string for the long help.
.. method:: SetRect(self, rect)
Sets the :class:`ButtonInfo` client rectangle.
:param `rect`: an instance of :class:`wx.Rect`.
.. method:: SetShortHelp(self, help="")
Sets the help string to be shown in a tooltip.
:param string `help`: the string for the short help.
.. method:: SetStatus(self, status)
Sets the :class:`ButtonInfo` status.
:param string `status`: one of "Pressed", "Hover", "Normal", "Toggled", "Disabled".
.. method:: SetText(self, text="")
Sets the button label text.
:param string `text`: the button label string.
.. method:: SetTextAlignment(self, alignment)
Sets the text alignment in the button (bottom or right).
:param integer `alignment`: the text alignment in this :class:`ButtonInfo` instance.
.. method:: SetToggled(self, toggle=True)
Sets a ``wx.ITEM_CHECK`` button toggled/not toggled.
:param bool `toggle`: ``True`` to toggle the button, ``False`` otherwise.
.. attribute:: Bitmap
Returns the bitmap associated with this instance of :class:`ButtonInfo`.
:param string `status`: the :class:`ButtonInfo` status ("Pressed", "Hover", "Normal",
"Toggled", "Disabled").
:return: An instance of :class:`wx.Bitmap`.
.. attribute:: Id
Returns the :class:`ButtonInfo` id.
:return: An integer representing the button id.
.. attribute:: Rect
Returns the :class:`ButtonInfo` client rectangle.
:return: An instance of :class:`wx.Rect`.
.. attribute:: Status
Returns the :class:`ButtonInfo` status.
:return: A string containing the :class:`ButtonInfo` status (one of "Pressed", "Hover", "Normal",
"Toggled", "Disabled").
|
