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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.shapedbutton
.. highlight:: python
.. _wx.lib.agw.shapedbutton.SBitmapButton:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.shapedbutton.SBitmapButton**
==========================================================================================================================================
Subclass of :class:`SButton` which displays a bitmap, acting like a
:class:`wx.BitmapButton`.
|
|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>SBitmapButton</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.shapedbutton.SBitmapButton_inheritance.png" alt="Inheritance diagram of SBitmapButton" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.shapedbutton.SBitmapButton.html" title="wx.lib.agw.shapedbutton.SBitmapButton" alt="" coords="5,392,292,421"/> <area shape="rect" id="node2" href="wx.lib.agw.shapedbutton.SButton.html" title="wx.lib.agw.shapedbutton.SButton" alt="" coords="29,315,268,344"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window" alt="" coords="100,237,197,267"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="84,160,213,189"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="90,83,207,112"/> <area shape="rect" id="node6" href="wx.Object.html" title="wx.Object" alt="" coords="45,5,132,35"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="157,5,263,35"/> </map>
</p>
</div>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.lib.agw.shapedbutton.sbitmapbutton.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/wx.lib.agw.shapedbutton.sbitmapbutton.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.shapedbutton.SBitmapTextButton`, :class:`wx.lib.agw.shapedbutton.SBitmapToggleButton`
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.shapedbutton.SButton`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.__init__` Default class constructor.
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.DrawLabel` Draws the bitmap in the middle of the button.
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.GetBitmapDisabled` Returns the bitmap displayed when the button is disabled.
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.GetBitmapFocus` Returns the bitmap displayed when the button has the focus.
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.GetBitmapLabel` Returns the bitmap associated with the button in the normal state.
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.GetBitmapSelected` Returns the bitmap displayed when the button is selected (pressed).
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.SetBitmapDisabled` Sets the bitmap to display when the button is disabled.
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.SetBitmapFocus` Sets the bitmap to display when the button has the focus.
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.SetBitmapLabel` Sets the bitmap to display normally. This is the only one that is
:meth:`~wx.lib.agw.shapedbutton.SBitmapButton.SetBitmapSelected` Sets the bitmap to display when the button is selected (pressed).
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: SBitmapButton(SButton)
Subclass of :class:`SButton` which displays a bitmap, acting like a
:class:`wx.BitmapButton`.
.. method:: __init__(self, parent, id, bitmap, pos=wx.DefaultPosition, size=wx.DefaultSize)
Default class constructor.
:param `parent`: the :class:`SBitmapButton` parent. Must not be ``None``;
:param `id`: window identifier. A value of -1 indicates a default value;
:param `bitmap`: the button bitmap (if any);
: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.
.. method:: DrawLabel(self, dc, width, height, dw=0, dh=0)
Draws the bitmap in the middle of the button.
:param `dc`: an instance of :class:`wx.DC`;
:param `width`: the button width;
:param `height`: the button height;
:param `dw`: width differential, to show a 3D effect;
:param `dh`: height differential, to show a 3D effect.
.. method:: GetBitmapDisabled(self)
Returns the bitmap displayed when the button is disabled.
.. method:: GetBitmapFocus(self)
Returns the bitmap displayed when the button has the focus.
.. method:: GetBitmapLabel(self)
Returns the bitmap associated with the button in the normal state.
.. method:: GetBitmapSelected(self)
Returns the bitmap displayed when the button is selected (pressed).
.. method:: SetBitmapDisabled(self, bitmap)
Sets the bitmap to display when the button is disabled.
:param `bitmap`: a valid :class:`wx.Bitmap` object.
.. method:: SetBitmapFocus(self, bitmap)
Sets the bitmap to display when the button has the focus.
:param `bitmap`: a valid :class:`wx.Bitmap` object.
.. method:: SetBitmapLabel(self, bitmap, createothers=True)
Sets the bitmap to display normally. This is the only one that is
required.
:param `bitmap`: a valid :class:`wx.Bitmap` object;
:param `createothers`: if set to ``True``, then the other bitmaps will be
generated on the fly. Currently, only the disabled bitmap is generated.
.. method:: SetBitmapSelected(self, bitmap)
Sets the bitmap to display when the button is selected (pressed).
:param `bitmap`: a valid :class:`wx.Bitmap` object.
|
