// Created: 28.10.99
// RCS-ID: $Id$
// Copyright: (c) Vadim Zeitlin
-// Licence: wxWidgets licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_GENERIC_SPINCTRL_H_
#if wxUSE_SPINBTN
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma interface "spinctlg.h"
-#endif
+class WXDLLIMPEXP_FWD_CORE wxSpinButton;
+class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
-class WXDLLEXPORT wxSpinButton;
-class WXDLLEXPORT wxTextCtrl;
+class wxSpinCtrlTextGeneric; // wxTextCtrl used for the wxSpinCtrlGenericBase
+
+// The !wxUSE_SPINBTN version's GetValue() function conflicts with the
+// wxTextCtrl's GetValue() and so you have to input a dummy int value.
+#define wxSPINCTRL_GETVALUE_FIX
// ----------------------------------------------------------------------------
-// wxSpinCtrl is a combination of wxTextCtrl and wxSpinButton
+// wxSpinCtrlGeneric is a combination of wxTextCtrl and wxSpinButton
+//
+// This class manages a double valued generic spinctrl through the DoGet/SetXXX
+// functions that are made public as Get/SetXXX functions for int or double
+// for the wxSpinCtrl and wxSpinCtrlDouble classes respectively to avoid
+// function ambiguity.
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxSpinCtrl : public wxControl
+class WXDLLIMPEXP_CORE wxSpinCtrlGenericBase : public wxSpinCtrlBase
{
public:
- wxSpinCtrl() { Init(); }
-
- wxSpinCtrl(wxWindow *parent,
- wxWindowID id = -1,
- const wxString& value = wxEmptyString,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxSP_ARROW_KEYS,
- int min = 0, int max = 100, int initial = 0,
- const wxString& name = _T("wxSpinCtrl"))
- {
- Init();
- Create(parent, id, value, pos, size, style, min, max, initial, name);
- }
+ wxSpinCtrlGenericBase() { Init(); }
bool Create(wxWindow *parent,
- wxWindowID id = -1,
+ wxWindowID id = wxID_ANY,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxSP_ARROW_KEYS,
- int min = 0, int max = 100, int initial = 0,
- const wxString& name = _T("wxSpinCtrl"));
+ long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
+ double min = 0, double max = 100, double initial = 0,
+ double inc = 1,
+ const wxString& name = wxT("wxSpinCtrl"));
+
+ virtual ~wxSpinCtrlGenericBase();
- virtual ~wxSpinCtrl();
+ // accessors
+ // T GetValue() const
+ // T GetMin() const
+ // T GetMax() const
+ // T GetIncrement() const
+ virtual bool GetSnapToTicks() const { return m_snap_to_ticks; }
+ // unsigned GetDigits() const - wxSpinCtrlDouble only
// operations
- void SetValue(int val);
- void SetValue(const wxString& text);
- void SetRange(int min, int max);
+ virtual void SetValue(const wxString& text);
+ // void SetValue(T val)
+ // void SetRange(T minVal, T maxVal)
+ // void SetIncrement(T inc)
+ virtual void SetSnapToTicks(bool snap_to_ticks);
+ // void SetDigits(unsigned digits) - wxSpinCtrlDouble only
+
+ // Select text in the textctrl
void SetSelection(long from, long to);
- // accessors
- int GetValue() const;
- int GetMin() const;
- int GetMax() const;
-
// implementation from now on
// forward these functions to all subcontrols
- virtual bool Enable(bool enable = TRUE);
- virtual bool Show(bool show = TRUE);
+ virtual bool Enable(bool enable = true);
+ virtual bool Show(bool show = true);
+#if wxUSE_TOOLTIPS
+ virtual void DoSetToolTip(wxToolTip *tip);
+#endif // wxUSE_TOOLTIPS
// get the subcontrols
- wxTextCtrl *GetText() const { return m_text; }
- wxSpinButton *GetSpinButton() const { return m_btn; }
+ wxTextCtrl *GetText() const { return m_textCtrl; }
+ wxSpinButton *GetSpinButton() const { return m_spinButton; }
+
+ // forwarded events from children windows
+ void OnSpinButton(wxSpinEvent& event);
+ void OnTextLostFocus(wxFocusEvent& event);
+ void OnTextChar(wxKeyEvent& event);
- // set the value of the text (only)
- void SetTextValue(int val);
+ // this window itself is used only as a container for its sub windows so it
+ // shouldn't accept the focus at all and any attempts to explicitly set
+ // focus to it should give focus to its text constol part
+ virtual bool AcceptsFocus() const { return false; }
+ virtual void SetFocus();
- // put the numeric value of the string in the text ctrl into val and return
- // TRUE or return FALSE if the text ctrl doesn't contain a number or if the
- // number is out of range
- bool GetTextValue(int *val) const;
+ friend class wxSpinCtrlTextGeneric;
protected:
// override the base class virtuals involved into geometry calculations
virtual wxSize DoGetBestSize() const;
virtual void DoMoveWindow(int x, int y, int width, int height);
- // common part of all ctors
- void Init();
+#ifdef __WXMSW__
+ // and, for MSW, enabling this window itself
+ virtual void DoEnable(bool enable);
+#endif // __WXMSW__
+
+ // generic double valued functions
+ double DoGetValue() const { return m_value; }
+ bool DoSetValue(double val);
+ void DoSetRange(double min_val, double max_val);
+ void DoSetIncrement(double inc);
+
+ // update our value to reflect the text control contents (if it has been
+ // modified by user, do nothing otherwise)
+ //
+ // can also change the text control if its value is invalid
+ //
+ // return true if our value has changed
+ bool SyncSpinToText();
+
+ // Send the correct event type
+ virtual void DoSendEvent() = 0;
+
+ // check if the value is in range
+ bool InRange(double n) const { return (n >= m_min) && (n <= m_max); }
+
+ // ensure that the value is in range wrapping it round if necessary
+ double AdjustToFitInRange(double value) const;
+
+
+ double m_value;
+ double m_min;
+ double m_max;
+ double m_increment;
+ bool m_snap_to_ticks;
+ wxString m_format;
+
+ int m_spin_value;
-private:
// the subcontrols
- wxTextCtrl *m_text;
- wxSpinButton *m_btn;
+ wxTextCtrl *m_textCtrl;
+ wxSpinButton *m_spinButton;
private:
- DECLARE_DYNAMIC_CLASS(wxSpinCtrl)
+ // common part of all ctors
+ void Init();
+
+ DECLARE_EVENT_TABLE()
};
#else // !wxUSE_SPINBTN
+#define wxSPINCTRL_GETVALUE_FIX int = 1
+
// ----------------------------------------------------------------------------
// wxSpinCtrl is just a text control
// ----------------------------------------------------------------------------
#include "wx/textctrl.h"
-class WXDLLEXPORT wxSpinCtrl : public wxTextCtrl
+class WXDLLIMPEXP_CORE wxSpinCtrlGenericBase : public wxTextCtrl
{
public:
- wxSpinCtrl() { Init(); }
+ wxSpinCtrlGenericBase() : m_value(0), m_min(0), m_max(100),
+ m_increment(1), m_snap_to_ticks(false),
+ m_format(wxT("%g")) { }
+
+ bool Create(wxWindow *parent,
+ wxWindowID id = wxID_ANY,
+ const wxString& value = wxEmptyString,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
+ double min = 0, double max = 100, double initial = 0,
+ double inc = 1,
+ const wxString& name = wxT("wxSpinCtrl"))
+ {
+ m_min = min;
+ m_max = max;
+ m_value = initial;
+ m_increment = inc;
+ bool ok = wxTextCtrl::Create(parent, id, value, pos, size, style,
+ wxDefaultValidator, name);
+ DoSetValue(initial);
+
+ return ok;
+ }
+
+ // accessors
+ // T GetValue() const
+ // T GetMin() const
+ // T GetMax() const
+ // T GetIncrement() const
+ virtual bool GetSnapToTicks() const { return m_snap_to_ticks; }
+ // unsigned GetDigits() const - wxSpinCtrlDouble only
+
+ // operations
+ virtual void SetValue(const wxString& text) { wxTextCtrl::SetValue(text); }
+ // void SetValue(T val)
+ // void SetRange(T minVal, T maxVal)
+ // void SetIncrement(T inc)
+ virtual void SetSnapToTicks(bool snap_to_ticks)
+ { m_snap_to_ticks = snap_to_ticks; }
+ // void SetDigits(unsigned digits) - wxSpinCtrlDouble only
+
+ // Select text in the textctrl
+ //void SetSelection(long from, long to);
+
+protected:
+ // generic double valued
+ double DoGetValue() const
+ {
+ double n;
+ if ( (wxSscanf(wxTextCtrl::GetValue(), wxT("%lf"), &n) != 1) )
+ n = INT_MIN;
+
+ return n;
+ }
+
+ bool DoSetValue(double val)
+ {
+ wxTextCtrl::SetValue(wxString::Format(m_format.c_str(), val));
+ return true;
+ }
+ void DoSetRange(double min_val, double max_val)
+ {
+ m_min = min_val;
+ m_max = max_val;
+ }
+ void DoSetIncrement(double inc) { m_increment = inc; } // Note: unused
+
+ double m_value;
+ double m_min;
+ double m_max;
+ double m_increment;
+ bool m_snap_to_ticks;
+ wxString m_format;
+};
+
+#endif // wxUSE_SPINBTN/!wxUSE_SPINBTN
+
+#if !defined(wxHAS_NATIVE_SPINCTRL)
+
+//-----------------------------------------------------------------------------
+// wxSpinCtrl
+//-----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxSpinCtrl : public wxSpinCtrlGenericBase
+{
+public:
+ wxSpinCtrl() {}
wxSpinCtrl(wxWindow *parent,
- wxWindowID id = -1,
+ wxWindowID id = wxID_ANY,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxSP_ARROW_KEYS,
+ long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
int min = 0, int max = 100, int initial = 0,
- const wxString& name = _T("wxSpinCtrl"))
+ const wxString& name = wxT("wxSpinCtrl"))
{
Create(parent, id, value, pos, size, style, min, max, initial, name);
}
bool Create(wxWindow *parent,
- wxWindowID id = -1,
+ wxWindowID id = wxID_ANY,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxSP_ARROW_KEYS,
+ long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
int min = 0, int max = 100, int initial = 0,
- const wxString& name = _T("wxSpinCtrl"))
+ const wxString& name = wxT("wxSpinCtrl"))
{
- SetRange(min, max);
-
- bool ok = wxTextCtrl::Create(parent, id, value, pos, size, style,
- wxDefaultValidator, name);
- SetValue(initial);
-
- return ok;
+ return wxSpinCtrlGenericBase::Create(parent, id, value, pos, size,
+ style, min, max, initial, 1, name);
}
// accessors
- int GetValue(int WXUNUSED(dummy) = 1) const
+ int GetValue(wxSPINCTRL_GETVALUE_FIX) const { return int(DoGetValue()); }
+ int GetMin() const { return int(m_min); }
+ int GetMax() const { return int(m_max); }
+ int GetIncrement() const { return int(m_increment); }
+
+ // operations
+ void SetValue(const wxString& value)
+ { wxSpinCtrlGenericBase::SetValue(value); }
+ void SetValue( int value ) { DoSetValue(value); }
+ void SetRange( int minVal, int maxVal ) { DoSetRange(minVal, maxVal); }
+ void SetIncrement(int inc) { DoSetIncrement(inc); }
+
+protected:
+ virtual void DoSendEvent();
+
+ DECLARE_DYNAMIC_CLASS(wxSpinCtrl)
+};
+
+#endif // wxHAS_NATIVE_SPINCTRL
+
+//-----------------------------------------------------------------------------
+// wxSpinCtrlDouble
+//-----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxSpinCtrlDouble : public wxSpinCtrlGenericBase
+{
+public:
+ wxSpinCtrlDouble() : m_digits(0) { }
+ wxSpinCtrlDouble(wxWindow *parent,
+ wxWindowID id = wxID_ANY,
+ const wxString& value = wxEmptyString,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
+ double min = 0, double max = 100, double initial = 0,
+ double inc = 1,
+ const wxString& name = wxT("wxSpinCtrlDouble"))
{
- int n;
- if ( (wxSscanf(wxTextCtrl::GetValue(), wxT("%d"), &n) != 1) )
- n = INT_MIN;
+ m_digits = 0;
+ Create(parent, id, value, pos, size, style,
+ min, max, initial, inc, name);
+ }
- return n;
+ bool Create(wxWindow *parent,
+ wxWindowID id = wxID_ANY,
+ const wxString& value = wxEmptyString,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
+ double min = 0, double max = 100, double initial = 0,
+ double inc = 1,
+ const wxString& name = wxT("wxSpinCtrlDouble"))
+ {
+ return wxSpinCtrlGenericBase::Create(parent, id, value, pos, size,
+ style, min, max, initial,
+ inc, name);
}
- int GetMin() const { return m_min; }
- int GetMax() const { return m_max; }
+ // accessors
+ double GetValue(wxSPINCTRL_GETVALUE_FIX) const { return DoGetValue(); }
+ double GetMin() const { return m_min; }
+ double GetMax() const { return m_max; }
+ double GetIncrement() const { return m_increment; }
+ unsigned GetDigits() const { return m_digits; }
// operations
- void SetValue(const wxString& value) { wxTextCtrl::SetValue(value); }
- void SetValue(int val) { wxString s; s << val; wxTextCtrl::SetValue(s); }
- void SetRange(int min, int max) { m_min = min; m_max = max; }
+ void SetValue(const wxString& value)
+ { wxSpinCtrlGenericBase::SetValue(value); }
+ void SetValue(double value) { DoSetValue(value); }
+ void SetRange(double minVal, double maxVal) { DoSetRange(minVal, maxVal); }
+ void SetIncrement(double inc) { DoSetIncrement(inc); }
+ void SetDigits(unsigned digits);
protected:
- // initialize m_min/max with the default values
- void Init() { SetRange(0, 100); }
+ virtual void DoSendEvent();
- int m_min;
- int m_max;
+ unsigned m_digits;
-private:
- DECLARE_DYNAMIC_CLASS(wxSpinCtrl)
+ DECLARE_DYNAMIC_CLASS(wxSpinCtrlDouble)
};
-#endif // wxUSE_SPINBTN/!wxUSE_SPINBTN
-
#endif // _WX_GENERIC_SPINCTRL_H_
-
projects / wxWidgets.git / blobdiff