]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/checkbox.h
Fix missing documentation for several GDI functions.
[wxWidgets.git] / include / wx / checkbox.h
... / ...
CommitLineData
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/checkbox.h
3// Purpose: wxCheckBox class interface
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 07.09.00
7// RCS-ID: $Id$
8// Copyright: (c) wxWidgets team
9// Licence: wxWindows licence
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_CHECKBOX_H_BASE_
13#define _WX_CHECKBOX_H_BASE_
14
15#include "wx/defs.h"
16
17#if wxUSE_CHECKBOX
18
19#include "wx/control.h"
20
21
22/*
23 * wxCheckBox style flags
24 * (Using wxCHK_* because wxCB_* is used by wxComboBox).
25 * Determine whether to use a 3-state or 2-state
26 * checkbox. 3-state enables to differentiate
27 * between 'unchecked', 'checked' and 'undetermined'.
28 *
29 * In addition to the styles here it is also possible to specify just 0 which
30 * is treated the same as wxCHK_2STATE for compatibility (but using explicit
31 * flag is preferred).
32 */
33#define wxCHK_2STATE 0x4000
34#define wxCHK_3STATE 0x1000
35
36/*
37 * If this style is set the user can set the checkbox to the
38 * undetermined state. If not set the undetermined set can only
39 * be set programmatically.
40 * This style can only be used with 3 state checkboxes.
41 */
42#define wxCHK_ALLOW_3RD_STATE_FOR_USER 0x2000
43
44extern WXDLLIMPEXP_DATA_CORE(const char) wxCheckBoxNameStr[];
45
46// ----------------------------------------------------------------------------
47// wxCheckBox: a control which shows a label and a box which may be checked
48// ----------------------------------------------------------------------------
49
50class WXDLLIMPEXP_CORE wxCheckBoxBase : public wxControl
51{
52public:
53 wxCheckBoxBase() { }
54
55 // set/get the checked status of the listbox
56 virtual void SetValue(bool value) = 0;
57 virtual bool GetValue() const = 0;
58
59 bool IsChecked() const
60 {
61 wxASSERT_MSG( !Is3State(), wxT("Calling IsChecked() doesn't make sense for")
62 wxT(" a three state checkbox, Use Get3StateValue() instead") );
63
64 return GetValue();
65 }
66
67 wxCheckBoxState Get3StateValue() const
68 {
69 wxCheckBoxState state = DoGet3StateValue();
70
71 if ( state == wxCHK_UNDETERMINED && !Is3State() )
72 {
73 // Undetermined state with a 2-state checkbox??
74 wxFAIL_MSG( wxT("DoGet3StateValue() says the 2-state checkbox is ")
75 wxT("in an undetermined/third state") );
76
77 state = wxCHK_UNCHECKED;
78 }
79
80 return state;
81 }
82
83 void Set3StateValue(wxCheckBoxState state)
84 {
85 if ( state == wxCHK_UNDETERMINED && !Is3State() )
86 {
87 wxFAIL_MSG(wxT("Setting a 2-state checkbox to undetermined state"));
88 state = wxCHK_UNCHECKED;
89 }
90
91 DoSet3StateValue(state);
92 }
93
94 bool Is3State() const { return HasFlag(wxCHK_3STATE); }
95
96 bool Is3rdStateAllowedForUser() const
97 {
98 return HasFlag(wxCHK_ALLOW_3RD_STATE_FOR_USER);
99 }
100
101 virtual bool HasTransparentBackground() { return true; }
102
103 // wxCheckBox-specific processing after processing the update event
104 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event)
105 {
106 wxControl::DoUpdateWindowUI(event);
107
108 if ( event.GetSetChecked() )
109 SetValue(event.GetChecked());
110 }
111
112protected:
113 // choose the default border for this window
114 virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
115
116 virtual void DoSet3StateValue(wxCheckBoxState WXUNUSED(state)) { wxFAIL; }
117
118 virtual wxCheckBoxState DoGet3StateValue() const
119 {
120 wxFAIL;
121 return wxCHK_UNCHECKED;
122 }
123
124 // Helper function to be called from derived classes Create()
125 // implementations: it checks that the style doesn't contain any
126 // incompatible bits and modifies it to be sane if it does.
127 static void WXValidateStyle(long *stylePtr)
128 {
129 long& style = *stylePtr;
130
131 if ( !(style & (wxCHK_2STATE | wxCHK_3STATE)) )
132 {
133 // For compatibility we use absence of style flags as wxCHK_2STATE
134 // because wxCHK_2STATE used to have the value of 0 and some
135 // existing code uses 0 instead of it. Moreover, some code even
136 // uses some non-0 style, e.g. wxBORDER_XXX, but doesn't specify
137 // neither wxCHK_2STATE nor wxCHK_3STATE -- to avoid breaking it,
138 // assume (much more common) 2 state checkbox by default.
139 style |= wxCHK_2STATE;
140 }
141
142 if ( style & wxCHK_3STATE )
143 {
144 if ( style & wxCHK_2STATE )
145 {
146 wxFAIL_MSG( "wxCHK_2STATE and wxCHK_3STATE can't be used "
147 "together" );
148 style &= ~wxCHK_3STATE;
149 }
150 }
151 else // No wxCHK_3STATE
152 {
153 if ( style & wxCHK_ALLOW_3RD_STATE_FOR_USER )
154 {
155 wxFAIL_MSG( "wxCHK_ALLOW_3RD_STATE_FOR_USER doesn't make sense "
156 "without wxCHK_3STATE" );
157 style &= ~wxCHK_ALLOW_3RD_STATE_FOR_USER;
158 }
159 }
160 }
161
162private:
163 wxDECLARE_NO_COPY_CLASS(wxCheckBoxBase);
164};
165
166// Most ports support 3 state checkboxes so define this by default.
167#define wxHAS_3STATE_CHECKBOX
168
169#if defined(__WXUNIVERSAL__)
170 #include "wx/univ/checkbox.h"
171#elif defined(__WXMSW__)
172 #include "wx/msw/checkbox.h"
173#elif defined(__WXMOTIF__)
174 #include "wx/motif/checkbox.h"
175#elif defined(__WXGTK20__)
176 #include "wx/gtk/checkbox.h"
177#elif defined(__WXGTK__)
178 #undef wxHAS_3STATE_CHECKBOX
179 #include "wx/gtk1/checkbox.h"
180#elif defined(__WXMAC__)
181 #include "wx/osx/checkbox.h"
182#elif defined(__WXCOCOA__)
183 #include "wx/cocoa/checkbox.h"
184#elif defined(__WXPM__)
185 #undef wxHAS_3STATE_CHECKBOX
186 #include "wx/os2/checkbox.h"
187#endif
188
189#endif // wxUSE_CHECKBOX
190
191#endif // _WX_CHECKBOX_H_BASE_