X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/997176a34641a870b1f6c6102e30f64f86b4122a..31ad423e4fb556ec225a63b161154d3bf3445c1b:/include/wx/checkbox.h?ds=inline diff --git a/include/wx/checkbox.h b/include/wx/checkbox.h index 8ccb6539e3..dc333f37e8 100644 --- a/include/wx/checkbox.h +++ b/include/wx/checkbox.h @@ -5,7 +5,7 @@ // Modified by: // Created: 07.09.00 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team +// Copyright: (c) wxWidgets team // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// @@ -18,7 +18,38 @@ #include "wx/control.h" -WXDLLEXPORT_DATA(extern const wxChar*) wxCheckBoxNameStr; + +/* + * wxCheckBox style flags + * (Using wxCHK_* because wxCB_* is used by wxComboBox). + * Determine whether to use a 3-state or 2-state + * checkbox. 3-state enables to differentiate + * between 'unchecked', 'checked' and 'undetermined'. + */ +#define wxCHK_2STATE 0x0000 +#define wxCHK_3STATE 0x1000 + +/* + * If this style is set the user can set the checkbox to the + * undetermined state. If not set the undetermined set can only + * be set programmatically. + * This style can only be used with 3 state checkboxes. + */ +#define wxCHK_ALLOW_3RD_STATE_FOR_USER 0x2000 + +/* + * The possible states of a 3-state checkbox (Compatible + * with the 2-state checkbox). + */ +enum wxCheckBoxState +{ + wxCHK_UNCHECKED, + wxCHK_CHECKED, + wxCHK_UNDETERMINED /* 3-state checkbox only */ +}; + + +WXDLLEXPORT_DATA(extern const wxChar *) wxCheckBoxNameStr; // ---------------------------------------------------------------------------- // wxCheckBox: a control which shows a label and a box which may be checked @@ -27,11 +58,68 @@ WXDLLEXPORT_DATA(extern const wxChar*) wxCheckBoxNameStr; class WXDLLEXPORT wxCheckBoxBase : public wxControl { public: + wxCheckBoxBase() { } + // set/get the checked status of the listbox virtual void SetValue(bool value) = 0; virtual bool GetValue() const = 0; - bool IsChecked() const { return GetValue(); } + bool IsChecked() const + { + wxASSERT_MSG( !Is3State(), wxT("Calling IsChecked() doesn't make sense for") + wxT(" a three state checkbox, Use Get3StateValue() instead") ); + + return GetValue(); + } + + wxCheckBoxState Get3StateValue() const + { + wxCheckBoxState state = DoGet3StateValue(); + + if ( state == wxCHK_UNDETERMINED && !Is3State() ) + { + // Undetermined state with a 2-state checkbox?? + wxFAIL_MSG( wxT("DoGet3StateValue() says the 2-state checkbox is ") + wxT("in an undetermined/third state") ); + + state = wxCHK_UNCHECKED; + } + + return state; + } + + void Set3StateValue(wxCheckBoxState state) + { + if ( state == wxCHK_UNDETERMINED && !Is3State() ) + { + wxFAIL_MSG(wxT("Setting a 2-state checkbox to undetermined state")); + state = wxCHK_UNCHECKED; + } + + DoSet3StateValue(state); + } + + bool Is3State() const { return HasFlag(wxCHK_3STATE); } + + bool Is3rdStateAllowedForUser() const + { + return HasFlag(wxCHK_ALLOW_3RD_STATE_FOR_USER); + } + + virtual void ApplyParentThemeBackground(const wxColour& bg) + { SetBackgroundColour(bg); } + +protected: + virtual void DoSet3StateValue(wxCheckBoxState WXUNUSED(state)) { wxFAIL; } + + virtual wxCheckBoxState DoGet3StateValue() const + { + wxFAIL; + return wxCHK_UNCHECKED; + } + +private: + DECLARE_NO_COPY_CLASS(wxCheckBoxBase) }; #if defined(__WXUNIVERSAL__)