implemented 3state checkboxes in wxGTK with GTK2

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28035 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/changes.txt

@@ -135,6 +135,7 @@ wxGTK:
 - fixed many rendering artifacts and wrong colours with lots of GTK+ themes
 - implemented wxColourDialog as native dialog
 - wxTreeCtrl::GetCount() counts root as well now (compatible with MSW)
+- added support for wxCHK_3STATE style (GTK2 only)
 
 wxMotif:
 

docs/latex/wx/checkbox.tex

@@ -1,7 +1,7 @@
 \section{\class{wxCheckBox}}\label{wxcheckbox}
 
 A checkbox is a labelled box which by default is either on (checkmark is
-visible) or off (no checkmark). Optionally (When the wxCHK\_3STATE style flag
+visible) or off (no checkmark). Optionally (when the wxCHK\_3STATE style flag
 is set) it can have a third state, called the mixed or undetermined state.
 Often this is used as a "Does Not Apply" state.
 
@@ -21,7 +21,8 @@ Often this is used as a "Does Not Apply" state.
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxCHK\_2STATE}}{Create a 2-state checkbox. This is the default.}
-\twocolitem{\windowstyle{wxCHK\_3STATE}}{Create a 3-state checkbox.}
+\twocolitem{\windowstyle{wxCHK\_3STATE}}{Create a 3-state checkbox.
+Not implemented in wxMGL, wxOS2 and wxGTK built against GTK+ 1.2.}
 \twocolitem{\windowstyle{wxCHK\_ALLOW\_3RD\_STATE\_FOR\_USER}}{By default a user can't set a 3-state checkbox
 to the third state. It can only be done from code. Using this flags allows the user to set the checkbox to the third state by clicking. }
 \twocolitem{\windowstyle{wxALIGN\_RIGHT}}{Makes the text appear on the left of the checkbox.}

include/wx/gtk/checkbox.h

@@ -63,6 +63,11 @@ public:
 protected:
     virtual wxSize DoGetBestSize() const;
 
+#ifdef __WXGTK20__
+    void DoSet3StateValue(wxCheckBoxState state);
+    wxCheckBoxState DoGet3StateValue() const;
+#endif
+
 private:
     DECLARE_DYNAMIC_CLASS(wxCheckBox)
 };

include/wx/gtk1/checkbox.h

@@ -63,6 +63,11 @@ public:
 protected:
     virtual wxSize DoGetBestSize() const;
 
+#ifdef __WXGTK20__
+    void DoSet3StateValue(wxCheckBoxState state);
+    wxCheckBoxState DoGet3StateValue() const;
+#endif
+
 private:
     DECLARE_DYNAMIC_CLASS(wxCheckBox)
 };

src/gtk/checkbox.cpp

@@ -42,7 +42,7 @@ extern wxWindowGTK   *g_delayedFocus;
 // "clicked"
 //-----------------------------------------------------------------------------
 
-static void gtk_checkbox_clicked_callback( GtkWidget *WXUNUSED(widget), wxCheckBox *cb )
+static void gtk_checkbox_toggled_callback(GtkWidget *widget, wxCheckBox *cb)
 {
     if (g_isIdle) wxapp_install_idle_handler();
 
@@ -52,8 +52,60 @@ static void gtk_checkbox_clicked_callback( GtkWidget *WXUNUSED(widget), wxCheckB
     
     if (cb->m_blockEvent) return;
 
+#ifdef __WXGTK20__
+    // Transitions for 3state checkbox must be done manually, GTK's checkbox
+    // is 2state with additional "undetermined state" flag which isn't
+    // changed automatically:
+    if (cb->Is3State())
+    {
+        GtkToggleButton *toggle = GTK_TOGGLE_BUTTON(widget);
+
+        if (cb->Is3rdStateAllowedForUser())
+        {
+            // The 3 states cycle like this when clicked:
+            // checked -> undetermined -> unchecked -> checked -> ...
+            bool active = gtk_toggle_button_get_active(toggle);
+            bool inconsistent = gtk_toggle_button_get_inconsistent(toggle);
+
+            cb->m_blockEvent = true;
+            
+            if (!active && !inconsistent)
+            {
+                // checked -> undetermined
+                gtk_toggle_button_set_active(toggle, true);
+                gtk_toggle_button_set_inconsistent(toggle, true);
+            }
+            else if (!active && inconsistent)
+            {
+                // undetermined -> unchecked
+                gtk_toggle_button_set_inconsistent(toggle, false);
+            }
+            else if (active && !inconsistent)
+            {
+                // unchecked -> checked
+                // nothing to do
+            }
+            else
+            {
+                wxFAIL_MSG(_T("3state wxCheckBox in unexpected state!"));
+            }
+            
+            cb->m_blockEvent = false;
+        }
+        else
+        {
+            // user's action unsets undetermined state:
+            gtk_toggle_button_set_inconsistent(toggle, false);
+        }
+    }
+#endif
+
     wxCommandEvent event(wxEVT_COMMAND_CHECKBOX_CLICKED, cb->GetId());
+#ifdef __WXGTK20__
+    event.SetInt(cb->Get3StateValue());
+#else
     event.SetInt(cb->GetValue());
+#endif
     event.SetEventObject(cb);
     cb->GetEventHandler()->ProcessEvent(event);
 }
@@ -88,6 +140,11 @@ bool wxCheckBox::Create(wxWindow *parent,
         return FALSE;
     }
 
+    wxASSERT_MSG( (style & wxCHK_ALLOW_3RD_STATE_FOR_USER) == 0 ||
+                  (style & wxCHK_3STATE) != 0,
+                  wxT("Using wxCHK_ALLOW_3RD_STATE_FOR_USER")
+                  wxT(" style flag for a 2-state checkbox is useless") );
+
     if ( style & wxALIGN_RIGHT )
     {
         // VZ: as I don't know a way to create a right aligned checkbox with
@@ -114,8 +171,8 @@ bool wxCheckBox::Create(wxWindow *parent,
     SetLabel( label );
 
     gtk_signal_connect( GTK_OBJECT(m_widgetCheckbox),
-                        "clicked",
+                        "toggled",
-                        GTK_SIGNAL_FUNC(gtk_checkbox_clicked_callback),
+                        GTK_SIGNAL_FUNC(gtk_checkbox_toggled_callback),
                         (gpointer *)this );
 
     m_parent->DoAddChild( this );
@@ -143,9 +200,34 @@ bool wxCheckBox::GetValue() const
 {
     wxCHECK_MSG( m_widgetCheckbox != NULL, FALSE, wxT("invalid checkbox") );
 
+#ifdef __WXGTK20__
+    return gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(m_widgetCheckbox));
+#else
     return GTK_TOGGLE_BUTTON(m_widgetCheckbox)->active;
+#endif
 }
 
+#ifdef __WXGTK20__
+void wxCheckBox::DoSet3StateValue(wxCheckBoxState state)
+{
+    SetValue(state != wxCHK_UNCHECKED);
+    gtk_toggle_button_set_inconsistent(GTK_TOGGLE_BUTTON(m_widgetCheckbox),
+                                       state == wxCHK_UNDETERMINED);
+}
+
+wxCheckBoxState wxCheckBox::DoGet3StateValue() const
+{
+    if (gtk_toggle_button_get_inconsistent(GTK_TOGGLE_BUTTON(m_widgetCheckbox)))
+    {
+        return wxCHK_UNDETERMINED;
+    }
+    else
+    {
+        return GetValue() ? wxCHK_CHECKED : wxCHK_UNCHECKED;
+    }
+}
+#endif
+
 void wxCheckBox::SetLabel( const wxString& label )
 {
     wxCHECK_RET( m_widgetLabel != NULL, wxT("invalid checkbox") );

src/gtk1/checkbox.cpp

@@ -42,7 +42,7 @@ extern wxWindowGTK   *g_delayedFocus;
 // "clicked"
 //-----------------------------------------------------------------------------
 
-static void gtk_checkbox_clicked_callback( GtkWidget *WXUNUSED(widget), wxCheckBox *cb )
+static void gtk_checkbox_toggled_callback(GtkWidget *widget, wxCheckBox *cb)
 {
     if (g_isIdle) wxapp_install_idle_handler();
 
@@ -52,8 +52,60 @@ static void gtk_checkbox_clicked_callback( GtkWidget *WXUNUSED(widget), wxCheckB
     
     if (cb->m_blockEvent) return;
 
+#ifdef __WXGTK20__
+    // Transitions for 3state checkbox must be done manually, GTK's checkbox
+    // is 2state with additional "undetermined state" flag which isn't
+    // changed automatically:
+    if (cb->Is3State())
+    {
+        GtkToggleButton *toggle = GTK_TOGGLE_BUTTON(widget);
+
+        if (cb->Is3rdStateAllowedForUser())
+        {
+            // The 3 states cycle like this when clicked:
+            // checked -> undetermined -> unchecked -> checked -> ...
+            bool active = gtk_toggle_button_get_active(toggle);
+            bool inconsistent = gtk_toggle_button_get_inconsistent(toggle);
+
+            cb->m_blockEvent = true;
+            
+            if (!active && !inconsistent)
+            {
+                // checked -> undetermined
+                gtk_toggle_button_set_active(toggle, true);
+                gtk_toggle_button_set_inconsistent(toggle, true);
+            }
+            else if (!active && inconsistent)
+            {
+                // undetermined -> unchecked
+                gtk_toggle_button_set_inconsistent(toggle, false);
+            }
+            else if (active && !inconsistent)
+            {
+                // unchecked -> checked
+                // nothing to do
+            }
+            else
+            {
+                wxFAIL_MSG(_T("3state wxCheckBox in unexpected state!"));
+            }
+            
+            cb->m_blockEvent = false;
+        }
+        else
+        {
+            // user's action unsets undetermined state:
+            gtk_toggle_button_set_inconsistent(toggle, false);
+        }
+    }
+#endif
+
     wxCommandEvent event(wxEVT_COMMAND_CHECKBOX_CLICKED, cb->GetId());
+#ifdef __WXGTK20__
+    event.SetInt(cb->Get3StateValue());
+#else
     event.SetInt(cb->GetValue());
+#endif
     event.SetEventObject(cb);
     cb->GetEventHandler()->ProcessEvent(event);
 }
@@ -88,6 +140,11 @@ bool wxCheckBox::Create(wxWindow *parent,
         return FALSE;
     }
 
+    wxASSERT_MSG( (style & wxCHK_ALLOW_3RD_STATE_FOR_USER) == 0 ||
+                  (style & wxCHK_3STATE) != 0,
+                  wxT("Using wxCHK_ALLOW_3RD_STATE_FOR_USER")
+                  wxT(" style flag for a 2-state checkbox is useless") );
+
     if ( style & wxALIGN_RIGHT )
     {
         // VZ: as I don't know a way to create a right aligned checkbox with
@@ -114,8 +171,8 @@ bool wxCheckBox::Create(wxWindow *parent,
     SetLabel( label );
 
     gtk_signal_connect( GTK_OBJECT(m_widgetCheckbox),
-                        "clicked",
+                        "toggled",
-                        GTK_SIGNAL_FUNC(gtk_checkbox_clicked_callback),
+                        GTK_SIGNAL_FUNC(gtk_checkbox_toggled_callback),
                         (gpointer *)this );
 
     m_parent->DoAddChild( this );
@@ -143,9 +200,34 @@ bool wxCheckBox::GetValue() const
 {
     wxCHECK_MSG( m_widgetCheckbox != NULL, FALSE, wxT("invalid checkbox") );
 
+#ifdef __WXGTK20__
+    return gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(m_widgetCheckbox));
+#else
     return GTK_TOGGLE_BUTTON(m_widgetCheckbox)->active;
+#endif
 }
 
+#ifdef __WXGTK20__
+void wxCheckBox::DoSet3StateValue(wxCheckBoxState state)
+{
+    SetValue(state != wxCHK_UNCHECKED);
+    gtk_toggle_button_set_inconsistent(GTK_TOGGLE_BUTTON(m_widgetCheckbox),
+                                       state == wxCHK_UNDETERMINED);
+}
+
+wxCheckBoxState wxCheckBox::DoGet3StateValue() const
+{
+    if (gtk_toggle_button_get_inconsistent(GTK_TOGGLE_BUTTON(m_widgetCheckbox)))
+    {
+        return wxCHK_UNDETERMINED;
+    }
+    else
+    {
+        return GetValue() ? wxCHK_CHECKED : wxCHK_UNCHECKED;
+    }
+}
+#endif
+
 void wxCheckBox::SetLabel( const wxString& label )
 {
     wxCHECK_RET( m_widgetLabel != NULL, wxT("invalid checkbox") );