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, wxSpinCtrl* win)
  39 {
  40     win->m_pos = int(gtk_spin_button_get_value(spinbutton));
  41     if (!win->m_hasVMT || g_blockEventsOnDrag || win->m_blockScrollEvent)
  42         return;
  43
  44     wxCommandEvent event( wxEVT_COMMAND_SPINCTRL_UPDATED, win->GetId());
  45     event.SetEventObject( win );
  46
  47     // note that we don't use wxSpinCtrl::GetValue() here because it would
  48     // adjust the value to fit into the control range and this means that we
  49     // would never be able to enter an "invalid" value in the control, even
  50     // temporarily - and trying to enter 10 into the control which accepts the
  51     // values in range 5..50 is then, ummm, quite challenging (hint: you can't
  52     // enter 1!) (VZ)
  53     event.SetInt(win->m_pos);
  54     win->GetEventHandler()->ProcessEvent( event );
  55 }
  56 }
  57
  58 //-----------------------------------------------------------------------------
  59 //  "changed"
  60 //-----------------------------------------------------------------------------
  61
  62 extern "C" {
  63 static void
  64 gtk_changed(GtkSpinButton* spinbutton, wxSpinCtrl* win)
  65 {
  66     if (!win->m_hasVMT || win->m_blockScrollEvent)
  67         return;
  68
  69     wxCommandEvent event( wxEVT_COMMAND_TEXT_UPDATED, win->GetId() );
  70     event.SetEventObject( win );
  71     event.SetString( GTK_ENTRY(spinbutton)->text );
  72
  73     // see above
  74     event.SetInt(win->m_pos);
  75     win->GetEventHandler()->ProcessEvent( event );
  76 }
  77 }
  78
  79 //-----------------------------------------------------------------------------
  80 // wxSpinCtrl
  81 //-----------------------------------------------------------------------------
  82
  83 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl,wxControl)
  84
  85 BEGIN_EVENT_TABLE(wxSpinCtrl, wxControl)
  86     EVT_CHAR(wxSpinCtrl::OnChar)
  87 END_EVENT_TABLE()
  88
  89 wxSpinCtrl::wxSpinCtrl()
  90 {
  91     m_pos = 0;
  92 }
  93
  94 bool wxSpinCtrl::Create(wxWindow *parent, wxWindowID id,
  95                         const wxString& value,
  96                         const wxPoint& pos,  const wxSize& size,
  97                         long style,
  98                         int min, int max, int initial,
  99                         const wxString& name)
 100 {
 101     if (!PreCreation( parent, pos, size ) ||
 102         !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 103     {
 104         wxFAIL_MSG( wxT("wxSpinCtrl creation failed") );
 105         return false;
 106     }
 107
 108     m_widget = gtk_spin_button_new_with_range(min, max, 1);
 109     gtk_spin_button_set_value((GtkSpinButton*)m_widget, initial);
 110     m_pos = int(gtk_spin_button_get_value((GtkSpinButton*)m_widget));
 111
 112     gtk_spin_button_set_wrap( GTK_SPIN_BUTTON(m_widget),
 113                               (int)(m_windowStyle & wxSP_WRAP) );
 114
 115     g_signal_connect_after(m_widget, "value_changed", G_CALLBACK(gtk_value_changed), this);
 116     g_signal_connect_after(m_widget, "changed", G_CALLBACK(gtk_changed), this);
 117
 118     m_parent->DoAddChild( this );
 119
 120     PostCreation(size);
 121
 122     if (!value.empty())
 123     {
 124         SetValue(value);
 125     }
 126
 127     return true;
 128 }
 129
 130 int wxSpinCtrl::GetMin() const
 131 {
 132     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 133
 134     double min;
 135     gtk_spin_button_get_range((GtkSpinButton*)m_widget, &min, NULL);
 136     return int(min);
 137 }
 138
 139 int wxSpinCtrl::GetMax() const
 140 {
 141     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 142
 143     double max;
 144     gtk_spin_button_get_range((GtkSpinButton*)m_widget, NULL, &max);
 145     return int(max);
 146 }
 147
 148 int wxSpinCtrl::GetValue() const
 149 {
 150     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 151
 152     GtkDisableEvents();
 153     gtk_spin_button_update( GTK_SPIN_BUTTON(m_widget) );
 154     GtkEnableEvents();
 155
 156     return m_pos;
 157 }
 158
 159 void wxSpinCtrl::SetValue( const wxString& value )
 160 {
 161     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 162
 163     int n;
 164     if ( (wxSscanf(value, wxT("%d"), &n) == 1) )
 165     {
 166         // a number - set it
 167         SetValue(n);
 168     }
 169     else
 170     {
 171         // invalid number - set text as is (wxMSW compatible)
 172         GtkDisableEvents();
 173         gtk_entry_set_text( GTK_ENTRY(m_widget), wxGTK_CONV( value ) );
 174         GtkEnableEvents();
 175     }
 176 }
 177
 178 void wxSpinCtrl::SetValue( int value )
 179 {
 180     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 181
 182     GtkDisableEvents();
 183     gtk_spin_button_set_value((GtkSpinButton*)m_widget, value);
 184     GtkEnableEvents();
 185 }
 186
 187 void wxSpinCtrl::SetSelection(long from, long to)
 188 {
 189     // translate from wxWidgets conventions to GTK+ ones: (-1, -1) means the
 190     // entire range
 191     if ( from == -1 && to == -1 )
 192     {
 193         from = 0;
 194         to = INT_MAX;
 195     }
 196
 197     gtk_editable_select_region( GTK_EDITABLE(m_widget), (gint)from, (gint)to );
 198 }
 199
 200 void wxSpinCtrl::SetRange(int minVal, int maxVal)
 201 {
 202     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 203
 204     GtkDisableEvents();
 205     gtk_spin_button_set_range((GtkSpinButton*)m_widget, minVal, maxVal);
 206     GtkEnableEvents();
 207 }
 208
 209
 210 void wxSpinCtrl::GtkDisableEvents() const
 211 {
 212     g_signal_handlers_block_by_func( m_widget,
 213         (gpointer)gtk_value_changed, (void*) this);
 214
 215     g_signal_handlers_block_by_func(m_widget,
 216         (gpointer)gtk_changed, (void*) this);
 217 }
 218
 219 void wxSpinCtrl::GtkEnableEvents() const
 220 {
 221     g_signal_handlers_unblock_by_func(m_widget,
 222         (gpointer)gtk_value_changed, (void*) this);
 223
 224     g_signal_handlers_unblock_by_func(m_widget,
 225         (gpointer)gtk_changed, (void*) this);
 226 }
 227
 228 void wxSpinCtrl::OnChar( wxKeyEvent &event )
 229 {
 230     wxCHECK_RET( m_widget != NULL, wxT("invalid spin ctrl") );
 231
 232     if (event.GetKeyCode() == WXK_RETURN)
 233     {
 234         wxWindow *top_frame = wxGetTopLevelParent(m_parent);
 235
 236         if ( GTK_IS_WINDOW(top_frame->m_widget) )
 237         {
 238             GtkWindow *window = GTK_WINDOW(top_frame->m_widget);
 239             if ( window )
 240             {
 241                 GtkWidget *widgetDef = window->default_widget;
 242
 243                 if ( widgetDef )
 244                 {
 245                     gtk_widget_activate(widgetDef);
 246                     return;
 247                 }
 248             }
 249         }
 250     }
 251
 252     if ((event.GetKeyCode() == WXK_RETURN) && (m_windowStyle & wxTE_PROCESS_ENTER))
 253     {
 254         wxCommandEvent evt( wxEVT_COMMAND_TEXT_ENTER, m_windowId );
 255         evt.SetEventObject(this);
 256         GtkSpinButton *gsb = GTK_SPIN_BUTTON(m_widget);
 257         wxString val = wxGTK_CONV_BACK( gtk_entry_get_text( &gsb->entry ) );
 258         evt.SetString( val );
 259         if (GetEventHandler()->ProcessEvent(evt)) return;
 260     }
 261
 262     event.Skip();
 263 }
 264
 265 GdkWindow *wxSpinCtrl::GTKGetWindow(wxArrayGdkWindows& windows) const
 266 {
 267     GtkSpinButton* spinbutton = GTK_SPIN_BUTTON(m_widget);
 268
 269     windows.push_back(spinbutton->entry.text_area);
 270     windows.push_back(spinbutton->panel);
 271
 272     return NULL;
 273 }
 274
 275 wxSize wxSpinCtrl::DoGetBestSize() const
 276 {
 277     wxSize ret( wxControl::DoGetBestSize() );
 278     wxSize best(95, ret.y); // FIXME: 95?
 279     CacheBestSize(best);
 280     return best;
 281 }
 282
 283 // static
 284 wxVisualAttributes
 285 wxSpinCtrl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 286 {
 287     // TODO: overload to accept functions like gtk_spin_button_new?
 288     // Until then use a similar type
 289     return GetDefaultAttributesFromGTKWidget(gtk_entry_new, true);
 290 }
 291
 292 #endif
 293    // wxUSE_SPINCTRL