src/gtk/checkbox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/checkbox.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #if wxUSE_CHECKBOX
  14
  15 #include "wx/checkbox.h"
  16
  17 #include <gtk/gtk.h>
  18
  19 //-----------------------------------------------------------------------------
  20 // data
  21 //-----------------------------------------------------------------------------
  22
  23 extern bool           g_blockEventsOnDrag;
  24
  25 //-----------------------------------------------------------------------------
  26 // "clicked"
  27 //-----------------------------------------------------------------------------
  28
  29 extern "C" {
  30 static void gtk_checkbox_toggled_callback(GtkWidget *widget, wxCheckBox *cb)
  31 {
  32     if (!cb->m_hasVMT) return;
  33
  34     if (g_blockEventsOnDrag) return;
  35
  36     // Transitions for 3state checkbox must be done manually, GTK's checkbox
  37     // is 2state with additional "undetermined state" flag which isn't
  38     // changed automatically:
  39     if (cb->Is3State())
  40     {
  41         GtkToggleButton *toggle = GTK_TOGGLE_BUTTON(widget);
  42
  43         if (cb->Is3rdStateAllowedForUser())
  44         {
  45             // The 3 states cycle like this when clicked:
  46             // checked -> undetermined -> unchecked -> checked -> ...
  47             bool active = gtk_toggle_button_get_active(toggle);
  48             bool inconsistent = gtk_toggle_button_get_inconsistent(toggle);
  49
  50             cb->GTKDisableEvents();
  51
  52             if (!active && !inconsistent)
  53             {
  54                 // checked -> undetermined
  55                 gtk_toggle_button_set_active(toggle, true);
  56                 gtk_toggle_button_set_inconsistent(toggle, true);
  57             }
  58             else if (!active && inconsistent)
  59             {
  60                 // undetermined -> unchecked
  61                 gtk_toggle_button_set_inconsistent(toggle, false);
  62             }
  63             else if (active && !inconsistent)
  64             {
  65                 // unchecked -> checked
  66                 // nothing to do
  67             }
  68             else
  69             {
  70                 wxFAIL_MSG(_T("3state wxCheckBox in unexpected state!"));
  71             }
  72
  73             cb->GTKEnableEvents();
  74         }
  75         else
  76         {
  77             // user's action unsets undetermined state:
  78             gtk_toggle_button_set_inconsistent(toggle, false);
  79         }
  80     }
  81
  82     wxCommandEvent event(wxEVT_COMMAND_CHECKBOX_CLICKED, cb->GetId());
  83     event.SetInt(cb->Get3StateValue());
  84     event.SetEventObject(cb);
  85     cb->HandleWindowEvent(event);
  86 }
  87 }
  88
  89 //-----------------------------------------------------------------------------
  90 // wxCheckBox
  91 //-----------------------------------------------------------------------------
  92
  93 IMPLEMENT_DYNAMIC_CLASS(wxCheckBox,wxControl)
  94
  95 wxCheckBox::wxCheckBox()
  96 {
  97 }
  98
  99 bool wxCheckBox::Create(wxWindow *parent,
 100                         wxWindowID id,
 101                         const wxString &label,
 102                         const wxPoint &pos,
 103                         const wxSize &size,
 104                         long style,
 105                         const wxValidator& validator,
 106                         const wxString &name )
 107 {
 108     if (!PreCreation( parent, pos, size ) ||
 109         !CreateBase( parent, id, pos, size, style, validator, name ))
 110     {
 111         wxFAIL_MSG( wxT("wxCheckBox creation failed") );
 112         return false;
 113     }
 114
 115     wxASSERT_MSG( (style & wxCHK_ALLOW_3RD_STATE_FOR_USER) == 0 ||
 116                   (style & wxCHK_3STATE) != 0,
 117                   wxT("Using wxCHK_ALLOW_3RD_STATE_FOR_USER")
 118                   wxT(" style flag for a 2-state checkbox is useless") );
 119
 120     if ( style & wxALIGN_RIGHT )
 121     {
 122         // VZ: as I don't know a way to create a right aligned checkbox with
 123         //     GTK we will create a checkbox without label and a label at the
 124         //     left of it
 125         m_widgetCheckbox = gtk_check_button_new();
 126
 127         m_widgetLabel = gtk_label_new("");
 128         gtk_misc_set_alignment(GTK_MISC(m_widgetLabel), 0.0, 0.5);
 129
 130         m_widget = gtk_hbox_new(FALSE, 0);
 131         gtk_box_pack_start(GTK_BOX(m_widget), m_widgetLabel, FALSE, FALSE, 3);
 132         gtk_box_pack_start(GTK_BOX(m_widget), m_widgetCheckbox, FALSE, FALSE, 3);
 133
 134         gtk_widget_show( m_widgetLabel );
 135         gtk_widget_show( m_widgetCheckbox );
 136     }
 137     else
 138     {
 139         m_widgetCheckbox = gtk_check_button_new_with_label("");
 140         m_widgetLabel = GTK_BIN(m_widgetCheckbox)->child;
 141         m_widget = m_widgetCheckbox;
 142     }
 143     g_object_ref(m_widget);
 144     SetLabel( label );
 145
 146     g_signal_connect (m_widgetCheckbox, "toggled",
 147                       G_CALLBACK (gtk_checkbox_toggled_callback), this);
 148
 149     m_parent->DoAddChild( this );
 150
 151     PostCreation(size);
 152
 153     return true;
 154 }
 155
 156 void wxCheckBox::GTKDisableEvents()
 157 {
 158     g_signal_handlers_block_by_func(m_widgetCheckbox,
 159         (gpointer) gtk_checkbox_toggled_callback, this);
 160 }
 161
 162 void wxCheckBox::GTKEnableEvents()
 163 {
 164     g_signal_handlers_unblock_by_func(m_widgetCheckbox,
 165         (gpointer) gtk_checkbox_toggled_callback, this);
 166 }
 167
 168 void wxCheckBox::SetValue( bool state )
 169 {
 170     wxCHECK_RET( m_widgetCheckbox != NULL, wxT("invalid checkbox") );
 171
 172     if (state == GetValue())
 173         return;
 174
 175     GTKDisableEvents();
 176
 177     gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(m_widgetCheckbox), state );
 178
 179     GTKEnableEvents();
 180 }
 181
 182 bool wxCheckBox::GetValue() const
 183 {
 184     wxCHECK_MSG( m_widgetCheckbox != NULL, false, wxT("invalid checkbox") );
 185
 186     return gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(m_widgetCheckbox));
 187 }
 188
 189 void wxCheckBox::DoSet3StateValue(wxCheckBoxState state)
 190 {
 191     SetValue(state != wxCHK_UNCHECKED);
 192     gtk_toggle_button_set_inconsistent(GTK_TOGGLE_BUTTON(m_widgetCheckbox),
 193                                        state == wxCHK_UNDETERMINED);
 194 }
 195
 196 wxCheckBoxState wxCheckBox::DoGet3StateValue() const
 197 {
 198     if (gtk_toggle_button_get_inconsistent(GTK_TOGGLE_BUTTON(m_widgetCheckbox)))
 199     {
 200         return wxCHK_UNDETERMINED;
 201     }
 202     else
 203     {
 204         return GetValue() ? wxCHK_CHECKED : wxCHK_UNCHECKED;
 205     }
 206 }
 207
 208 void wxCheckBox::SetLabel( const wxString& label )
 209 {
 210     wxCHECK_RET( m_widgetLabel != NULL, wxT("invalid checkbox") );
 211
 212     // save the label inside m_label in case user calls GetLabel() later
 213     wxControl::SetLabel(label);
 214
 215     GTKSetLabelForLabel(GTK_LABEL(m_widgetLabel), label);
 216 }
 217
 218 bool wxCheckBox::Enable( bool enable )
 219 {
 220     bool isEnabled = IsEnabled();
 221
 222     if ( !wxControl::Enable( enable ) )
 223         return false;
 224
 225     gtk_widget_set_sensitive( m_widgetLabel, enable );
 226
 227     if (!isEnabled && enable)
 228     {
 229         GTKFixSensitivity();
 230     }
 231
 232     return true;
 233 }
 234
 235 void wxCheckBox::DoApplyWidgetStyle(GtkRcStyle *style)
 236 {
 237     gtk_widget_modify_style(m_widgetCheckbox, style);
 238     gtk_widget_modify_style(m_widgetLabel, style);
 239 }
 240
 241 GdkWindow *wxCheckBox::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
 242 {
 243     return GTK_BUTTON(m_widgetCheckbox)->event_window;
 244 }
 245
 246 wxSize wxCheckBox::DoGetBestSize() const
 247 {
 248     return wxControl::DoGetBestSize();
 249 }
 250
 251 // static
 252 wxVisualAttributes
 253 wxCheckBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 254 {
 255     return GetDefaultAttributesFromGTKWidget(gtk_check_button_new);
 256 }
 257
 258 #endif