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
|
/////////////////////////////////////////////////////////////////////////////
// Name: tglbtn.h
// Purpose: interface of wxBitmapToggleButton, wxToggleButton
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
wxEventType wxEVT_TOGGLEBUTTON;
/**
@class wxToggleButton
wxToggleButton is a button that stays pressed when clicked by the user.
In other words, it is similar to wxCheckBox in functionality but looks like a wxButton.
Since wxWidgets version 2.9.0 this control emits an update UI event.
You can see wxToggleButton in action in @ref page_samples_controls.
@beginEventEmissionTable{wxCommandEvent}
@event{EVT_TOGGLEBUTTON(id, func)}
Handles a wxEVT_TOGGLEBUTTON event.
@endEventTable
@library{wxcore}
@category{ctrl}
@appearance{togglebutton}
@see wxCheckBox, wxButton, wxBitmapToggleButton
*/
class wxToggleButton : public wxAnyButton
{
public:
/**
Default constructor.
*/
wxToggleButton();
/**
Constructor, creating and showing a toggle button.
@param parent
Parent window. Must not be @NULL.
@param id
Toggle button identifier. The value wxID_ANY indicates a default value.
@param label
Text to be displayed next to the toggle button.
@param pos
Toggle button position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Toggle button size.
If ::wxDefaultSize is specified then a default size is chosen.
@param style
Window style. See wxToggleButton.
@param val
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxToggleButton(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
const wxString& name = wxCheckBoxNameStr);
/**
Destructor, destroying the toggle button.
*/
virtual ~wxToggleButton();
/**
Creates the toggle button for two-step construction.
See wxToggleButton() for details.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
const wxString& name = wxCheckBoxNameStr);
/**
Gets the state of the toggle button.
@return Returns @true if it is pressed, @false otherwise.
*/
virtual bool GetValue() const;
/**
Sets the toggle button to the given state.
This does not cause a @c EVT_TOGGLEBUTTON event to be emitted.
@param state
If @true, the button is pressed.
*/
virtual void SetValue(bool state);
};
/**
@class wxBitmapToggleButton
wxBitmapToggleButton is a wxToggleButton that contains a bitmap instead of
text.
This class is not available in all ports currently (although it is
available in the major ones), test for @c wxHAS_BITMAPTOGGLEBUTTON to
determine whether it can be used (in addition for possibly testing for
@c wxUSE_TOGGLEBTN which can be set to 0 to explicitly disable support for
this class and wxToggleButton).
This control emits an update UI event.
@beginEventEmissionTable{wxCommandEvent}
@event{EVT_TOGGLEBUTTON(id, func)}
Handles a wxEVT_TOGGLEBUTTON event.
@endEventTable
@library{wxcore}
@category{ctrl}
*/
class wxBitmapToggleButton : public wxToggleButton
{
public:
/**
Default constructor.
*/
wxBitmapToggleButton();
/**
Constructor, creating and showing a toggle button with the bitmap @e label.
Internally calls Create().
*/
wxBitmapToggleButton(wxWindow* parent, wxWindowID id,
const wxBitmap& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
const wxString& name = wxCheckBoxNameStr);
/**
Create method for two-step construction.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxBitmap& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
const wxString& name = wxCheckBoxNameStr);
/**
Gets the state of the toggle button.
@return Returns @true if it is pressed, @false otherwise.
*/
virtual bool GetValue() const;
/**
Sets the toggle button to the given state.
This does not cause a @c EVT_TOGGLEBUTTON event to be emitted.
@param state
If @true, the button is pressed.
*/
virtual void SetValue(bool state);
};
|
