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