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