src/gtk1/spinctrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #include "wx/spinctrl.h"
  15
  16 #if wxUSE_SPINCTRL
  17
  18 #include "wx/utils.h"
  19
  20 #include "wx/textctrl.h"    // for wxEVT_COMMAND_TEXT_UPDATED
  21 #include "wx/math.h"
  22 #include "wx/gtk/private.h"
  23
  24 //-----------------------------------------------------------------------------
  25 // idle system
  26 //-----------------------------------------------------------------------------
  27
  28 extern void wxapp_install_idle_handler();
  29 extern bool g_isIdle;
  30
  31 static const float sensitivity = 0.02;
  32
  33 //-----------------------------------------------------------------------------
  34 // data
  35 //-----------------------------------------------------------------------------
  36
  37 extern bool   g_blockEventsOnDrag;
  38
  39 //-----------------------------------------------------------------------------
  40 // "value_changed"
  41 //-----------------------------------------------------------------------------
  42
  43 extern "C" {
  44 static void gtk_spinctrl_callback( GtkWidget *WXUNUSED(widget), wxSpinCtrl *win )
  45 {
  46     if (g_isIdle) wxapp_install_idle_handler();
  47
  48     if (!win->m_hasVMT) return;
  49     if (g_blockEventsOnDrag) return;
  50
  51     wxCommandEvent event( wxEVT_COMMAND_SPINCTRL_UPDATED, win->GetId());
  52     event.SetEventObject( win );
  53
  54     // note that we don't use wxSpinCtrl::GetValue() here because it would
  55     // adjust the value to fit into the control range and this means that we
  56     // would never be able to enter an "invalid" value in the control, even
  57     // temporarily - and trying to enter 10 into the control which accepts the
  58     // values in range 5..50 is then, ummm, quite challenging (hint: you can't
  59     // enter 1!) (VZ)
  60     event.SetInt( (int)ceil(win->m_adjust->value) );
  61     win->GetEventHandler()->ProcessEvent( event );
  62 }
  63 }
  64
  65 //-----------------------------------------------------------------------------
  66 //  "changed"
  67 //-----------------------------------------------------------------------------
  68
  69 extern "C" {
  70 static void
  71 gtk_spinctrl_text_changed_callback( GtkWidget *WXUNUSED(widget), wxSpinCtrl *win )
  72 {
  73     if (!win->m_hasVMT) return;
  74
  75     if (g_isIdle)
  76         wxapp_install_idle_handler();
  77
  78     wxCommandEvent event( wxEVT_COMMAND_TEXT_UPDATED, win->GetId() );
  79     event.SetEventObject( win );
  80
  81     // see above
  82     event.SetInt( (int)ceil(win->m_adjust->value) );
  83     win->GetEventHandler()->ProcessEvent( event );
  84 }
  85 }
  86
  87 //-----------------------------------------------------------------------------
  88 // wxSpinCtrl
  89 //-----------------------------------------------------------------------------
  90
  91 IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl,wxControl)
  92
  93 BEGIN_EVENT_TABLE(wxSpinCtrl, wxControl)
  94     EVT_CHAR(wxSpinCtrl::OnChar)
  95 END_EVENT_TABLE()
  96
  97 bool wxSpinCtrl::Create(wxWindow *parent, wxWindowID id,
  98                         const wxString& value,
  99                         const wxPoint& pos,  const wxSize& size,
 100                         long style,
 101                         int min, int max, int initial,
 102                         const wxString& name)
 103 {
 104     m_needParent = TRUE;
 105     m_acceptsFocus = TRUE;
 106
 107     if (!PreCreation( parent, pos, size ) ||
 108         !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 109     {
 110         wxFAIL_MSG( wxT("wxSpinCtrl creation failed") );
 111         return FALSE;
 112     }
 113
 114     m_oldPos = initial;
 115
 116     m_adjust = (GtkAdjustment*) gtk_adjustment_new( initial, min, max, 1.0, 5.0, 0.0);
 117
 118     m_widget = gtk_spin_button_new( m_adjust, 1, 0 );
 119
 120     gtk_spin_button_set_wrap( GTK_SPIN_BUTTON(m_widget),
 121                               (int)(m_windowStyle & wxSP_WRAP) );
 122
 123     GtkEnableEvents();
 124
 125     m_parent->DoAddChild( this );
 126
 127     PostCreation(size);
 128
 129     SetValue( value );
 130
 131     return TRUE;
 132 }
 133
 134 void wxSpinCtrl::GtkDisableEvents()
 135 {
 136     gtk_signal_disconnect_by_func( GTK_OBJECT(m_adjust),
 137                         GTK_SIGNAL_FUNC(gtk_spinctrl_callback),
 138                         (gpointer) this );
 139
 140     gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget),
 141                         GTK_SIGNAL_FUNC(gtk_spinctrl_text_changed_callback),
 142                         (gpointer) this );
 143 }
 144
 145 void wxSpinCtrl::GtkEnableEvents()
 146 {
 147     gtk_signal_connect( GTK_OBJECT (m_adjust),
 148                         "value_changed",
 149                         GTK_SIGNAL_FUNC(gtk_spinctrl_callback),
 150                         (gpointer) this );
 151
 152     gtk_signal_connect( GTK_OBJECT(m_widget),
 153                         "changed",
 154                         GTK_SIGNAL_FUNC(gtk_spinctrl_text_changed_callback),
 155                         (gpointer)this);
 156 }
 157
 158 int wxSpinCtrl::GetMin() const
 159 {
 160     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 161
 162     return (int)ceil(m_adjust->lower);
 163 }
 164
 165 int wxSpinCtrl::GetMax() const
 166 {
 167     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 168
 169     return (int)ceil(m_adjust->upper);
 170 }
 171
 172 int wxSpinCtrl::GetValue() const
 173 {
 174     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 175
 176     gtk_spin_button_update( GTK_SPIN_BUTTON(m_widget) );
 177
 178     return (int)ceil(m_adjust->value);
 179 }
 180
 181 void wxSpinCtrl::SetValue( const wxString& value )
 182 {
 183     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 184
 185     int n;
 186     if ( (wxSscanf(value, wxT("%d"), &n) == 1) )
 187     {
 188         // a number - set it
 189         SetValue(n);
 190     }
 191     else
 192     {
 193         // invalid number - set text as is (wxMSW compatible)
 194         GtkDisableEvents();
 195         gtk_entry_set_text( GTK_ENTRY(m_widget), wxGTK_CONV( value ) );
 196         GtkEnableEvents();
 197     }
 198 }
 199
 200 void wxSpinCtrl::SetValue( int value )
 201 {
 202     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 203
 204     float fpos = (float)value;
 205     m_oldPos = fpos;
 206     if (fabs(fpos-m_adjust->value) < sensitivity) return;
 207
 208     m_adjust->value = fpos;
 209
 210     GtkDisableEvents();
 211     gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "value_changed" );
 212     GtkEnableEvents();
 213 }
 214
 215 void wxSpinCtrl::SetSelection(long from, long to)
 216 {
 217     // translate from wxWidgets conventions to GTK+ ones: (-1, -1) means the
 218     // entire range
 219     if ( from == -1 && to == -1 )
 220     {
 221         from = 0;
 222         to = INT_MAX;
 223     }
 224
 225     gtk_editable_select_region( GTK_EDITABLE(m_widget), (gint)from, (gint)to );
 226 }
 227
 228 void wxSpinCtrl::SetRange(int minVal, int maxVal)
 229 {
 230     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 231
 232     float fmin = (float)minVal;
 233     float fmax = (float)maxVal;
 234
 235     if ((fabs(fmin-m_adjust->lower) < sensitivity) &&
 236         (fabs(fmax-m_adjust->upper) < sensitivity))
 237     {
 238         return;
 239     }
 240
 241     m_adjust->lower = fmin;
 242     m_adjust->upper = fmax;
 243
 244     gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
 245
 246     // these two calls are required due to some bug in GTK
 247     Refresh();
 248     SetFocus();
 249 }
 250
 251 void wxSpinCtrl::OnChar( wxKeyEvent &event )
 252 {
 253     wxCHECK_RET( m_widget != NULL, wxT("invalid spin ctrl") );
 254
 255     if (event.GetKeyCode() == WXK_RETURN)
 256     {
 257         wxWindow *top_frame = m_parent;
 258         while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 259             top_frame = top_frame->GetParent();
 260
 261         if ( GTK_IS_WINDOW(top_frame->m_widget) )
 262         {
 263             GtkWindow *window = GTK_WINDOW(top_frame->m_widget);
 264             if ( window )
 265             {
 266                 GtkWidget *widgetDef = window->default_widget;
 267
 268                 if ( widgetDef )
 269                 {
 270                     gtk_widget_activate(widgetDef);
 271                     return;
 272                 }
 273             }
 274         }
 275     }
 276
 277     if ((event.GetKeyCode() == WXK_RETURN) && (m_windowStyle & wxPROCESS_ENTER))
 278     {
 279         wxCommandEvent evt( wxEVT_COMMAND_TEXT_ENTER, m_windowId );
 280         evt.SetEventObject(this);
 281         GtkSpinButton *gsb = GTK_SPIN_BUTTON(m_widget);
 282         wxString val = wxGTK_CONV_BACK( gtk_entry_get_text( &gsb->entry ) );
 283         evt.SetString( val );
 284         if (GetEventHandler()->ProcessEvent(evt)) return;
 285     }
 286
 287     event.Skip();
 288 }
 289
 290 bool wxSpinCtrl::IsOwnGtkWindow( GdkWindow *window )
 291 {
 292     if (GTK_SPIN_BUTTON(m_widget)->entry.text_area == window) return TRUE;
 293
 294     if (GTK_SPIN_BUTTON(m_widget)->panel == window) return TRUE;
 295
 296     return FALSE;
 297 }
 298
 299 wxSize wxSpinCtrl::DoGetBestSize() const
 300 {
 301     wxSize ret( wxControl::DoGetBestSize() );
 302     wxSize best(95, ret.y);
 303     CacheBestSize(best);
 304     return best;
 305 }
 306
 307 // static
 308 wxVisualAttributes
 309 wxSpinCtrl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 310 {
 311     // TODO: overload to accept functions like gtk_spin_button_new?
 312     // Until then use a similar type
 313     return GetDefaultAttributesFromGTKWidget(gtk_entry_new, true);
 314 }
 315
 316 #endif
 317    // wxUSE_SPINCTRL