src/gtk/spinctrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/spinctrl.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 <gtk/gtk.h>
  25 #include "wx/gtk/private.h"
  26 #include "wx/gtk/private/gtk2-compat.h"
  27
  28 //-----------------------------------------------------------------------------
  29 // data
  30 //-----------------------------------------------------------------------------
  31
  32 extern bool   g_blockEventsOnDrag;
  33
  34 //-----------------------------------------------------------------------------
  35 // "value_changed"
  36 //-----------------------------------------------------------------------------
  37
  38 extern "C" {
  39 static void
  40 gtk_value_changed(GtkSpinButton* spinbutton, wxSpinCtrlGTKBase* win)
  41 {
  42     if (!win->m_hasVMT || g_blockEventsOnDrag)
  43         return;
  44
  45     if (wxIsKindOf(win, wxSpinCtrl))
  46     {
  47         wxSpinEvent event(wxEVT_COMMAND_SPINCTRL_UPDATED, win->GetId());
  48         event.SetEventObject( win );
  49         event.SetPosition(static_cast<wxSpinCtrl*>(win)->GetValue());
  50         event.SetString(gtk_entry_get_text(GTK_ENTRY(spinbutton)));
  51         win->HandleWindowEvent( event );
  52     }
  53     else // wxIsKindOf(win, wxSpinCtrlDouble)
  54     {
  55         wxSpinDoubleEvent event( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, win->GetId());
  56         event.SetEventObject( win );
  57         event.SetValue(static_cast<wxSpinCtrlDouble*>(win)->GetValue());
  58         event.SetString(gtk_entry_get_text(GTK_ENTRY(spinbutton)));
  59         win->HandleWindowEvent( event );
  60     }
  61 }
  62 }
  63
  64 //-----------------------------------------------------------------------------
  65 //  "changed"
  66 //-----------------------------------------------------------------------------
  67
  68 extern "C" {
  69 static void
  70 gtk_changed(GtkSpinButton* spinbutton, wxSpinCtrl* win)
  71 {
  72     if (!win->m_hasVMT)
  73         return;
  74
  75     wxCommandEvent event( wxEVT_COMMAND_TEXT_UPDATED, win->GetId() );
  76     event.SetEventObject( win );
  77     event.SetString(gtk_entry_get_text(GTK_ENTRY(spinbutton)));
  78     event.SetInt(win->GetValue());
  79     win->HandleWindowEvent( event );
  80 }
  81 }
  82
  83 //-----------------------------------------------------------------------------
  84 // wxSpinCtrlGTKBase
  85 //-----------------------------------------------------------------------------
  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     GtkAdjustment* adj =
 156         gtk_spin_button_get_adjustment(GTK_SPIN_BUTTON(m_widget));
 157     const double lower = gtk_adjustment_get_lower(adj);
 158     const double upper = gtk_adjustment_get_upper(adj);
 159     if (value < lower)
 160         value = lower;
 161     else if (value > upper)
 162         value = upper;
 163
 164     return value;
 165 }
 166
 167 double wxSpinCtrlGTKBase::DoGetMin() const
 168 {
 169     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 170
 171     double min = 0;
 172     gtk_spin_button_get_range( GTK_SPIN_BUTTON(m_widget), &min, NULL);
 173     return min;
 174 }
 175
 176 double wxSpinCtrlGTKBase::DoGetMax() const
 177 {
 178     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 179
 180     double max = 0;
 181     gtk_spin_button_get_range( GTK_SPIN_BUTTON(m_widget), NULL, &max);
 182     return max;
 183 }
 184
 185 double wxSpinCtrlGTKBase::DoGetIncrement() const
 186 {
 187     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 188
 189     double inc = 0;
 190     gtk_spin_button_get_increments( GTK_SPIN_BUTTON(m_widget), &inc, NULL);
 191     return inc;
 192 }
 193
 194 bool wxSpinCtrlGTKBase::GetSnapToTicks() const
 195 {
 196     wxCHECK_MSG(m_widget, false, "invalid spin button");
 197
 198     return gtk_spin_button_get_snap_to_ticks( GTK_SPIN_BUTTON(m_widget) ) != 0;
 199 }
 200
 201 void wxSpinCtrlGTKBase::SetValue( const wxString& value )
 202 {
 203     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 204
 205     double n;
 206     if ( wxSscanf(value, "%lg", &n) == 1 )
 207     {
 208         // a number - set it, let DoSetValue round for int value
 209         DoSetValue(n);
 210         return;
 211     }
 212
 213     // invalid number - set text as is (wxMSW compatible)
 214     GtkDisableEvents();
 215     gtk_entry_set_text( GTK_ENTRY(m_widget), wxGTK_CONV( value ) );
 216     GtkEnableEvents();
 217 }
 218
 219 void wxSpinCtrlGTKBase::DoSetValue( double value )
 220 {
 221     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 222
 223     GtkDisableEvents();
 224     gtk_spin_button_set_value( GTK_SPIN_BUTTON(m_widget), value);
 225     GtkEnableEvents();
 226 }
 227
 228 void wxSpinCtrlGTKBase::SetSnapToTicks(bool snap_to_ticks)
 229 {
 230     wxCHECK_RET( (m_widget != NULL), "invalid spin button" );
 231
 232     gtk_spin_button_set_snap_to_ticks( GTK_SPIN_BUTTON(m_widget), snap_to_ticks);
 233 }
 234
 235 void wxSpinCtrlGTKBase::SetSelection(long from, long to)
 236 {
 237     // translate from wxWidgets conventions to GTK+ ones: (-1, -1) means the
 238     // entire range
 239     if ( from == -1 && to == -1 )
 240     {
 241         from = 0;
 242         to = INT_MAX;
 243     }
 244
 245     gtk_editable_select_region( GTK_EDITABLE(m_widget), (gint)from, (gint)to );
 246 }
 247
 248 void wxSpinCtrlGTKBase::DoSetRange(double minVal, double maxVal)
 249 {
 250     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 251
 252     GtkDisableEvents();
 253     gtk_spin_button_set_range( GTK_SPIN_BUTTON(m_widget), minVal, maxVal);
 254     GtkEnableEvents();
 255 }
 256
 257 void wxSpinCtrlGTKBase::DoSetIncrement(double inc)
 258 {
 259     wxCHECK_RET( m_widget, "invalid spin button" );
 260
 261     GtkDisableEvents();
 262
 263     // Preserve the old page value when changing just the increment.
 264     double page = 10*inc;
 265     gtk_spin_button_get_increments( GTK_SPIN_BUTTON(m_widget), NULL, &page);
 266
 267     gtk_spin_button_set_increments( GTK_SPIN_BUTTON(m_widget), inc, page);
 268     GtkEnableEvents();
 269 }
 270
 271 void wxSpinCtrlGTKBase::GtkDisableEvents() const
 272 {
 273     g_signal_handlers_block_by_func( m_widget,
 274         (gpointer)gtk_value_changed, (void*) this);
 275
 276     g_signal_handlers_block_by_func(m_widget,
 277         (gpointer)gtk_changed, (void*) this);
 278 }
 279
 280 void wxSpinCtrlGTKBase::GtkEnableEvents() const
 281 {
 282     g_signal_handlers_unblock_by_func(m_widget,
 283         (gpointer)gtk_value_changed, (void*) this);
 284
 285     g_signal_handlers_unblock_by_func(m_widget,
 286         (gpointer)gtk_changed, (void*) this);
 287 }
 288
 289 void wxSpinCtrlGTKBase::OnChar( wxKeyEvent &event )
 290 {
 291     wxCHECK_RET( m_widget != NULL, wxT("invalid spin ctrl") );
 292
 293     if (event.GetKeyCode() == WXK_RETURN)
 294     {
 295         wxWindow *top_frame = wxGetTopLevelParent(m_parent);
 296
 297         if ( GTK_IS_WINDOW(top_frame->m_widget) )
 298         {
 299             GtkWindow *window = GTK_WINDOW(top_frame->m_widget);
 300             if ( window )
 301             {
 302                 GtkWidget* widgetDef = gtk_window_get_default_widget(window);
 303
 304                 if ( widgetDef )
 305                 {
 306                     gtk_widget_activate(widgetDef);
 307                     return;
 308                 }
 309             }
 310         }
 311     }
 312
 313     if ((event.GetKeyCode() == WXK_RETURN) && (m_windowStyle & wxTE_PROCESS_ENTER))
 314     {
 315         wxCommandEvent evt( wxEVT_COMMAND_TEXT_ENTER, m_windowId );
 316         evt.SetEventObject(this);
 317         GtkSpinButton *gsb = GTK_SPIN_BUTTON(m_widget);
 318         wxString val = wxGTK_CONV_BACK( gtk_entry_get_text( &gsb->entry ) );
 319         evt.SetString( val );
 320         if (HandleWindowEvent(evt)) return;
 321     }
 322
 323     event.Skip();
 324 }
 325
 326 GdkWindow *wxSpinCtrlGTKBase::GTKGetWindow(wxArrayGdkWindows& windows) const
 327 {
 328 #ifdef __WXGTK3__
 329     // no access to internal GdkWindows
 330     wxUnusedVar(windows);
 331 #else
 332     GtkSpinButton* spinbutton = GTK_SPIN_BUTTON(m_widget);
 333
 334     windows.push_back(spinbutton->entry.text_area);
 335     windows.push_back(spinbutton->panel);
 336 #endif
 337
 338     return NULL;
 339 }
 340
 341 wxSize wxSpinCtrlGTKBase::DoGetBestSize() const
 342 {
 343     wxSize ret( wxControl::DoGetBestSize() );
 344     wxSize best(95, ret.y); // FIXME: 95?
 345     CacheBestSize(best);
 346     return best;
 347 }
 348
 349 // static
 350 wxVisualAttributes
 351 wxSpinCtrlGTKBase::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 352 {
 353     // TODO: overload to accept functions like gtk_spin_button_new?
 354     // Until then use a similar type
 355     return GetDefaultAttributesFromGTKWidget(gtk_entry_new, true);
 356 }
 357
 358 //-----------------------------------------------------------------------------
 359 // wxSpinCtrl
 360 //-----------------------------------------------------------------------------
 361
 362 extern "C"
 363 {
 364
 365 static gboolean
 366 wx_gtk_spin_input(GtkSpinButton* spin, gdouble* val, wxSpinCtrl* win)
 367 {
 368     // We might use g_ascii_strtoll() here but it's 2.12+ only, so use our own
 369     // wxString function even if this requires an extra conversion.
 370     const wxString
 371         text(wxString::FromUTF8(gtk_entry_get_text(GTK_ENTRY(spin))));
 372
 373     long lval;
 374     if ( !text.ToLong(&lval, win->GetBase()) )
 375         return FALSE;
 376
 377     *val = lval;
 378
 379     return TRUE;
 380 }
 381
 382 static gint
 383 wx_gtk_spin_output(GtkSpinButton* spin, wxSpinCtrl* win)
 384 {
 385     const gint val = gtk_spin_button_get_value_as_int(spin);
 386
 387     gtk_entry_set_text
 388     (
 389         GTK_ENTRY(spin),
 390         wxPrivate::wxSpinCtrlFormatAsHex(val, win->GetMax()).utf8_str()
 391     );
 392
 393     return TRUE;
 394 }
 395
 396 } // extern "C"
 397
 398 bool wxSpinCtrl::SetBase(int base)
 399 {
 400     // Currently we only support base 10 and 16. We could add support for base
 401     // 8 quite easily but wxMSW doesn't support it natively so don't bother
 402     // with doing something wxGTK-specific here.
 403     if ( base != 10 && base != 16 )
 404         return false;
 405
 406     if ( base == m_base )
 407         return true;
 408
 409     m_base = base;
 410
 411     // We need to be able to enter letters for any base greater than 10.
 412     gtk_spin_button_set_numeric( GTK_SPIN_BUTTON(m_widget), m_base <= 10 );
 413
 414     if ( m_base != 10 )
 415     {
 416         g_signal_connect( m_widget, "input",
 417                               G_CALLBACK(wx_gtk_spin_input), this);
 418         g_signal_connect( m_widget, "output",
 419                               G_CALLBACK(wx_gtk_spin_output), this);
 420     }
 421     else
 422     {
 423         g_signal_handlers_disconnect_by_func(m_widget,
 424                                              (gpointer)wx_gtk_spin_input,
 425                                              this);
 426         g_signal_handlers_disconnect_by_func(m_widget,
 427                                              (gpointer)wx_gtk_spin_output,
 428                                              this);
 429     }
 430
 431     return true;
 432 }
 433
 434 //-----------------------------------------------------------------------------
 435 // wxSpinCtrlDouble
 436 //-----------------------------------------------------------------------------
 437
 438 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrlDouble, wxSpinCtrlGTKBase)
 439
 440 unsigned wxSpinCtrlDouble::GetDigits() const
 441 {
 442     wxCHECK_MSG( m_widget, 0, "invalid spin button" );
 443
 444     return gtk_spin_button_get_digits( GTK_SPIN_BUTTON(m_widget) );
 445 }
 446
 447 void wxSpinCtrlDouble::SetDigits(unsigned digits)
 448 {
 449     wxCHECK_RET( m_widget, "invalid spin button" );
 450
 451     gtk_spin_button_set_digits( GTK_SPIN_BUTTON(m_widget), digits);
 452 }
 453
 454 #endif // wxUSE_SPINCTRL