include/wx/generic/spinctlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/spinctlg.h
   3 // Purpose:     generic wxSpinCtrl class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     28.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GENERIC_SPINCTRL_H_
  13 #define _WX_GENERIC_SPINCTRL_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // wxSpinCtrl is a combination of wxSpinButton and wxTextCtrl, so if
  17 // wxSpinButton is available, this is what we do - but if it isn't, we still
  18 // define wxSpinCtrl class which then has the same appearance as wxTextCtrl but
  19 // the different interface. This allows to write programs using wxSpinCtrl
  20 // without tons of #ifdefs.
  21 // ----------------------------------------------------------------------------
  22
  23 #if wxUSE_SPINBTN
  24
  25 class WXDLLIMPEXP_FWD_CORE wxSpinButton;
  26 class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
  27
  28 class wxSpinCtrlTextGeneric; // wxTextCtrl used for the wxSpinCtrlGenericBase
  29
  30 // The !wxUSE_SPINBTN version's GetValue() function conflicts with the
  31 // wxTextCtrl's GetValue() and so you have to input a dummy int value.
  32 #define wxSPINCTRL_GETVALUE_FIX
  33
  34 // ----------------------------------------------------------------------------
  35 // wxSpinCtrlGeneric is a combination of wxTextCtrl and wxSpinButton
  36 //
  37 // This class manages a double valued generic spinctrl through the DoGet/SetXXX
  38 // functions that are made public as Get/SetXXX functions for int or double
  39 // for the wxSpinCtrl and wxSpinCtrlDouble classes respectively to avoid
  40 // function ambiguity.
  41 // ----------------------------------------------------------------------------
  42
  43 class WXDLLIMPEXP_CORE wxSpinCtrlGenericBase : public wxSpinCtrlBase
  44 {
  45 public:
  46     wxSpinCtrlGenericBase() { Init(); }
  47
  48     bool Create(wxWindow *parent,
  49                 wxWindowID id = wxID_ANY,
  50                 const wxString& value = wxEmptyString,
  51                 const wxPoint& pos = wxDefaultPosition,
  52                 const wxSize& size = wxDefaultSize,
  53                 long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
  54                 double min = 0, double max = 100, double initial = 0,
  55                 double inc = 1,
  56                 const wxString& name = wxT("wxSpinCtrl"));
  57
  58     virtual ~wxSpinCtrlGenericBase();
  59
  60     // accessors
  61     // T GetValue() const
  62     // T GetMin() const
  63     // T GetMax() const
  64     // T GetIncrement() const
  65     virtual bool GetSnapToTicks() const { return m_snap_to_ticks; }
  66     // unsigned GetDigits() const                   - wxSpinCtrlDouble only
  67
  68     // operations
  69     virtual void SetValue(const wxString& text);
  70     // void SetValue(T val)
  71     // void SetRange(T minVal, T maxVal)
  72     // void SetIncrement(T inc)
  73     virtual void SetSnapToTicks(bool snap_to_ticks);
  74     // void SetDigits(unsigned digits)              - wxSpinCtrlDouble only
  75
  76     // Select text in the textctrl
  77     void SetSelection(long from, long to);
  78
  79     // implementation from now on
  80
  81     // forward these functions to all subcontrols
  82     virtual bool Enable(bool enable = true);
  83     virtual bool Show(bool show = true);
  84 #if wxUSE_TOOLTIPS
  85     virtual void DoSetToolTip(wxToolTip *tip);
  86 #endif // wxUSE_TOOLTIPS
  87
  88     // get the subcontrols
  89     wxTextCtrl   *GetText() const       { return m_textCtrl; }
  90     wxSpinButton *GetSpinButton() const { return m_spinButton; }
  91
  92     // forwarded events from children windows
  93     void OnSpinButton(wxSpinEvent& event);
  94     void OnTextLostFocus(wxFocusEvent& event);
  95     void OnTextChar(wxKeyEvent& event);
  96
  97     // this window itself is used only as a container for its sub windows so it
  98     // shouldn't accept the focus at all and any attempts to explicitly set
  99     // focus to it should give focus to its text constol part
 100     virtual bool AcceptsFocus() const { return false; }
 101     virtual void SetFocus();
 102
 103     friend class wxSpinCtrlTextGeneric;
 104
 105 protected:
 106     // override the base class virtuals involved into geometry calculations
 107     virtual wxSize DoGetBestSize() const;
 108     virtual void DoMoveWindow(int x, int y, int width, int height);
 109
 110 #ifdef __WXMSW__
 111     // and, for MSW, enabling this window itself
 112     virtual void DoEnable(bool enable);
 113 #endif // __WXMSW__
 114
 115     // generic double valued functions
 116     double DoGetValue() const { return m_value; }
 117     bool DoSetValue(double val);
 118     void DoSetRange(double min_val, double max_val);
 119     void DoSetIncrement(double inc);
 120
 121     // update our value to reflect the text control contents (if it has been
 122     // modified by user, do nothing otherwise)
 123     //
 124     // can also change the text control if its value is invalid
 125     //
 126     // return true if our value has changed
 127     bool SyncSpinToText();
 128
 129     // Send the correct event type
 130     virtual void DoSendEvent() = 0;
 131
 132     // Convert the text to/from the corresponding value.
 133     virtual bool DoTextToValue(const wxString& text, double *val) = 0;
 134     virtual wxString DoValueToText(double val) = 0;
 135
 136     // check if the value is in range
 137     bool InRange(double n) const { return (n >= m_min) && (n <= m_max); }
 138
 139     // ensure that the value is in range wrapping it round if necessary
 140     double AdjustToFitInRange(double value) const;
 141
 142
 143     double m_value;
 144     double m_min;
 145     double m_max;
 146     double m_increment;
 147     bool   m_snap_to_ticks;
 148
 149     int m_spin_value;
 150
 151     // the subcontrols
 152     wxTextCtrl   *m_textCtrl;
 153     wxSpinButton *m_spinButton;
 154
 155 private:
 156     // common part of all ctors
 157     void Init();
 158
 159     DECLARE_EVENT_TABLE()
 160 };
 161
 162 #else // !wxUSE_SPINBTN
 163
 164 #define wxSPINCTRL_GETVALUE_FIX int = 1
 165
 166 // ----------------------------------------------------------------------------
 167 // wxSpinCtrl is just a text control
 168 // ----------------------------------------------------------------------------
 169
 170 #include "wx/textctrl.h"
 171
 172 class WXDLLIMPEXP_CORE wxSpinCtrlGenericBase : public wxTextCtrl
 173 {
 174 public:
 175     wxSpinCtrlGenericBase() : m_value(0), m_min(0), m_max(100),
 176                               m_increment(1), m_snap_to_ticks(false),
 177                               m_format(wxT("%g")) { }
 178
 179     bool Create(wxWindow *parent,
 180                 wxWindowID id = wxID_ANY,
 181                 const wxString& value = wxEmptyString,
 182                 const wxPoint& pos = wxDefaultPosition,
 183                 const wxSize& size = wxDefaultSize,
 184                 long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
 185                 double min = 0, double max = 100, double initial = 0,
 186                 double inc = 1,
 187                 const wxString& name = wxT("wxSpinCtrl"))
 188     {
 189         m_min = min;
 190         m_max = max;
 191         m_value = initial;
 192         m_increment = inc;
 193
 194         bool ok = wxTextCtrl::Create(parent, id, value, pos, size, style,
 195                                      wxDefaultValidator, name);
 196         DoSetValue(initial);
 197
 198         return ok;
 199     }
 200
 201     // accessors
 202     // T GetValue() const
 203     // T GetMin() const
 204     // T GetMax() const
 205     // T GetIncrement() const
 206     virtual bool GetSnapToTicks() const { return m_snap_to_ticks; }
 207     // unsigned GetDigits() const                   - wxSpinCtrlDouble only
 208
 209     // operations
 210     virtual void SetValue(const wxString& text) { wxTextCtrl::SetValue(text); }
 211     // void SetValue(T val)
 212     // void SetRange(T minVal, T maxVal)
 213     // void SetIncrement(T inc)
 214     virtual void SetSnapToTicks(bool snap_to_ticks)
 215         { m_snap_to_ticks = snap_to_ticks; }
 216     // void SetDigits(unsigned digits)              - wxSpinCtrlDouble only
 217
 218     // Select text in the textctrl
 219     //void SetSelection(long from, long to);
 220
 221 protected:
 222     // generic double valued
 223     double DoGetValue() const
 224     {
 225         double n;
 226         if ( (wxSscanf(wxTextCtrl::GetValue(), wxT("%lf"), &n) != 1) )
 227             n = INT_MIN;
 228
 229         return n;
 230     }
 231
 232     bool DoSetValue(double val)
 233     {
 234         wxTextCtrl::SetValue(wxString::Format(m_format.c_str(), val));
 235         return true;
 236     }
 237     void DoSetRange(double min_val, double max_val)
 238     {
 239         m_min = min_val;
 240         m_max = max_val;
 241     }
 242     void DoSetIncrement(double inc) { m_increment = inc; } // Note: unused
 243
 244     double m_value;
 245     double m_min;
 246     double m_max;
 247     double m_increment;
 248     bool   m_snap_to_ticks;
 249     wxString m_format;
 250 };
 251
 252 #endif // wxUSE_SPINBTN/!wxUSE_SPINBTN
 253
 254 #if !defined(wxHAS_NATIVE_SPINCTRL)
 255
 256 //-----------------------------------------------------------------------------
 257 // wxSpinCtrl
 258 //-----------------------------------------------------------------------------
 259
 260 class WXDLLIMPEXP_CORE wxSpinCtrl : public wxSpinCtrlGenericBase
 261 {
 262 public:
 263     wxSpinCtrl() {}
 264     wxSpinCtrl(wxWindow *parent,
 265                wxWindowID id = wxID_ANY,
 266                const wxString& value = wxEmptyString,
 267                const wxPoint& pos = wxDefaultPosition,
 268                const wxSize& size = wxDefaultSize,
 269                long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
 270                int min = 0, int max = 100, int initial = 0,
 271                const wxString& name = wxT("wxSpinCtrl"))
 272     {
 273         Create(parent, id, value, pos, size, style, min, max, initial, name);
 274     }
 275
 276     bool Create(wxWindow *parent,
 277                 wxWindowID id = wxID_ANY,
 278                 const wxString& value = wxEmptyString,
 279                 const wxPoint& pos = wxDefaultPosition,
 280                 const wxSize& size = wxDefaultSize,
 281                 long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
 282                 int min = 0, int max = 100, int initial = 0,
 283                 const wxString& name = wxT("wxSpinCtrl"))
 284     {
 285         return wxSpinCtrlGenericBase::Create(parent, id, value, pos, size,
 286                                              style, min, max, initial, 1, name);
 287     }
 288
 289     // accessors
 290     int GetValue(wxSPINCTRL_GETVALUE_FIX) const { return int(DoGetValue()); }
 291     int GetMin() const { return int(m_min); }
 292     int GetMax() const { return int(m_max); }
 293     int GetIncrement() const { return int(m_increment); }
 294
 295     // operations
 296     void SetValue(const wxString& value)
 297         { wxSpinCtrlGenericBase::SetValue(value); }
 298     void SetValue( int value )              { DoSetValue(value); }
 299     void SetRange( int minVal, int maxVal ) { DoSetRange(minVal, maxVal); }
 300     void SetIncrement(int inc) { DoSetIncrement(inc); }
 301
 302 protected:
 303     virtual void DoSendEvent();
 304
 305     virtual bool DoTextToValue(const wxString& text, double *val);
 306     virtual wxString DoValueToText(double val);
 307     DECLARE_DYNAMIC_CLASS(wxSpinCtrl)
 308 };
 309
 310 #endif // wxHAS_NATIVE_SPINCTRL
 311
 312 //-----------------------------------------------------------------------------
 313 // wxSpinCtrlDouble
 314 //-----------------------------------------------------------------------------
 315
 316 class WXDLLIMPEXP_CORE wxSpinCtrlDouble : public wxSpinCtrlGenericBase
 317 {
 318 public:
 319     wxSpinCtrlDouble() { Init(); }
 320     wxSpinCtrlDouble(wxWindow *parent,
 321                      wxWindowID id = wxID_ANY,
 322                      const wxString& value = wxEmptyString,
 323                      const wxPoint& pos = wxDefaultPosition,
 324                      const wxSize& size = wxDefaultSize,
 325                      long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
 326                      double min = 0, double max = 100, double initial = 0,
 327                      double inc = 1,
 328                      const wxString& name = wxT("wxSpinCtrlDouble"))
 329     {
 330         Init();
 331
 332         Create(parent, id, value, pos, size, style,
 333                min, max, initial, inc, name);
 334     }
 335
 336     bool Create(wxWindow *parent,
 337                 wxWindowID id = wxID_ANY,
 338                 const wxString& value = wxEmptyString,
 339                 const wxPoint& pos = wxDefaultPosition,
 340                 const wxSize& size = wxDefaultSize,
 341                 long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
 342                 double min = 0, double max = 100, double initial = 0,
 343                 double inc = 1,
 344                 const wxString& name = wxT("wxSpinCtrlDouble"))
 345     {
 346         return wxSpinCtrlGenericBase::Create(parent, id, value, pos, size,
 347                                              style, min, max, initial,
 348                                              inc, name);
 349     }
 350
 351     // accessors
 352     double GetValue(wxSPINCTRL_GETVALUE_FIX) const { return DoGetValue(); }
 353     double GetMin() const { return m_min; }
 354     double GetMax() const { return m_max; }
 355     double GetIncrement() const { return m_increment; }
 356     unsigned GetDigits() const { return m_digits; }
 357
 358     // operations
 359     void SetValue(const wxString& value)
 360         { wxSpinCtrlGenericBase::SetValue(value); }
 361     void SetValue(double value)                 { DoSetValue(value); }
 362     void SetRange(double minVal, double maxVal) { DoSetRange(minVal, maxVal); }
 363     void SetIncrement(double inc)               { DoSetIncrement(inc); }
 364     void SetDigits(unsigned digits);
 365
 366 protected:
 367     virtual void DoSendEvent();
 368
 369     virtual bool DoTextToValue(const wxString& text, double *val);
 370     virtual wxString DoValueToText(double val);
 371
 372     unsigned m_digits;
 373
 374 private:
 375     // Common part of all ctors.
 376     void Init()
 377     {
 378         m_digits = 0;
 379         m_format = wxS("%g");
 380     }
 381
 382     wxString m_format;
 383
 384     DECLARE_DYNAMIC_CLASS(wxSpinCtrlDouble)
 385 };
 386
 387 #endif // _WX_GENERIC_SPINCTRL_H_