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
|
<HTML>
<head><title>wxCheckBox</title></head>
<BODY BGCOLOR=#FFFFFF>
<A NAME="wxcheckbox"></A><CENTER>
<A HREF="wx.htm"><img align=center src="contents.gif" BORDER=0 ALT="Contents"></A> <A HREF="wx22.htm#classref"><img align=center src="up.gif" BORDER=0 ALT="Up"></A> <A HREF="wx38.htm#wxcalculatelayoutevent"><img align=center src="back.gif" BORDER=0 ALT="Previous"></A> <A HREF="wx40.htm#wxchecklistbox"><img align=center src="forward.gif" BORDER=0 ALT="Next"></A> </CENTER><HR>
<H2>wxCheckBox</H2>
<P>
A checkbox is a labelled box which is either on (checkmark is visible)
or off (no checkmark).<P>
<B><FONT COLOR="#FF0000">Derived from</FONT></B><P>
<A HREF="wx56.htm#wxcontrol">wxControl</A><BR>
<A HREF="wx260.htm#wxwindow">wxWindow</A><BR>
<A HREF="wx85.htm#wxevthandler">wxEvtHandler</A><BR>
<A HREF="wx158.htm#wxobject">wxObject</A><P>
<B><FONT COLOR="#FF0000">Include files</FONT></B><P>
<wx/checkbox.h><P>
<B><FONT COLOR="#FF0000">Window styles</FONT></B><P>
There are no special styles for wxCheckBox.<P>
See also <A HREF="wx305.htm#windowstyles">window styles overview</A>.<P>
<B><FONT COLOR="#FF0000">Event handling</FONT></B><P>
<TABLE>
<TR><TD VALIGN=TOP>
<B>EVT_CHECKBOX(id, func)</B>
</TD>
<TD VALIGN=TOP>
Process a wxEVT_COMMAND_CHECKBOX_CLICKED event,
when the checkbox is clicked.
</TD></TR>
</TABLE>
<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx191.htm#wxradiobutton">wxRadioButton</A>, <A HREF="wx52.htm#wxcommandevent">wxCommandEvent</A><P>
<B><FONT COLOR="#FF0000">Members</FONT></B><P>
<A HREF="#wxcheckboxconstr">wxCheckBox::wxCheckBox</A><BR>
<A HREF="#topic75">wxCheckBox::~wxCheckBox</A><BR>
<A HREF="#wxcheckboxcreate">wxCheckBox::Create</A><BR>
<A HREF="#wxcheckboxgetvalue">wxCheckBox::GetValue</A><BR>
<A HREF="#wxcheckboxsetvalue">wxCheckBox::SetValue</A><BR>
<P>
<HR>
<A NAME="wxcheckboxconstr"></A>
<H3>wxCheckBox::wxCheckBox</H3>
<P>
<B></B> <B>wxCheckBox</B>()<P>
Default constructor.<P>
<B></B> <B>wxCheckBox</B>(<B>wxWindow* </B><I>parent</I>, <B>wxWindowID</B><I> id</I>,
<B>const wxString& </B><I>label</I>, <B>const wxPoint& </B><I>pos = wxDefaultPosition</I>,
<B>const wxSize& </B><I>size = wxDefaultSize</I>, <B>long</B><I> style = 0</I>,
<B>const wxValidator& </B><I>val</I>, <B>const wxString& </B><I>name = "checkBox"</I>)<P>
Constructor, creating and showing a checkbox.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>parent</I><UL><UL>
Parent window. Must not be NULL.</UL></UL>
<P>
<I>id</I><UL><UL>
Checkbox identifier. A value of -1 indicates a default value.</UL></UL>
<P>
<I>label</I><UL><UL>
Text to be displayed next to the checkbox.</UL></UL>
<P>
<I>pos</I><UL><UL>
Checkbox position. If the position (-1, -1) is specified then a default position is chosen.</UL></UL>
<P>
<I>size</I><UL><UL>
Checkbox size. If the default size (-1, -1) is specified then a default size is chosen.</UL></UL>
<P>
<I>style</I><UL><UL>
Window style. See <A HREF="wx39.htm#wxcheckbox">wxCheckBox</A>.</UL></UL>
<P>
<I>validator</I><UL><UL>
Window validator.</UL></UL>
<P>
<I>name</I><UL><UL>
Window name.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx39.htm#wxcheckboxcreate">wxCheckBox::Create</A>, <A HREF="wx255.htm#wxvalidator">wxValidator</A><P>
<HR>
<A NAME="topic75"></A>
<H3>wxCheckBox::~wxCheckBox</H3>
<P>
<B></B> <B>~wxCheckBox</B>()<P>
Destructor, destroying the checkbox.<P>
<HR>
<A NAME="wxcheckboxcreate"></A>
<H3>wxCheckBox::Create</H3>
<P>
<B>bool</B> <B>Create</B>(<B>wxWindow* </B><I>parent</I>, <B>wxWindowID</B><I> id</I>,
<B>const wxString& </B><I>label</I>, <B>const wxPoint& </B><I>pos = wxDefaultPosition</I>,
<B>const wxSize& </B><I>size = wxDefaultSize</I>, <B>long</B><I> style = 0</I>,
<B>const wxValidator& </B><I>val</I>, <B>const wxString& </B><I>name = "checkBox"</I>)<P>
Creates the checkbox for two-step construction. See <A HREF="wx39.htm#wxcheckboxconstr">wxCheckBox::wxCheckBox</A>
for details.<P>
<HR>
<A NAME="wxcheckboxgetvalue"></A>
<H3>wxCheckBox::GetValue</H3>
<P>
<B>bool</B> <B>GetValue</B>() <B>const</B><P>
Gets the state of the checkbox.<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
Returns TRUE if it is checked, FALSE otherwise.<P>
<HR>
<A NAME="wxcheckboxsetvalue"></A>
<H3>wxCheckBox::SetValue</H3>
<P>
<B>void</B> <B>SetValue</B>(<B>const bool</B><I> state</I>)<P>
Sets the checkbox to the given state.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>state</I><UL><UL>
If TRUE, the check is on, otherwise it is off.</UL></UL>
<P>
</BODY></HTML>
|
