include/wx/spinctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/spinctrl.h
   3 // Purpose:     wxSpinCtrlBase class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     22.07.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_SPINCTRL_H_
  13 #define _WX_SPINCTRL_H_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_SPINCTRL
  18
  19 #include "wx/spinbutt.h"        // should make wxSpinEvent visible to the app
  20
  21 // Events
  22 class WXDLLIMPEXP_FWD_CORE wxSpinDoubleEvent;
  23
  24 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SPINCTRL, wxSpinEvent);
  25 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SPINCTRLDOUBLE, wxSpinDoubleEvent);
  26
  27 // ----------------------------------------------------------------------------
  28 // A spin ctrl is a text control with a spin button which is usually used to
  29 // prompt the user for a numeric input.
  30 // There are two kinds for number types T=integer or T=double.
  31 // ----------------------------------------------------------------------------
  32
  33 class WXDLLIMPEXP_CORE wxSpinCtrlBase : public wxControl
  34 {
  35 public:
  36     wxSpinCtrlBase() {}
  37
  38     // accessor functions that derived classes are expected to have
  39     // T GetValue() const
  40     // T GetMin() const
  41     // T GetMax() const
  42     // T GetIncrement() const
  43     virtual bool GetSnapToTicks() const = 0;
  44     // unsigned GetDigits() const                   - wxSpinCtrlDouble only
  45
  46     // operation functions that derived classes are expected to have
  47     virtual void SetValue(const wxString& value) = 0;
  48     // void SetValue(T val)
  49     // void SetRange(T minVal, T maxVal)
  50     // void SetIncrement(T inc)
  51     virtual void SetSnapToTicks(bool snap_to_ticks) = 0;
  52     // void SetDigits(unsigned digits)              - wxSpinCtrlDouble only
  53
  54     // The base for numbers display, e.g. 10 or 16.
  55     virtual int GetBase() const = 0;
  56     virtual bool SetBase(int base) = 0;
  57
  58     // Select text in the textctrl
  59     virtual void SetSelection(long from, long to) = 0;
  60
  61 private:
  62     wxDECLARE_NO_COPY_CLASS(wxSpinCtrlBase);
  63 };
  64
  65 // ----------------------------------------------------------------------------
  66 // wxSpinDoubleEvent - a wxSpinEvent for double valued controls
  67 // ----------------------------------------------------------------------------
  68
  69 class WXDLLIMPEXP_CORE wxSpinDoubleEvent : public wxNotifyEvent
  70 {
  71 public:
  72     wxSpinDoubleEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
  73                       double value = 0)
  74         : wxNotifyEvent(commandType, winid), m_value(value)
  75     {
  76     }
  77
  78     wxSpinDoubleEvent(const wxSpinDoubleEvent& event)
  79         : wxNotifyEvent(event), m_value(event.GetValue())
  80     {
  81     }
  82
  83     double GetValue() const       { return m_value; }
  84     void   SetValue(double value) { m_value = value; }
  85
  86     virtual wxEvent *Clone() const { return new wxSpinDoubleEvent(*this); }
  87
  88 protected:
  89     double m_value;
  90
  91 private:
  92     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSpinDoubleEvent)
  93 };
  94
  95 // ----------------------------------------------------------------------------
  96 // wxSpinDoubleEvent event type, see also wxSpinEvent in wx/spinbutt.h
  97 // ----------------------------------------------------------------------------
  98
  99 typedef void (wxEvtHandler::*wxSpinDoubleEventFunction)(wxSpinDoubleEvent&);
 100
 101 #define wxSpinDoubleEventHandler(func) \
 102     wxEVENT_HANDLER_CAST(wxSpinDoubleEventFunction, func)
 103
 104 // macros for handling spinctrl events
 105
 106 #define EVT_SPINCTRL(id, fn) \
 107     wx__DECLARE_EVT1(wxEVT_SPINCTRL, id, wxSpinEventHandler(fn))
 108
 109 #define EVT_SPINCTRLDOUBLE(id, fn) \
 110     wx__DECLARE_EVT1(wxEVT_SPINCTRLDOUBLE, id, wxSpinDoubleEventHandler(fn))
 111
 112 // ----------------------------------------------------------------------------
 113 // include the platform-dependent class implementation
 114 // ----------------------------------------------------------------------------
 115
 116 // we may have a native wxSpinCtrl implementation, native wxSpinCtrl and
 117 // wxSpinCtrlDouble implementations or neither, define the appropriate symbols
 118 // and include the generic version if necessary to provide the missing class(es)
 119
 120 #if defined(__WXUNIVERSAL__)
 121     // nothing, use generic controls
 122 #elif defined(__WXMSW__)
 123     #define wxHAS_NATIVE_SPINCTRL
 124     #include "wx/msw/spinctrl.h"
 125 #elif defined(__WXPM__)
 126     #define wxHAS_NATIVE_SPINCTRL
 127     #include "wx/os2/spinctrl.h"
 128 #elif defined(__WXGTK20__)
 129     #define wxHAS_NATIVE_SPINCTRL
 130     #define wxHAS_NATIVE_SPINCTRLDOUBLE
 131     #include "wx/gtk/spinctrl.h"
 132 #elif defined(__WXGTK__)
 133     #define wxHAS_NATIVE_SPINCTRL
 134     #include "wx/gtk1/spinctrl.h"
 135 #endif // platform
 136
 137 #if !defined(wxHAS_NATIVE_SPINCTRL) || !defined(wxHAS_NATIVE_SPINCTRLDOUBLE)
 138     #include "wx/generic/spinctlg.h"
 139 #endif
 140
 141 namespace wxPrivate
 142 {
 143
 144 // This is an internal helper function currently used by all ports: return the
 145 // string containing hexadecimal representation of the given number.
 146 extern wxString wxSpinCtrlFormatAsHex(long val, long maxVal);
 147
 148 } // namespace wxPrivate
 149
 150 // old wxEVT_COMMAND_* constants
 151 #define wxEVT_COMMAND_SPINCTRL_UPDATED         wxEVT_SPINCTRL
 152 #define wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED   wxEVT_SPINCTRLDOUBLE
 153
 154 #endif // wxUSE_SPINCTRL
 155
 156 #endif // _WX_SPINCTRL_H_