src/gtk/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     g_signal_handlers_disconnect_by_func (m_adjust,
 137                                           (gpointer) gtk_spinctrl_callback,
 138                                           this);
 139     g_signal_handlers_disconnect_by_func (m_widget,
 140                                           (gpointer) gtk_spinctrl_text_changed_callback,
 141                                           this);
 142 }
 143
 144 void wxSpinCtrl::GtkEnableEvents()
 145 {
 146     g_signal_connect (m_adjust, "value_changed",
 147                       G_CALLBACK (gtk_spinctrl_callback),
 148                       this);
 149     g_signal_connect (m_widget, "changed",
 150                       G_CALLBACK (gtk_spinctrl_text_changed_callback),
 151                       this);
 152 }
 153
 154 int wxSpinCtrl::GetMin() const
 155 {
 156     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 157
 158     return (int)ceil(m_adjust->lower);
 159 }
 160
 161 int wxSpinCtrl::GetMax() const
 162 {
 163     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 164
 165     return (int)ceil(m_adjust->upper);
 166 }
 167
 168 int wxSpinCtrl::GetValue() const
 169 {
 170     wxCHECK_MSG( (m_widget != NULL), 0, wxT("invalid spin button") );
 171
 172     gtk_spin_button_update( GTK_SPIN_BUTTON(m_widget) );
 173
 174     return (int)ceil(m_adjust->value);
 175 }
 176
 177 void wxSpinCtrl::SetValue( const wxString& value )
 178 {
 179     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 180
 181     int n;
 182     if ( (wxSscanf(value, wxT("%d"), &n) == 1) )
 183     {
 184         // a number - set it
 185         SetValue(n);
 186     }
 187     else
 188     {
 189         // invalid number - set text as is (wxMSW compatible)
 190         GtkDisableEvents();
 191         gtk_entry_set_text( GTK_ENTRY(m_widget), wxGTK_CONV( value ) );
 192         GtkEnableEvents();
 193     }
 194 }
 195
 196 void wxSpinCtrl::SetValue( int value )
 197 {
 198     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 199
 200     float fpos = (float)value;
 201     m_oldPos = fpos;
 202     if (fabs(fpos-m_adjust->value) < sensitivity) return;
 203
 204     m_adjust->value = fpos;
 205
 206     GtkDisableEvents();
 207     g_signal_emit_by_name (m_adjust, "value_changed");
 208     GtkEnableEvents();
 209 }
 210
 211 void wxSpinCtrl::SetSelection(long from, long to)
 212 {
 213     // translate from wxWidgets conventions to GTK+ ones: (-1, -1) means the
 214     // entire range
 215     if ( from == -1 && to == -1 )
 216     {
 217         from = 0;
 218         to = INT_MAX;
 219     }
 220
 221     gtk_editable_select_region( GTK_EDITABLE(m_widget), (gint)from, (gint)to );
 222 }
 223
 224 void wxSpinCtrl::SetRange(int minVal, int maxVal)
 225 {
 226     wxCHECK_RET( (m_widget != NULL), wxT("invalid spin button") );
 227
 228     float fmin = (float)minVal;
 229     float fmax = (float)maxVal;
 230
 231     if ((fabs(fmin-m_adjust->lower) < sensitivity) &&
 232         (fabs(fmax-m_adjust->upper) < sensitivity))
 233     {
 234         return;
 235     }
 236
 237     m_adjust->lower = fmin;
 238     m_adjust->upper = fmax;
 239
 240     g_signal_emit_by_name (m_adjust, "changed");
 241
 242     // these two calls are required due to some bug in GTK
 243     Refresh();
 244     SetFocus();
 245 }
 246
 247 void wxSpinCtrl::OnChar( wxKeyEvent &event )
 248 {
 249     wxCHECK_RET( m_widget != NULL, wxT("invalid spin ctrl") );
 250
 251     if (event.GetKeyCode() == WXK_RETURN)
 252     {
 253         wxWindow *top_frame = m_parent;
 254         while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 255             top_frame = top_frame->GetParent();
 256
 257         if ( GTK_IS_WINDOW(top_frame->m_widget) )
 258         {
 259             GtkWindow *window = GTK_WINDOW(top_frame->m_widget);
 260             if ( window )
 261             {
 262                 GtkWidget *widgetDef = window->default_widget;
 263
 264                 if ( widgetDef )
 265                 {
 266                     gtk_widget_activate(widgetDef);
 267                     return;
 268                 }
 269             }
 270         }
 271     }
 272
 273     if ((event.GetKeyCode() == WXK_RETURN) && (m_windowStyle & wxPROCESS_ENTER))
 274     {
 275         wxCommandEvent evt( wxEVT_COMMAND_TEXT_ENTER, m_windowId );
 276         evt.SetEventObject(this);
 277         GtkSpinButton *gsb = GTK_SPIN_BUTTON(m_widget);
 278         wxString val = wxGTK_CONV_BACK( gtk_entry_get_text( &gsb->entry ) );
 279         evt.SetString( val );
 280         if (GetEventHandler()->ProcessEvent(evt)) return;
 281     }
 282
 283     event.Skip();
 284 }
 285
 286 bool wxSpinCtrl::IsOwnGtkWindow( GdkWindow *window )
 287 {
 288     if (GTK_SPIN_BUTTON(m_widget)->entry.text_area == window) return TRUE;
 289
 290     if (GTK_SPIN_BUTTON(m_widget)->panel == window) return TRUE;
 291
 292     return FALSE;
 293 }
 294
 295 wxSize wxSpinCtrl::DoGetBestSize() const
 296 {
 297     wxSize ret( wxControl::DoGetBestSize() );
 298     wxSize best(95, ret.y);
 299     CacheBestSize(best);
 300     return best;
 301 }
 302
 303 // static
 304 wxVisualAttributes
 305 wxSpinCtrl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 306 {
 307     // TODO: overload to accept functions like gtk_spin_button_new?
 308     // Until then use a similar type
 309     return GetDefaultAttributesFromGTKWidget(gtk_entry_new, true);
 310 }
 311
 312 #endif
 313    // wxUSE_SPINCTRL