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
  26 #define wxSPIN_BUTTON_NAME _T("wxSpinButton")
  27
  28 // ----------------------------------------------------------------------------
  29 //  The wxSpinButton is like a small scrollbar than is often placed next
  30 //  to a text control.
  31 //
  32 //  Styles:
  33 //  wxSP_HORIZONTAL:   horizontal spin button
  34 //  wxSP_VERTICAL:     vertical spin button (the default)
  35 //  wxSP_ARROW_KEYS:   arrow keys increment/decrement value
  36 //  wxSP_WRAP:         value wraps at either end
  37 // ----------------------------------------------------------------------------
  38
  39 class WXDLLEXPORT wxSpinButtonBase : public wxControl
  40 {
  41 public:
  42     wxSpinButtonBase() { InitBase(); }
  43
  44     // accessors
  45     virtual int GetValue() const = 0;
  46     virtual int GetMin() const { return m_min; }
  47     virtual int GetMax() const { return m_max; }
  48
  49     // operations
  50     virtual void SetValue(int val) = 0;
  51     virtual void SetRange(int minVal, int maxVal)
  52     {
  53         m_min = minVal;
  54         m_max = maxVal;
  55     }
  56
  57     // is this spin button vertically oriented?
  58     bool IsVertical() const { return (m_windowStyle & wxSP_VERTICAL) != 0; }
  59
  60 protected:
  61     // init the base part of the control
  62     void InitBase()
  63     {
  64         m_min = 0;
  65         m_max = 100;
  66     }
  67
  68     // the range value
  69     int   m_min;
  70     int   m_max;
  71
  72     DECLARE_NO_COPY_CLASS(wxSpinButtonBase)
  73 };
  74
  75 // ----------------------------------------------------------------------------
  76 // include the declaration of the real class
  77 // ----------------------------------------------------------------------------
  78
  79 #if defined(__WXUNIVERSAL__)
  80     #include "wx/univ/spinbutt.h"
  81 #elif defined(__WXMSW__) && defined(__WIN95__)
  82     #include "wx/msw/spinbutt.h"
  83 #elif defined(__WXMOTIF__)
  84     #include "wx/motif/spinbutt.h"
  85 #elif defined(__WXGTK__)
  86     #include "wx/gtk/spinbutt.h"
  87 #elif defined(__WXMAC__)
  88     #include "wx/mac/spinbutt.h"
  89 #elif defined(__WXCOCOA__)
  90     #include "wx/cocoa/spinbutt.h"
  91 #elif defined(__WXPM__)
  92     #include "wx/os2/spinbutt.h"
  93 #endif
  94
  95 // ----------------------------------------------------------------------------
  96 // the wxSpinButton event
  97 // ----------------------------------------------------------------------------
  98
  99 class WXDLLEXPORT wxSpinEvent : public wxNotifyEvent
 100 {
 101 public:
 102     wxSpinEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 103            : wxNotifyEvent(commandType, winid)
 104     {
 105     }
 106
 107     // get the current value of the control
 108     int GetPosition() const { return m_commandInt; }
 109     void SetPosition(int pos) { m_commandInt = pos; }
 110
 111 private:
 112     DECLARE_DYNAMIC_CLASS_NO_COPY(wxSpinEvent)
 113 };
 114
 115 typedef void (wxEvtHandler::*wxSpinEventFunction)(wxSpinEvent&);
 116
 117 // macros for handling spin events
 118 #define EVT_SPIN_UP(winid, func) \
 119     DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEUP, winid, -1, (wxObjectEventFunction) (wxEventFunction) (wxSpinEventFunction) & func, NULL ),
 120 #define EVT_SPIN_DOWN(winid, func) \
 121     DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_LINEDOWN, winid, -1, (wxObjectEventFunction) (wxEventFunction) (wxSpinEventFunction) & func, NULL ),
 122 #define EVT_SPIN(winid, func) \
 123     DECLARE_EVENT_TABLE_ENTRY( wxEVT_SCROLL_THUMBTRACK, winid, -1, (wxObjectEventFunction) (wxEventFunction) (wxSpinEventFunction) & func, NULL ),
 124
 125 #endif // wxUSE_SPINBTN
 126
 127 #endif
 128     // _WX_SPINBUTT_H_BASE_