src/gtk/spinctrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/spinbutt.cpp
   3 // Purpose:     wxSpinCtrl
   4 // Author:      Robert
   5 // Modified by:
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // For compilers that support precompilation, includes "wx.h".
  12 #include "wx/wxprec.h"
  13
  14 #if wxUSE_SPINCTRL
  15
  16 #include "wx/spinctrl.h"
  17
  18 #ifndef WX_PRECOMP
  19     #include "wx/textctrl.h"    // for wxEVT_COMMAND_TEXT_UPDATED
  20     #include "wx/utils.h"
  21     #include "wx/wxcrtvararg.h"
  22 #endif
  23
  24 #include "wx/gtk/private.h"
  25
  26 //-----------------------------------------------------------------------------
  27 // data
  28 //-----------------------------------------------------------------------------
  29
  30 extern bool   g_blockEventsOnDrag;
  31
  32 //-----------------------------------------------------------------------------
  33 // "value_changed"
  34 //-----------------------------------------------------------------------------
  35
  36 extern "C" {
  37 static void
  38 gtk_value_changed(GtkSpinButton* spinbutton, wxSpinCtrlGTKBase* win)
  39 {
  40     if (!win->m_hasVMT || g_blockEventsOnDrag)
  41         return;
  42
  43     if (wxIsKindOf(win, wxSpinCtrl))
  44     {
  45         wxSpinEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, win->GetId());
  46         event.SetEventObject( win );
  47         event.SetPosition(static_cast<wxSpinCtrl*>(win)->GetValue());
  48         event.SetString(gtk_entry_get_text(GTK_ENTRY(spinbutton)));
  49         win->HandleWindowEvent( event );
  50     }
  51     else // wxIsKindOf(win, wxSpinCtrlDouble)
  52     {
  53         wxSpinDoubleEvent event( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, win->GetId());
  54         event.SetEventObject( win );
  55         event.SetValue(static_cast<wxSpinCtrlDouble*>(win)->GetValue());
  56         event.SetString(gtk_entry_get_text(GTK_ENTRY(spinbutton)));
  57         win->HandleWindowEvent( event );
  58     }
  59 }
  60 }
  61
  62 //-----------------------------------------------------------------------------
  63 //  "changed"
  64 //-----------------------------------------------------------------------------
  65
  66 extern "C" {
  67 static void
  68 gtk_changed(GtkSpinButton* spinbutton, wxSpinCtrl* win)
  69 {
  70     if (!win->m_hasVMT)
  71         return;
  72
  73     wxCommandEvent event( wxEVT_COMMAND_TEXT_UPDATED, win->GetId() );
  74     event.SetEventObject( win );
  75     event.SetString(gtk_entry_get_text(GTK_ENTRY(spinbutton)));
  76     event.SetInt(win->GetValue());
  77     win->HandleWindowEvent( event );
  78 }
  79 }
  80
  81 //-----------------------------------------------------------------------------
  82 // wxSpinCtrlGTKBase
  83 //-----------------------------------------------------------------------------
  84
  85 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlGTKBase, wxSpinCtrlBase)
  86
  87 BEGIN_EVENT_TABLE(wxSpinCtrlGTKBase, wxSpinCtrlBase)
  88     EVT_CHAR(wxSpinCtrlGTKBase::OnChar)
  89 END_EVENT_TABLE()
  90
  91 bool wxSpinCtrlGTKBase::Create(wxWindow *parent, wxWindowID id,
  92                         const wxString& value,
  93                         const wxPoint& pos,  const wxSize& size,
  94                         long style,
  95                         double min, double max, double initial, double inc,
  96                         const wxString& name)
  97 {
  98     if (!PreCreation( parent, pos, size ) ||
  99         !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 100     {
 101         wxFAIL_MSG( wxT("wxSpinCtrlGTKBase creation failed") );
 102         return false;
 103     }
 104
 105     m_widget = gtk_spin_button_new_with_range(min, max, inc);
 106     g_object_ref(m_widget);
 107
 108     gtk_spin_button_set_value( GTK_SPIN_BUTTON(m_widget), initial);
 109
 110     gfloat align;
 111     if ( HasFlag(wxALIGN_RIGHT) )
 112         align = 1.0;
 113     else if ( HasFlag(wxALIGN_CENTRE) )
 114         align = 0.5;
 115     else
 116         align = 0.0;
 117
 118     gtk_entry_set_alignment(GTK_ENTRY(m_widget), align);
 119
 120     gtk_spin_button_set_wrap( GTK_SPIN_BUTTON(m_widget),
 121                               (int)(m_windowStyle & wxSP_WRAP) );
 122
 123     g_signal_connect_after(m_widget, "value_changed", G_CALLBACK(gtk_value_changed), this);
 124     g_signal_connect_after(m_widget, "changed", G_CALLBACK(gtk_changed), this);
 125
 126     m_parent->DoAddChild( this );
 127
 128     PostCreation(size);
 129
 130     if (!value.empty())
 131     {
 132         SetValue(value);
 133     }
 134
 135     return true;
 136 }
 137
 138 double wxSpinCtrlGTKBase::DoGetValue() const
 139 {
 140     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 141
 142     // Get value directly from current control text, just as
 143     // gtk_spin_button_update() would do. Calling gtk_spin_button_update() causes
 144     // a redraw, which causes an idle event, so if GetValue() is called from
 145     // a UI update handler, you get a never ending sequence of idle events. It
 146     // also forces the text into valid range, which wxMSW GetValue() does not do.
 147     static unsigned sig_id;
 148     if (sig_id == 0)
 149         sig_id = g_signal_lookup("input", GTK_TYPE_SPIN_BUTTON);
 150     double value;
 151     int handled = 0;
 152     g_signal_emit(m_widget, sig_id, 0, &value, &handled);
 153     if (!handled)
 154         value = g_strtod(gtk_entry_get_text(GTK_ENTRY(m_widget)), NULL);
 155     const GtkAdjustment* adj =
 156         gtk_spin_button_get_adjustment(GTK_SPIN_BUTTON(m_widget));
 157     if (value < adj->lower)
 158         value = adj->lower;
 159     else if (value > adj->upper)
 160         value = adj->upper;
 161
 162     return value;
 163 }
 164
 165 double wxSpinCtrlGTKBase::DoGetMin() const
 166 {
 167     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 168
 169     double min = 0;
 170     gtk_spin_button_get_range( GTK_SPIN_BUTTON(m_widget), &min, NULL);
 171     return min;
 172 }
 173
 174 double wxSpinCtrlGTKBase::DoGetMax() const
 175 {
 176     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 177
 178     double max = 0;
 179     gtk_spin_button_get_range( GTK_SPIN_BUTTON(m_widget), NULL, &max);
 180     return max;
 181 }
 182
 183 double wxSpinCtrlGTKBase::DoGetIncrement() const
 184 {
 185     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 186
 187     double inc = 0;
 188     gtk_spin_button_get_increments( GTK_SPIN_BUTTON(m_widget), &inc, NULL);
 189     return inc;
 190 }
 191
 192 bool wxSpinCtrlGTKBase::GetSnapToTicks() const
 193 {
 194     wxCHECK_MSG(m_widget, false, "invalid spin button");
 195
 196     return gtk_spin_button_get_snap_to_ticks( GTK_SPIN_BUTTON(m_widget) );
 197 }
 198
 199 void wxSpinCtrlGTKBase::SetValue( const wxString& value )
 200 {
 201     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 202
 203     double n;
 204     if ( wxSscanf(value, "%lg", &n) == 1 )
 205     {
 206         // a number - set it, let DoSetValue round for int value
 207         DoSetValue(n);
 208         return;
 209     }
 210
 211     // invalid number - set text as is (wxMSW compatible)
 212     GtkDisableEvents();
 213     gtk_entry_set_text( GTK_ENTRY(m_widget), wxGTK_CONV( value ) );
 214     GtkEnableEvents();
 215 }
 216
 217 void wxSpinCtrlGTKBase::DoSetValue( double value )
 218 {
 219     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 220
 221     GtkDisableEvents();
 222     gtk_spin_button_set_value( GTK_SPIN_BUTTON(m_widget), value);
 223     GtkEnableEvents();
 224 }
 225
 226 void wxSpinCtrlGTKBase::SetSnapToTicks(bool snap_to_ticks)
 227 {
 228     wxCHECK_RET( (m_widget != NULL), "invalid spin button" );
 229
 230     gtk_spin_button_set_snap_to_ticks( GTK_SPIN_BUTTON(m_widget), snap_to_ticks);
 231 }
 232
 233 void wxSpinCtrlGTKBase::SetSelection(long from, long to)
 234 {
 235     // translate from wxWidgets conventions to GTK+ ones: (-1, -1) means the
 236     // entire range
 237     if ( from == -1 && to == -1 )
 238     {
 239         from = 0;
 240         to = INT_MAX;
 241     }
 242
 243     gtk_editable_select_region( GTK_EDITABLE(m_widget), (gint)from, (gint)to );
 244 }
 245
 246 void wxSpinCtrlGTKBase::DoSetRange(double minVal, double maxVal)
 247 {
 248     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 249
 250     GtkDisableEvents();
 251     gtk_spin_button_set_range( GTK_SPIN_BUTTON(m_widget), minVal, maxVal);
 252     GtkEnableEvents();
 253 }
 254
 255 void wxSpinCtrlGTKBase::DoSetIncrement(double inc)
 256 {
 257     wxCHECK_RET( m_widget, "invalid spin button" );
 258
 259     GtkDisableEvents();
 260
 261     // Preserve the old page value when changing just the increment.
 262     double page = 10*inc;
 263     gtk_spin_button_get_increments( GTK_SPIN_BUTTON(m_widget), NULL, &page);
 264
 265     gtk_spin_button_set_increments( GTK_SPIN_BUTTON(m_widget), inc, page);
 266     GtkEnableEvents();
 267 }
 268
 269 void wxSpinCtrlGTKBase::GtkDisableEvents() const
 270 {
 271     g_signal_handlers_block_by_func( m_widget,
 272         (gpointer)gtk_value_changed, (void*) this);
 273
 274     g_signal_handlers_block_by_func(m_widget,
 275         (gpointer)gtk_changed, (void*) this);
 276 }
 277
 278 void wxSpinCtrlGTKBase::GtkEnableEvents() const
 279 {
 280     g_signal_handlers_unblock_by_func(m_widget,
 281         (gpointer)gtk_value_changed, (void*) this);
 282
 283     g_signal_handlers_unblock_by_func(m_widget,
 284         (gpointer)gtk_changed, (void*) this);
 285 }
 286
 287 void wxSpinCtrlGTKBase::OnChar( wxKeyEvent &event )
 288 {
 289     wxCHECK_RET( m_widget != NULL, wxT("invalid spin ctrl") );
 290
 291     if (event.GetKeyCode() == WXK_RETURN)
 292     {
 293         wxWindow *top_frame = wxGetTopLevelParent(m_parent);
 294
 295         if ( GTK_IS_WINDOW(top_frame->m_widget) )
 296         {
 297             GtkWindow *window = GTK_WINDOW(top_frame->m_widget);
 298             if ( window )
 299             {
 300                 GtkWidget *widgetDef = window->default_widget;
 301
 302                 if ( widgetDef )
 303                 {
 304                     gtk_widget_activate(widgetDef);
 305                     return;
 306                 }
 307             }
 308         }
 309     }
 310
 311     if ((event.GetKeyCode() == WXK_RETURN) && (m_windowStyle & wxTE_PROCESS_ENTER))
 312     {
 313         wxCommandEvent evt( wxEVT_COMMAND_TEXT_ENTER, m_windowId );
 314         evt.SetEventObject(this);
 315         GtkSpinButton *gsb = GTK_SPIN_BUTTON(m_widget);
 316         wxString val = wxGTK_CONV_BACK( gtk_entry_get_text( &gsb->entry ) );
 317         evt.SetString( val );
 318         if (HandleWindowEvent(evt)) return;
 319     }
 320
 321     event.Skip();
 322 }
 323
 324 GdkWindow *wxSpinCtrlGTKBase::GTKGetWindow(wxArrayGdkWindows& windows) const
 325 {
 326     GtkSpinButton* spinbutton = GTK_SPIN_BUTTON(m_widget);
 327
 328     windows.push_back(spinbutton->entry.text_area);
 329     windows.push_back(spinbutton->panel);
 330
 331     return NULL;
 332 }
 333
 334 wxSize wxSpinCtrlGTKBase::DoGetBestSize() const
 335 {
 336     wxSize ret( wxControl::DoGetBestSize() );
 337     wxSize best(95, ret.y); // FIXME: 95?
 338     CacheBestSize(best);
 339     return best;
 340 }
 341
 342 // static
 343 wxVisualAttributes
 344 wxSpinCtrlGTKBase::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 345 {
 346     // TODO: overload to accept functions like gtk_spin_button_new?
 347     // Until then use a similar type
 348     return GetDefaultAttributesFromGTKWidget(gtk_entry_new, true);
 349 }
 350
 351 //-----------------------------------------------------------------------------
 352 // wxSpinCtrl
 353 //-----------------------------------------------------------------------------
 354
 355 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxSpinCtrlGTKBase)
 356
 357 //-----------------------------------------------------------------------------
 358 // wxSpinCtrlDouble
 359 //-----------------------------------------------------------------------------
 360
 361 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble, wxSpinCtrlGTKBase)
 362
 363 unsigned wxSpinCtrlDouble::GetDigits() const
 364 {
 365     wxCHECK_MSG( m_widget, 0, "invalid spin button" );
 366
 367     return gtk_spin_button_get_digits( GTK_SPIN_BUTTON(m_widget) );
 368 }
 369
 370 void wxSpinCtrlDouble::SetDigits(unsigned digits)
 371 {
 372     wxCHECK_RET( m_widget, "invalid spin button" );
 373
 374     gtk_spin_button_set_digits( GTK_SPIN_BUTTON(m_widget), digits);
 375 }
 376
 377 #endif // wxUSE_SPINCTRL