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
|
/////////////////////////////////////////////////////////////////////////////
// Name: anybutton.h
// Purpose: interface of wxAnyButton
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#define wxBU_LEFT 0x0040
#define wxBU_TOP 0x0080
#define wxBU_RIGHT 0x0100
#define wxBU_BOTTOM 0x0200
#define wxBU_ALIGN_MASK ( wxBU_LEFT | wxBU_TOP | wxBU_RIGHT | wxBU_BOTTOM )
#define wxBU_EXACTFIT 0x0001
#define wxBU_NOTEXT 0x0002
#define wxBU_AUTODRAW 0x0004
/**
@class wxAnyButton
A class for common button functionality used as the base for the
various button classes.
*/
class wxAnyButton : public wxControl
{
public:
wxAnyButton();
~wxAnyButton();
/**
Return the bitmap shown by the button.
The returned bitmap may be invalid only if the button doesn't show any
images.
@see SetBitmap()
@since 2.9.1
*/
wxBitmap GetBitmap() const;
/**
Returns the bitmap used when the mouse is over the button, which may be
invalid.
@see SetBitmapCurrent()
@since 2.9.1 (available as wxBitmapButton::GetBitmapHover() in previous
versions)
*/
wxBitmap GetBitmapCurrent() const;
/**
Returns the bitmap for the disabled state, which may be invalid.
@see SetBitmapDisabled()
@since 2.9.1 (available in wxBitmapButton only in previous versions)
*/
wxBitmap GetBitmapDisabled() const;
/**
Returns the bitmap for the focused state, which may be invalid.
@see SetBitmapFocus()
@since 2.9.1 (available in wxBitmapButton only in previous versions)
*/
wxBitmap GetBitmapFocus() const;
/**
Returns the bitmap for the normal state.
This is exactly the same as GetBitmap() but uses a name
backwards-compatible with wxBitmapButton.
@see SetBitmap(), SetBitmapLabel()
@since 2.9.1 (available in wxBitmapButton only in previous versions)
*/
wxBitmap GetBitmapLabel() const;
/**
Returns the bitmap for the pressed state, which may be invalid.
@see SetBitmapPressed()
@since 2.9.1 (available as wxBitmapButton::GetBitmapSelected() in
previous versions)
*/
wxBitmap GetBitmapPressed() const;
/**
Sets the bitmap to display in the button.
The bitmap is displayed together with the button label. This method
sets up a single bitmap which is used in all button states, use
SetBitmapDisabled(), SetBitmapPressed(), SetBitmapCurrent() or
SetBitmapFocus() to change the individual images used in different
states.
@param bitmap
The bitmap to display in the button. If the bitmap is invalid, any
currently shown bitmaps are removed from the button.
@param dir
The position of the bitmap inside the button. By default it is
positioned to the left of the text, near to the left button border.
Other possible values include wxRIGHT, wxTOP and wxBOTTOM.
@see SetBitmapPosition(), SetBitmapMargins()
@since 2.9.1
*/
void SetBitmap(const wxBitmap& bitmap, wxDirection dir = wxLEFT);
/**
Sets the bitmap to be shown when the mouse is over the button.
If @a bitmap is invalid, the normal bitmap will be used in the current
state.
@see GetBitmapCurrent()
@since 2.9.1 (available as wxBitmapButton::SetBitmapHover() in previous
versions)
*/
void SetBitmapCurrent(const wxBitmap& bitmap);
/**
Sets the bitmap for the disabled button appearance.
If @a bitmap is invalid, the disabled bitmap is set to the
automatically generated greyed out version of the normal bitmap, i.e.
the same bitmap as is used by default if this method is not called at
all. Use SetBitmap() with an invalid bitmap to remove the bitmap
completely (for all states).
@see GetBitmapDisabled(), SetBitmapLabel(),
SetBitmapPressed(), SetBitmapFocus()
@since 2.9.1 (available in wxBitmapButton only in previous versions)
*/
void SetBitmapDisabled(const wxBitmap& bitmap);
/**
Sets the bitmap for the button appearance when it has the keyboard
focus.
If @a bitmap is invalid, the normal bitmap will be used in the focused
state.
@see GetBitmapFocus(), SetBitmapLabel(),
SetBitmapPressed(), SetBitmapDisabled()
@since 2.9.1 (available in wxBitmapButton only in previous versions)
*/
void SetBitmapFocus(const wxBitmap& bitmap);
/**
Sets the bitmap label for the button.
@remarks This is the bitmap used for the unselected state, and for all
other states if no other bitmaps are provided.
@see SetBitmap(), GetBitmapLabel()
@since 2.9.1 (available in wxBitmapButton only in previous versions)
*/
void SetBitmapLabel(const wxBitmap& bitmap);
/**
Sets the bitmap for the selected (depressed) button appearance.
@since 2.9.1 (available as wxBitmapButton::SetBitmapSelected() in
previous versions)
*/
void SetBitmapPressed(const wxBitmap& bitmap);
/**
Get the margins between the bitmap and the text of the button.
@see SetBitmapMargins()
@since 2.9.1
*/
wxSize GetBitmapMargins();
/**
Set the margins between the bitmap and the text of the button.
This method is currently only implemented under MSW. If it is not
called, default margin is used around the bitmap.
@see SetBitmap(), SetBitmapPosition()
@since 2.9.1
*/
//@{
void SetBitmapMargins(wxCoord x, wxCoord y);
void SetBitmapMargins(const wxSize& sz);
//@}
/**
Set the position at which the bitmap is displayed.
This method should only be called if the button does have an associated
bitmap.
@since 2.9.1
@param dir
Direction in which the bitmap should be positioned, one of wxLEFT,
wxRIGHT, wxTOP or wxBOTTOM.
*/
void SetBitmapPosition(wxDirection dir);
};
|
