added 3-state checkboxes (patch 813790)
[wxWidgets.git] / src / msw / checkbox.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: msw/checkbox.cpp
3 // Purpose: wxCheckBox
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "checkbox.h"
22 #endif
23
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
26
27 #ifdef __BORLANDC__
28 #pragma hdrstop
29 #endif
30
31 #if wxUSE_CHECKBOX
32
33 #ifndef WX_PRECOMP
34 #include "wx/checkbox.h"
35 #include "wx/brush.h"
36 #include "wx/dcscreen.h"
37 #include "wx/settings.h"
38 #endif
39
40 #include "wx/msw/private.h"
41
42 #ifndef BST_UNCHECKED
43 #define BST_UNCHECKED 0x0000
44 #endif
45
46 #ifndef BST_CHECKED
47 #define BST_CHECKED 0x0001
48 #endif
49
50 #ifndef BST_INDETERMINATE
51 #define BST_INDETERMINATE 0x0002
52 #endif
53
54 // ============================================================================
55 // implementation
56 // ============================================================================
57
58 #if wxUSE_EXTENDED_RTTI
59 WX_DEFINE_FLAGS( wxCheckBoxStyle )
60
61 wxBEGIN_FLAGS( wxCheckBoxStyle )
62 // new style border flags, we put them first to
63 // use them for streaming out
64 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
65 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
66 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
67 wxFLAGS_MEMBER(wxBORDER_RAISED)
68 wxFLAGS_MEMBER(wxBORDER_STATIC)
69 wxFLAGS_MEMBER(wxBORDER_NONE)
70
71 // old style border flags
72 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
73 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
74 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
75 wxFLAGS_MEMBER(wxRAISED_BORDER)
76 wxFLAGS_MEMBER(wxSTATIC_BORDER)
77 wxFLAGS_MEMBER(wxNO_BORDER)
78
79 // standard window styles
80 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
81 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
82 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
83 wxFLAGS_MEMBER(wxWANTS_CHARS)
84 wxFLAGS_MEMBER(wxNO_FULL_REPAINT_ON_RESIZE)
85 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
86 wxFLAGS_MEMBER(wxVSCROLL)
87 wxFLAGS_MEMBER(wxHSCROLL)
88
89 wxEND_FLAGS( wxCheckBoxStyle )
90
91 IMPLEMENT_DYNAMIC_CLASS_XTI(wxCheckBox, wxControl,"wx/checkbox.h")
92
93 wxBEGIN_PROPERTIES_TABLE(wxCheckBox)
94 wxEVENT_PROPERTY( Click , wxEVT_COMMAND_CHECKBOX_CLICKED , wxCommandEvent )
95
96 wxPROPERTY( Font , wxFont , SetFont , GetFont , , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
97 wxPROPERTY( Label,wxString, SetLabel, GetLabel, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
98 wxPROPERTY( Value ,bool, SetValue, GetValue, , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
99 wxPROPERTY_FLAGS( WindowStyle , wxCheckBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
100 wxEND_PROPERTIES_TABLE()
101
102 wxBEGIN_HANDLERS_TABLE(wxCheckBox)
103 wxEND_HANDLERS_TABLE()
104
105 wxCONSTRUCTOR_6( wxCheckBox , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
106 #else
107 IMPLEMENT_DYNAMIC_CLASS(wxCheckBox, wxControl)
108 #endif
109
110
111 // ----------------------------------------------------------------------------
112 // wxCheckBox
113 // ----------------------------------------------------------------------------
114
115 bool wxCheckBox::MSWCommand(WXUINT WXUNUSED(param), WXWORD WXUNUSED(id))
116 {
117 wxCommandEvent event(wxEVT_COMMAND_CHECKBOX_CLICKED, m_windowId);
118 wxCheckBoxState state = Get3StateValue();
119
120 // If the style flag to allow the user setting the undetermined state
121 // is not set, then skip the undetermined state and set it to unchecked.
122 if ( state == wxCHK_UNDETERMINED && !Is3rdStateAllowedForUser() )
123 {
124 state = wxCHK_UNCHECKED;
125 Set3StateValue(state);
126 }
127
128 event.SetInt(state);
129 event.SetEventObject(this);
130 ProcessCommand(event);
131
132 return TRUE;
133 }
134
135 bool wxCheckBox::Create(wxWindow *parent,
136 wxWindowID id,
137 const wxString& label,
138 const wxPoint& pos,
139 const wxSize& size, long style,
140 const wxValidator& validator,
141 const wxString& name)
142 {
143 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
144 return FALSE;
145
146 m_style = style;
147
148 long msStyle = WS_TABSTOP;
149
150 if ( style & wxCHK_3STATE )
151 {
152 msStyle |= BS_AUTO3STATE;
153 }
154 else
155 {
156 wxASSERT_MSG( !Is3rdStateAllowedForUser(),
157 wxT("Using wxCH_ALLOW_3RD_STATE_FOR_USER")
158 wxT(" style flag for a 2-state checkbox is useless") );
159 msStyle |= BS_AUTOCHECKBOX;
160 }
161
162 if ( style & wxALIGN_RIGHT )
163 {
164 msStyle |= BS_LEFTTEXT;
165 }
166
167 return MSWCreateControl(wxT("BUTTON"), msStyle, pos, size, label, 0);
168 }
169
170 void wxCheckBox::SetLabel(const wxString& label)
171 {
172 SetWindowText(GetHwnd(), label);
173 }
174
175 wxSize wxCheckBox::DoGetBestSize() const
176 {
177 static int s_checkSize = 0;
178
179 if ( !s_checkSize )
180 {
181 wxScreenDC dc;
182 dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
183
184 s_checkSize = dc.GetCharHeight();
185 }
186
187 wxString str = wxGetWindowText(GetHWND());
188
189 int wCheckbox, hCheckbox;
190 if ( !str.IsEmpty() )
191 {
192 GetTextExtent(str, &wCheckbox, &hCheckbox);
193 wCheckbox += s_checkSize + GetCharWidth();
194
195 if ( hCheckbox < s_checkSize )
196 hCheckbox = s_checkSize;
197 }
198 else
199 {
200 wCheckbox = s_checkSize;
201 hCheckbox = s_checkSize;
202 }
203
204 return wxSize(wCheckbox, hCheckbox);
205 }
206
207 void wxCheckBox::SetValue(bool val)
208 {
209 if (val)
210 {
211 Set3StateValue(wxCHK_CHECKED);
212 }
213 else
214 {
215 Set3StateValue(wxCHK_UNCHECKED);
216 }
217 }
218
219 bool wxCheckBox::GetValue() const
220 {
221 return (Get3StateValue() != 0);
222 }
223
224 void wxCheckBox::Command(wxCommandEvent& event)
225 {
226 int state = event.GetInt();
227 wxCHECK_RET( (state == wxCHK_UNCHECKED) || (state == wxCHK_CHECKED)
228 || (state == wxCHK_UNDETERMINED),
229 wxT("event.GetInt() returned an invalid checkbox state") );
230
231 Set3StateValue((wxCheckBoxState) state);
232 ProcessCommand(event);
233 }
234
235 wxCOMPILE_TIME_ASSERT(wxCHK_UNCHECKED == BST_UNCHECKED
236 && wxCHK_CHECKED == BST_CHECKED
237 && wxCHK_UNDETERMINED == BST_INDETERMINATE, EnumValuesIncorrect);
238
239 void wxCheckBox::DoSet3StateValue(wxCheckBoxState state)
240 {
241 ::SendMessage(GetHwnd(), BM_SETCHECK, (WPARAM) state, 0);
242 }
243
244 wxCheckBoxState wxCheckBox::DoGet3StateValue() const
245 {
246 #ifdef __WIN32__
247 return (wxCheckBoxState) ::SendMessage(GetHwnd(), BM_GETCHECK, 0, 0);
248 #else
249 return (wxCheckBoxState) ((::SendMessage(GetHwnd(), BM_GETCHECK, 0, 0)
250 & 0x001) == 0x001);
251 #endif
252
253 }
254
255 #endif // wxUSE_CHECKBOX