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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
.. 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.gradientbutton
.. highlight:: python
.. _wx.lib.agw.gradientbutton.GradientButton:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.gradientbutton.GradientButton**
==========================================================================================================================================
This is the main class implementation of :class:`GradientButton`.
|
|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>GradientButton</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.gradientbutton.GradientButton_inheritance.png" alt="Inheritance diagram of GradientButton" 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.Trackable.html" title="wx.Trackable" alt="" coords="39,5,140,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="91,83,201,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="86,160,207,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="164,5,245,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="102,237,191,267"/> <area shape="rect" id="node6" href="wx.Control.html" title="wx.Control" alt="" coords="103,315,191,344"/> <area shape="rect" id="node7" href="wx.lib.agw.gradientbutton.GradientButton.html" title="wx.lib.agw.gradientbutton.GradientButton" alt="" coords="4,392,288,421"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.lib.agw.gradientbutton.gradientbutton.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/../no_appearance.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/../no_appearance.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|super_classes| Known Superclasses
==================================
:class:`wx.Control`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.gradientbutton.GradientButton.__init__` Default class constructor.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.AcceptsFocus` Can this window be given focus by mouse click?
:meth:`~wx.lib.agw.gradientbutton.GradientButton.DoGetBestSize` Overridden base class virtual. Determines the best size of the
:meth:`~wx.lib.agw.gradientbutton.GradientButton.Enable` Enables/disables the button.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.GetBottomEndColour` Returns the bottom end colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.GetBottomStartColour` Returns the bottom start colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.GetDefaultAttributes` Overridden base class virtual. By default we should use
:meth:`~wx.lib.agw.gradientbutton.GradientButton.GetPath` Returns a rounded :class:`GraphicsPath` rectangle.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.GetPressedBottomColour` Returns the pressed bottom start colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.GetPressedTopColour` Returns the pressed top start colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.GetTopEndColour` Returns the top end colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.GetTopStartColour` Returns the top start colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.LightColour` Return light contrast of `colour`. The colour returned is from the scale of
:meth:`~wx.lib.agw.gradientbutton.GradientButton.Notify` Actually sends a ``wx.EVT_BUTTON`` event to the listener (if any).
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnGainFocus` Handles the ``wx.EVT_SET_FOCUS`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnKeyDown` Handles the ``wx.EVT_KEY_DOWN`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnKeyUp` Handles the ``wx.EVT_KEY_UP`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnLeftDown` Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnLeftUp` Handles the ``wx.EVT_LEFT_UP`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnLoseFocus` Handles the ``wx.EVT_KILL_FOCUS`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnMouseEnter` Handles the ``wx.EVT_ENTER_WINDOW`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnMouseLeave` Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnPaint` Handles the ``wx.EVT_PAINT`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.OnSize` Handles the ``wx.EVT_SIZE`` event for :class:`GradientButton`.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetBaseColours` Sets the bottom, top, pressed and foreground colour
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetBitmapLabel` Sets the bitmap label for the button.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetBottomEndColour` Sets the bottom end colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetBottomStartColour` Sets the top bottom colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetDefault` Sets the default button.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetForegroundColour` Sets the :class:`GradientButton` foreground (text) colour.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetInitialSize` Given the current font and bezel width settings, calculate
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetPressedBottomColour` Sets the pressed bottom start colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetPressedTopColour` Sets the pressed top start colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetTopEndColour` Sets the top end colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.SetTopStartColour` Sets the top start colour for the gradient shading.
:meth:`~wx.lib.agw.gradientbutton.GradientButton.ShouldInheritColours` Overridden base class virtual. Buttons usually don't inherit
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: GradientButton(wx.Control)
This is the main class implementation of :class:`GradientButton`.
.. method:: __init__(self, parent, id=wx.ID_ANY, bitmap=None, label="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.NO_BORDER, align=wx.CENTER, validator=wx.DefaultValidator, name="gradientbutton")
Default class constructor.
:param `parent`: the :class:`GradientButton` parent;
:param `id`: window identifier. A value of -1 indicates a default value;
:param `bitmap`: the button bitmap (if any);
:param `label`: the button text label;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param `style`: the button style (unused);
:param `align`: text/bitmap alignment. wx.CENTER or wx.LEFT;
:param `validator`: the validator associated to the button;
:param `name`: the button name.
.. method:: AcceptsFocus(self)
Can this window be given focus by mouse click?
:note: Overridden from :class:`wx.Control`.
.. method:: DoGetBestSize(self)
Overridden base class virtual. Determines the best size of the
button based on the label and bezel size.
:note: Overridden from :class:`wx.Control`.
.. method:: Enable(self, enable=True)
Enables/disables the button.
:param `enable`: ``True`` to enable the button, ``False`` to disable it.
:note: Overridden from :class:`wx.Control`.
.. method:: GetBottomEndColour(self)
Returns the bottom end colour for the gradient shading.
.. method:: GetBottomStartColour(self)
Returns the bottom start colour for the gradient shading.
.. method:: GetDefaultAttributes(self)
Overridden base class virtual. By default we should use
the same font/colour attributes as the native :class:`Button`.
.. method:: GetPath(self, gc, rc, r)
Returns a rounded :class:`GraphicsPath` rectangle.
:param `gc`: an instance of :class:`GraphicsContext`;
:param `rc`: a client rectangle;
:param `r`: the radious of the rounded part of the rectangle.
.. method:: GetPressedBottomColour(self)
Returns the pressed bottom start colour for the gradient shading.
.. method:: GetPressedTopColour(self)
Returns the pressed top start colour for the gradient shading.
.. method:: GetTopEndColour(self)
Returns the top end colour for the gradient shading.
.. method:: GetTopStartColour(self)
Returns the top start colour for the gradient shading.
.. method:: LightColour(self, colour, percent)
Return light contrast of `colour`. The colour returned is from the scale of
`colour` ==> white.
:param `colour`: the input colour to be brightened;
:param `percent`: determines how light the colour will be. `percent` = 100
returns white, `percent` = 0 returns `colour`.
.. method:: Notify(self)
Actually sends a ``wx.EVT_BUTTON`` event to the listener (if any).
.. method:: OnGainFocus(self, event)
Handles the ``wx.EVT_SET_FOCUS`` event for :class:`GradientButton`.
:param `event`: a :class:`FocusEvent` event to be processed.
.. method:: OnKeyDown(self, event)
Handles the ``wx.EVT_KEY_DOWN`` event for :class:`GradientButton`.
:param `event`: a :class:`KeyEvent` event to be processed.
.. method:: OnKeyUp(self, event)
Handles the ``wx.EVT_KEY_UP`` event for :class:`GradientButton`.
:param `event`: a :class:`KeyEvent` event to be processed.
.. method:: OnLeftDown(self, event)
Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`GradientButton`.
:param `event`: a :class:`MouseEvent` event to be processed.
.. method:: OnLeftUp(self, event)
Handles the ``wx.EVT_LEFT_UP`` event for :class:`GradientButton`.
:param `event`: a :class:`MouseEvent` event to be processed.
.. method:: OnLoseFocus(self, event)
Handles the ``wx.EVT_KILL_FOCUS`` event for :class:`GradientButton`.
:param `event`: a :class:`FocusEvent` event to be processed.
.. method:: OnMouseEnter(self, event)
Handles the ``wx.EVT_ENTER_WINDOW`` event for :class:`GradientButton`.
:param `event`: a :class:`MouseEvent` event to be processed.
.. method:: OnMouseLeave(self, event)
Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`GradientButton`.
:param `event`: a :class:`MouseEvent` event to be processed.
.. method:: OnPaint(self, event)
Handles the ``wx.EVT_PAINT`` event for :class:`GradientButton`.
:param `event`: a :class:`PaintEvent` event to be processed.
.. method:: OnSize(self, event)
Handles the ``wx.EVT_SIZE`` event for :class:`GradientButton`.
:param `event`: a :class:`wx.SizeEvent` event to be processed.
.. method:: SetBaseColours(self, startcolour=wx.BLACK, foregroundcolour=wx.WHITE)
Sets the bottom, top, pressed and foreground colour
:param startcolour: based colour to be used for bottom, top and pressed
:param foregroundcolour: colour used for the text
.. method:: SetBitmapLabel(self, bitmap)
Sets the bitmap label for the button.
:param `bitmap`: the bitmap label to set, an instance of :class:`wx.Bitmap`.
.. method:: SetBottomEndColour(self, colour)
Sets the bottom end colour for the gradient shading.
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: SetBottomStartColour(self, colour)
Sets the top bottom colour for the gradient shading.
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: SetDefault(self)
Sets the default button.
.. method:: SetForegroundColour(self, colour)
Sets the :class:`GradientButton` foreground (text) colour.
:param `colour`: a valid :class:`wx.Colour` object.
:note: Overridden from :class:`wx.Control`.
.. method:: SetInitialSize(self, size=None)
Given the current font and bezel width settings, calculate
and set a good size.
:param `size`: an instance of :class:`wx.Size`.
.. method:: SetPressedBottomColour(self, colour)
Sets the pressed bottom start colour for the gradient shading.
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: SetPressedTopColour(self, colour)
Sets the pressed top start colour for the gradient shading.
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: SetTopEndColour(self, colour)
Sets the top end colour for the gradient shading.
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: SetTopStartColour(self, colour)
Sets the top start colour for the gradient shading.
:param `colour`: a valid :class:`wx.Colour` object.
.. method:: ShouldInheritColours(self)
Overridden base class virtual. Buttons usually don't inherit
the parent's colours.
:note: Overridden from :class:`wx.Control`.
|
