src/motif/spinbutt.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/motif/spinbutt.cpp
   3 // Purpose:     wxSpinButton
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #if wxUSE_SPINBTN
  16
  17 #include "wx/spinbutt.h"
  18
  19 #ifndef WX_PRECOMP
  20     #include "wx/timer.h"
  21 #endif
  22
  23 #include "wx/spinctrl.h"
  24
  25 #ifdef __VMS__
  26 #pragma message disable nosimpint
  27 #endif
  28 #include <Xm/ArrowBG.h>
  29 #include <Xm/ArrowB.h>
  30 #ifdef __VMS__
  31 #pragma message enable nosimpint
  32 #endif
  33
  34 #include "wx/motif/private.h"
  35
  36 // helper class
  37 enum ArrowDirection
  38 {
  39     wxARROW_UP,
  40     wxARROW_DOWN,
  41     wxARROW_LEFT,
  42     wxARROW_RIGHT
  43 };
  44
  45 class wxArrowButtonTimer;
  46 class wxArrowButton;
  47
  48 // ----------------------------------------------------------------------------
  49 // wxArrowButtonTimer
  50 // ----------------------------------------------------------------------------
  51
  52 static const unsigned int TICK_BEFORE_START = 10;
  53 static const unsigned int TICK_BEFORE_EXPONENTIAL = 40;
  54 static const unsigned int MAX_INCREMENT = 150;
  55 static const unsigned int TICK_INTERVAL = 113;
  56
  57 class wxArrowButtonTimer : public wxTimer
  58 {
  59 public:
  60     wxArrowButtonTimer( wxArrowButton* btn, int sign )
  61         : m_sign( sign ),
  62           m_button( btn )
  63         { Reset(); };
  64
  65     void Notify();
  66     void Reset() { m_ticks = 0; m_increment = 1; }
  67 private:
  68     unsigned int m_ticks;
  69     unsigned int m_increment;
  70     int m_sign;
  71     wxArrowButton* m_button;
  72 };
  73
  74 // ----------------------------------------------------------------------------
  75 // wxArrowButton
  76 // ----------------------------------------------------------------------------
  77
  78 class wxArrowButton : public wxControl
  79 {
  80     friend class wxArrowButtonTimer;
  81 public:
  82     wxArrowButton( int increment )
  83         : m_increment( increment ),
  84           m_timer( 0 ) {}
  85
  86     wxArrowButton( wxSpinButton* parent, wxWindowID id, ArrowDirection d,
  87                    const wxPoint& pos = wxDefaultPosition,
  88                    const wxSize& size = wxDefaultSize, int increment = 1 )
  89         : wxControl(),
  90           m_increment( increment ),
  91           m_timer( 0 )
  92     {
  93         Create( parent, id, d, pos, size );
  94     }
  95
  96     virtual ~wxArrowButton()
  97         { delete m_timer; }
  98
  99     bool Create( wxSpinButton* parent, wxWindowID id, ArrowDirection d,
 100                  const wxPoint& pos = wxDefaultPosition,
 101                  const wxSize& size = wxDefaultSize );
 102 private:
 103     // creates a new timer object, or stops the currently running one
 104     wxTimer* GetFreshTimer();
 105     wxSpinButton* GetSpinButton() { return (wxSpinButton*)GetParent(); }
 106     static void SpinButtonCallback( Widget w, XtPointer clientData,
 107                                     XtPointer WXUNUSED(ptr) );
 108     static void StartTimerCallback( Widget w, XtPointer clientData,
 109                                     XtPointer WXUNUSED(ptr) );
 110
 111     static void  StopTimerCallback( Widget w, XtPointer clientData,
 112                                     XtPointer WXUNUSED(ptr) );
 113
 114     int m_increment;
 115     wxArrowButtonTimer* m_timer;
 116 };
 117
 118 // ----------------------------------------------------------------------------
 119 // wxArrowButtonTimer implementation
 120 // ----------------------------------------------------------------------------
 121
 122 void wxArrowButtonTimer::Notify()
 123 {
 124     ++m_ticks;
 125     if( m_ticks < TICK_BEFORE_START ) return;
 126     // increment every other tick
 127     if( m_ticks <= TICK_BEFORE_EXPONENTIAL && m_ticks & 1 )
 128         return;
 129     if( m_ticks > TICK_BEFORE_EXPONENTIAL )
 130         m_increment = 2 * m_increment;
 131     if( m_increment >= MAX_INCREMENT ) m_increment = MAX_INCREMENT;
 132     m_button->GetSpinButton()->Increment( m_sign * m_increment );
 133 }
 134
 135 // ----------------------------------------------------------------------------
 136 // wxArrowButton implementation
 137 // ----------------------------------------------------------------------------
 138
 139 wxTimer* wxArrowButton::GetFreshTimer()
 140 {
 141     if( m_timer )
 142     {
 143         m_timer->Stop();
 144         m_timer->Reset();
 145     }
 146     else
 147         m_timer = new wxArrowButtonTimer( this, m_increment );
 148
 149     return m_timer;
 150 }
 151
 152 void wxArrowButton::SpinButtonCallback( Widget w, XtPointer clientData,
 153                                         XtPointer WXUNUSED(ptr) )
 154 {
 155     if( !wxGetWindowFromTable( w ) )
 156         // Widget has been deleted!
 157         return;
 158
 159     wxArrowButton* btn = (wxArrowButton*)clientData;
 160
 161     btn->GetSpinButton()->Increment( btn->m_increment );
 162 }
 163
 164 void wxArrowButton::StartTimerCallback( Widget w, XtPointer clientData,
 165                                         XtPointer WXUNUSED(ptr) )
 166 {
 167     if( !wxGetWindowFromTable( w ) )
 168         // Widget has been deleted!
 169         return;
 170
 171     wxArrowButton* btn = (wxArrowButton*)clientData;
 172     btn->GetFreshTimer()->Start( TICK_INTERVAL );
 173 }
 174
 175 void wxArrowButton::StopTimerCallback( Widget w, XtPointer clientData,
 176                                        XtPointer WXUNUSED(ptr) )
 177 {
 178     if( !wxGetWindowFromTable( w ) )
 179         // Widget has been deleted!
 180         return;
 181
 182     wxArrowButton* btn = (wxArrowButton*)clientData;
 183     delete btn->m_timer;
 184     btn->m_timer = 0;
 185 }
 186
 187 bool wxArrowButton::Create( wxSpinButton* parent,
 188                             wxWindowID WXUNUSED(id),
 189                             ArrowDirection d,
 190                             const wxPoint& pos, const wxSize& size )
 191 {
 192     int arrow_dir = XmARROW_UP;
 193
 194     switch( d )
 195     {
 196     case wxARROW_UP:
 197         arrow_dir = XmARROW_UP;
 198         break;
 199     case wxARROW_DOWN:
 200         arrow_dir = XmARROW_DOWN;
 201         break;
 202     case wxARROW_LEFT:
 203         arrow_dir = XmARROW_LEFT;
 204         break;
 205     case wxARROW_RIGHT:
 206         arrow_dir = XmARROW_RIGHT;
 207         break;
 208     }
 209
 210     if( parent ) parent->AddChild( this );
 211
 212     Widget parentWidget = (Widget) parent->GetClientWidget();
 213     m_mainWidget = (WXWidget) XtVaCreateManagedWidget( "XmArrowButton",
 214         xmArrowButtonWidgetClass,
 215         parentWidget,
 216         XmNarrowDirection, arrow_dir,
 217         XmNborderWidth, 0,
 218         XmNshadowThickness, 0,
 219         NULL );
 220
 221     XtAddCallback( (Widget) m_mainWidget,
 222                    XmNactivateCallback, (XtCallbackProc) SpinButtonCallback,
 223                    (XtPointer) this );
 224     XtAddCallback( (Widget) m_mainWidget,
 225                    XmNarmCallback, (XtCallbackProc) StartTimerCallback,
 226                    (XtPointer) this );
 227     XtAddCallback( (Widget) m_mainWidget,
 228                    XmNactivateCallback, (XtCallbackProc) StopTimerCallback,
 229                    (XtPointer) this );
 230
 231     AttachWidget( parent, m_mainWidget, (WXWidget) NULL,
 232                   pos.x, pos.y, size.x, size.y );
 233
 234     SetForegroundColour( parent->GetBackgroundColour() );
 235
 236     return true;
 237 }
 238
 239 // ----------------------------------------------------------------------------
 240 // wxSpinButton
 241 // ----------------------------------------------------------------------------
 242
 243 IMPLEMENT_DYNAMIC_CLASS(wxSpinButton, wxControl)
 244 IMPLEMENT_DYNAMIC_CLASS(wxSpinEvent, wxNotifyEvent)
 245
 246 static void CalcSizes( const wxPoint& pt, const wxSize& sz,
 247                        wxPoint& pt1, wxSize& sz1,
 248                        wxPoint& pt2, wxSize& sz2,
 249                        bool isVertical )
 250 {
 251     typedef int wxSize::* CDPTR1;
 252     typedef int wxPoint::* CDPTR2;
 253
 254     sz1 = sz2 = sz;
 255     pt2 = pt1 = pt;
 256
 257     CDPTR1 szm = isVertical ? &wxSize::y : &wxSize::x;
 258     CDPTR2 ptm = isVertical ? &wxPoint::y : &wxPoint::x;
 259     int dim = sz.*szm, half = dim/2;
 260
 261     sz1.*szm = half;
 262     sz2.*szm = dim - half;
 263     pt2.*ptm += half + 1;
 264 }
 265
 266 bool wxSpinButton::Create( wxWindow *parent, wxWindowID id,
 267                            const wxPoint& pos, const wxSize& size,
 268                            long style, const wxString& name )
 269 {
 270     m_windowStyle = style;
 271
 272     wxSize newSize = GetBestSize();
 273     if( size.x != -1 ) newSize.x = size.x;
 274     if( size.y != -1 ) newSize.y = size.y;
 275
 276     if( !wxControl::Create( parent, id, pos, newSize, style ) )
 277     {
 278         return false;
 279     }
 280
 281     SetName(name);
 282
 283     m_windowId = ( id == wxID_ANY ) ? NewControlId() : id;
 284
 285     bool isVert = IsVertical();
 286     wxPoint pt1, pt2;
 287     wxSize sz1, sz2;
 288     CalcSizes( wxPoint(0,0), newSize, pt1, sz1, pt2, sz2, isVert );
 289     m_up = new wxArrowButton( this, -1, isVert ? wxARROW_UP : wxARROW_RIGHT,
 290                               pt1, sz1, 1 );
 291     m_down = new wxArrowButton( this, -1,
 292                                 isVert ? wxARROW_DOWN : wxARROW_LEFT,
 293                                 pt2, sz2, -1 );
 294
 295     return true;
 296 }
 297
 298 wxSpinButton::~wxSpinButton()
 299 {
 300 }
 301
 302 void wxSpinButton::DoMoveWindow(int x, int y, int width, int height)
 303 {
 304     wxControl::DoMoveWindow( x, y, width, height );
 305
 306     wxPoint pt1, pt2;
 307     wxSize sz1, sz2;
 308
 309     CalcSizes( wxPoint(0,0), wxSize(width,height), pt1,
 310                sz1, pt2, sz2, IsVertical() );
 311     m_up->SetSize( pt1.x, pt1.y, sz1.x, sz1.y );
 312     m_down->SetSize( pt2.x, pt2.y, sz2.x, sz2.y );
 313 }
 314
 315 void wxSpinButton::DoSetSize(int x, int y, int width, int height, int sizeFlags)
 316 {
 317     if ( (sizeFlags & wxSIZE_ALLOW_MINUS_ONE) && width == -1 )
 318         width = GetSize().x;
 319     if ( (sizeFlags & wxSIZE_ALLOW_MINUS_ONE) && height == -1 )
 320         height = GetSize().y;
 321
 322     wxControl::DoSetSize(x, y, width, height, 0);
 323 }
 324
 325 void wxSpinButton::Increment( int delta )
 326 {
 327     if( m_pos < m_min ) m_pos = m_min;
 328     if( m_pos > m_max ) m_pos = m_max;
 329
 330     int npos = m_pos + delta;
 331
 332     if( npos < m_min )
 333     {
 334         if( GetWindowStyle() & wxSP_WRAP )
 335             npos = m_max;
 336         else
 337             npos = m_min;
 338     }
 339     if( npos > m_max )
 340     {
 341         if( GetWindowStyle() & wxSP_WRAP )
 342             npos = m_min;
 343         else
 344             npos = m_max;
 345     }
 346     if( npos == m_pos ) return;
 347
 348     wxSpinEvent event( delta > 0 ? wxEVT_SCROLL_LINEUP : wxEVT_SCROLL_LINEDOWN,
 349                        m_windowId );
 350     event.SetPosition( npos );
 351     event.SetEventObject( this );
 352
 353     GetEventHandler()->ProcessEvent( event );
 354
 355     if( event.IsAllowed() )
 356     {
 357         m_pos = npos;
 358         event.SetEventType( wxEVT_SCROLL_THUMBTRACK );
 359         event.SetPosition( m_pos );
 360
 361         GetEventHandler()->ProcessEvent( event );
 362     }
 363 }
 364
 365 wxSize wxSpinButton::DoGetBestSize() const
 366 {
 367     return IsVertical() ? wxSize( 20, 30 ) : wxSize( 30, 20 );
 368 }
 369
 370 // Attributes
 371 ////////////////////////////////////////////////////////////////////////////
 372
 373 int wxSpinButton::GetValue() const
 374 {
 375     return m_pos;
 376 }
 377
 378 void wxSpinButton::SetValue(int val)
 379 {
 380     m_pos = val;
 381 }
 382
 383 void wxSpinButton::SetRange(int minVal, int maxVal)
 384 {
 385     wxSpinButtonBase::SetRange(minVal, maxVal);
 386 }
 387
 388 void wxSpinButton::ChangeFont(bool WXUNUSED(keepOriginalSize))
 389 {
 390     // TODO
 391 }
 392
 393 void wxSpinButton::ChangeBackgroundColour()
 394 {
 395     wxControl::ChangeBackgroundColour();
 396 }
 397
 398 void wxSpinButton::ChangeForegroundColour()
 399 {
 400     // TODO
 401 }
 402
 403 #endif // wxUSE_SPINBTN