Generate tags for ribbon headers and sources too.

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

diff --git a/include/wx/checkbox.h b/include/wx/checkbox.h
index 47ba77a0e22ad38d81a1aef428f6d7b18ded107b..acd8c5c9d478b1fd008e164de0cab733f31507cb 100644 (file)
--- a/include/wx/checkbox.h
+++ b/include/wx/checkbox.h
@@ -25,8 +25,12 @@
  * Determine whether to use a 3-state or 2-state
  * checkbox. 3-state enables to differentiate
  * between 'unchecked', 'checked' and 'undetermined'.
  * Determine whether to use a 3-state or 2-state
  * checkbox. 3-state enables to differentiate
  * between 'unchecked', 'checked' and 'undetermined'.

+ *
+ * In addition to the styles here it is also possible to specify just 0 which
+ * is treated the same as wxCHK_2STATE for compatibility (but using explicit
+ * flag is preferred).

  */
  */

-#define wxCHK_2STATE           0x0000
+#define wxCHK_2STATE           0x4000

 #define wxCHK_3STATE           0x1000
 
 /*
 #define wxCHK_3STATE           0x1000
 
 /*


@@ -37,25 +41,13 @@
  */
 #define wxCHK_ALLOW_3RD_STATE_FOR_USER 0x2000
 
  */
 #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 char) wxCheckBoxNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) 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
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxCheckBoxBase : public wxControl
+class WXDLLIMPEXP_CORE wxCheckBoxBase : public wxControl

 {
 public:
     wxCheckBoxBase() { }
 {
 public:
     wxCheckBoxBase() { }


@@ -118,6 +110,9 @@ public:
     }
 
 protected:
     }
 
 protected:

+    // choose the default border for this window
+    virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
+

     virtual void DoSet3StateValue(wxCheckBoxState WXUNUSED(state)) { wxFAIL; }
 
     virtual wxCheckBoxState DoGet3StateValue() const
     virtual void DoSet3StateValue(wxCheckBoxState WXUNUSED(state)) { wxFAIL; }
 
     virtual wxCheckBoxState DoGet3StateValue() const


@@ -126,10 +121,51 @@ protected:
         return wxCHK_UNCHECKED;
     }
 
         return wxCHK_UNCHECKED;
     }
 

+    // Helper function to be called from derived classes Create()
+    // implementations: it checks that the style doesn't contain any
+    // incompatible bits and modifies it to be sane if it does.
+    static void WXValidateStyle(long *stylePtr)
+    {
+        long& style = *stylePtr;
+
+        if ( !(style & (wxCHK_2STATE | wxCHK_3STATE)) )
+        {
+            // For compatibility we use absence of style flags as wxCHK_2STATE
+            // because wxCHK_2STATE used to have the value of 0 and some
+            // existing code uses 0 instead of it. Moreover, some code even
+            // uses some non-0 style, e.g. wxBORDER_XXX, but doesn't specify
+            // neither wxCHK_2STATE nor wxCHK_3STATE -- to avoid breaking it,
+            // assume (much more common) 2 state checkbox by default.
+            style |= wxCHK_2STATE;
+        }
+
+        if ( style & wxCHK_3STATE )
+        {
+            if ( style & wxCHK_2STATE )
+            {
+                wxFAIL_MSG( "wxCHK_2STATE and wxCHK_3STATE can't be used "
+                            "together" );
+                style &= ~wxCHK_3STATE;
+            }
+        }
+        else // No wxCHK_3STATE
+        {
+            if ( style & wxCHK_ALLOW_3RD_STATE_FOR_USER )
+            {
+                wxFAIL_MSG( "wxCHK_ALLOW_3RD_STATE_FOR_USER doesn't make sense "
+                            "without wxCHK_3STATE" );
+                style &= ~wxCHK_ALLOW_3RD_STATE_FOR_USER;
+            }
+        }
+    }
+

 private:
 private:

-    DECLARE_NO_COPY_CLASS(wxCheckBoxBase)
+    wxDECLARE_NO_COPY_CLASS(wxCheckBoxBase);

 };
 
 };
 

+// Most ports support 3 state checkboxes so define this by default.
+#define wxHAS_3STATE_CHECKBOX
+

 #if defined(__WXUNIVERSAL__)
     #include "wx/univ/checkbox.h"
 #elif defined(__WXMSW__)
 #if defined(__WXUNIVERSAL__)
     #include "wx/univ/checkbox.h"
 #elif defined(__WXMSW__)


@@ -139,18 +175,17 @@ private:
 #elif defined(__WXGTK20__)
     #include "wx/gtk/checkbox.h"
 #elif defined(__WXGTK__)
 #elif defined(__WXGTK20__)
     #include "wx/gtk/checkbox.h"
 #elif defined(__WXGTK__)

+    #undef wxHAS_3STATE_CHECKBOX

     #include "wx/gtk1/checkbox.h"
 #elif defined(__WXMAC__)
     #include "wx/gtk1/checkbox.h"
 #elif defined(__WXMAC__)

-    #include "wx/mac/checkbox.h"
+    #include "wx/osx/checkbox.h"

 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/checkbox.h"
 #elif defined(__WXPM__)
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/checkbox.h"
 #elif defined(__WXPM__)

+    #undef wxHAS_3STATE_CHECKBOX

     #include "wx/os2/checkbox.h"
     #include "wx/os2/checkbox.h"

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

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

-#endif
-    // _WX_CHECKBOX_H_BASE_
+#endif // _WX_CHECKBOX_H_BASE_