added wxConvFileName which is a variable, not define as wxConvFile; added comments...

[wxWidgets.git] / include / wx / checkbox.h

diff --git a/include/wx/checkbox.h b/include/wx/checkbox.h
index a011252b4321a2f423ac916684411374e1af38e6..9f9b5e83d9c072b1b7369923bf0200dabc60e7c0 100644 (file)
--- a/include/wx/checkbox.h
+++ b/include/wx/checkbox.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     07.09.00
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     07.09.00
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -18,7 +18,38 @@
 
 #include "wx/control.h"
 
 
 #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 */
+};
+
+
+extern WXDLLEXPORT_DATA(const wxChar *) wxCheckBoxNameStr;

 
 // ----------------------------------------------------------------------------
 // wxCheckBox: a control which shows a label and a box which may be checked
 
 // ----------------------------------------------------------------------------
 // wxCheckBox: a control which shows a label and a box which may be checked


@@ -33,7 +64,58 @@ public:
     virtual void SetValue(bool value) = 0;
     virtual bool GetValue() const = 0;
 
     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 bool HasTransparentBackground() { return true; }
+
+protected:
+    virtual void DoSet3StateValue(wxCheckBoxState WXUNUSED(state)) { wxFAIL; }
+
+    virtual wxCheckBoxState DoGet3StateValue() const
+    {
+        wxFAIL;
+        return wxCHK_UNCHECKED;
+    }

 
 private:
     DECLARE_NO_COPY_CLASS(wxCheckBoxBase)
 
 private:
     DECLARE_NO_COPY_CLASS(wxCheckBoxBase)


@@ -53,6 +135,8 @@ private:
     #include "wx/cocoa/checkbox.h"
 #elif defined(__WXPM__)
     #include "wx/os2/checkbox.h"
     #include "wx/cocoa/checkbox.h"
 #elif defined(__WXPM__)
     #include "wx/os2/checkbox.h"

+#elif defined(__WXPALMOS__)
+    #include "wx/palmos/checkbox.h"

 #endif
 
 #endif // wxUSE_CHECKBOX
 #endif
 
 #endif // wxUSE_CHECKBOX