include/wx/spinbutt.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/spinbutt.h
   3 // Purpose:     wxSpinButtonBase class
   4 // Author:      Julian Smart, Vadim Zeitlin
   5 // Modified by:
   6 // Created:     23.07.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_SPINBUTT_H_BASE_
  13 #define _WX_SPINBUTT_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_SPINBTN
  22
  23 #include "wx/control.h"
  24 #include "wx/event.h"
  25 #include "wx/range.h"
  26
  27 #define wxSPIN_BUTTON_NAME wxT("wxSpinButton")
  28
  29 // ----------------------------------------------------------------------------
  30 //  The wxSpinButton is like a small scrollbar than is often placed next
  31 //  to a text control.
  32 //
  33 //  Styles:
  34 //  wxSP_HORIZONTAL:   horizontal spin button
  35 //  wxSP_VERTICAL:     vertical spin button (the default)
  36 //  wxSP_ARROW_KEYS:   arrow keys increment/decrement value
  37 //  wxSP_WRAP:         value wraps at either end
  38 // ----------------------------------------------------------------------------
  39
  40 class WXDLLIMPEXP_CORE wxSpinButtonBase : public wxControl
  41 {
  42 public:
  43     // ctor initializes the range with the default (0..100) values
  44     wxSpinButtonBase() { m_min = 0; m_max = 100; }
  45
  46     // accessors
  47     virtual int GetValue() const = 0;
  48     virtual int GetMin() const { return m_min; }
  49     virtual int GetMax() const { return m_max; }
  50     wxRange GetRange() const { return wxRange( GetMin(), GetMax() );}
  51
  52     // operations
  53     virtual void SetValue(int val) = 0;
  54     virtual void SetMin(int minVal) { SetRange ( minVal , m_max ) ; }
  55     virtual void SetMax(int maxVal) { SetRange ( m_min , maxVal ) ; }
  56     virtual void SetRange(int minVal, int maxVal)
  57     {
  58         m_min = minVal;
  59         m_max = maxVal;
  60     }
  61     void SetRange( const wxRange& range) { SetRange( range.GetMin(), range.GetMax()); }
  62
  63     // is this spin button vertically oriented?
  64     bool IsVertical() const { return (m_windowStyle & wxSP_VERTICAL) != 0; }
  65
  66 protected:
  67     // the range value
  68     int   m_min;
  69     int   m_max;
  70
  71     wxDECLARE_NO_COPY_CLASS(wxSpinButtonBase);
  72 };
  73
  74 // ----------------------------------------------------------------------------
  75 // include the declaration of the real class
  76 // ----------------------------------------------------------------------------
  77
  78 #if defined(__WXUNIVERSAL__)
  79     #include "wx/univ/spinbutt.h"
  80 #elif defined(__WXMSW__)
  81     #include "wx/msw/spinbutt.h"
  82 #elif defined(__WXMOTIF__)
  83     #include "wx/motif/spinbutt.h"
  84 #elif defined(__WXGTK20__)
  85     #include "wx/gtk/spinbutt.h"
  86 #elif defined(__WXGTK__)
  87     #include "wx/gtk1/spinbutt.h"
  88 #elif defined(__WXMAC__)
  89     #include "wx/osx/spinbutt.h"
  90 #elif defined(__WXCOCOA__)
  91     #include "wx/cocoa/spinbutt.h"
  92 #elif defined(__WXPM__)
  93     #include "wx/os2/spinbutt.h"
  94 #endif
  95
  96 // ----------------------------------------------------------------------------
  97 // the wxSpinButton event
  98 // ----------------------------------------------------------------------------
  99
 100 class WXDLLIMPEXP_CORE wxSpinEvent : public wxNotifyEvent
 101 {
 102 public:
 103     wxSpinEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 104            : wxNotifyEvent(commandType, winid)
 105     {
 106     }
 107
 108     wxSpinEvent(const wxSpinEvent& event) : wxNotifyEvent(event) {}
 109
 110     // get the current value of the control
 111     int GetValue() const { return m_commandInt; }
 112     void SetValue(int value) { m_commandInt = value; }
 113
 114     int GetPosition() const { return m_commandInt; }
 115     void SetPosition(int pos) { m_commandInt = pos; }
 116
 117     virtual wxEvent *Clone() const { return new wxSpinEvent(*this); }
 118
 119 private:
 120     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSpinEvent)
 121 };
 122
 123 typedef void (wxEvtHandler::*wxSpinEventFunction)(wxSpinEvent&);
 124
 125 #define wxSpinEventHandler(func) \
 126     wxEVENT_HANDLER_CAST(wxSpinEventFunction, func)
 127
 128 // macros for handling spin events: notice that we must use the real values of
 129 // the event type constants and not their references (wxEVT_SPIN[_UP/DOWN])
 130 // here as otherwise the event tables could end up with non-initialized
 131 // (because of undefined initialization order of the globals defined in
 132 // different translation units) references in them
 133 #define EVT_SPIN_UP(winid, func) \
 134     wx__DECLARE_EVT1(wxEVT_SPIN_UP, winid, wxSpinEventHandler(func))
 135 #define EVT_SPIN_DOWN(winid, func) \
 136     wx__DECLARE_EVT1(wxEVT_SPIN_DOWN, winid, wxSpinEventHandler(func))
 137 #define EVT_SPIN(winid, func) \
 138     wx__DECLARE_EVT1(wxEVT_SPIN, winid, wxSpinEventHandler(func))
 139
 140 #endif // wxUSE_SPINBTN
 141
 142 #endif
 143     // _WX_SPINBUTT_H_BASE_