X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1e6feb95a79834836e88143b15d9f424ebe79621..8e77fd8bca165aab9709649d79a7cbc6a172d4e1:/include/wx/spinctrl.h?ds=inline diff --git a/include/wx/spinctrl.h b/include/wx/spinctrl.h index b73167b72b..d63d13ce62 100644 --- a/include/wx/spinctrl.h +++ b/include/wx/spinctrl.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: spinctrl.h +// Name: wx/spinctrl.h // Purpose: wxSpinCtrlBase class // Author: Vadim Zeitlin // Modified by: @@ -12,58 +12,145 @@ #ifndef _WX_SPINCTRL_H_ #define _WX_SPINCTRL_H_ +#include "wx/defs.h" + +#if wxUSE_SPINCTRL + #include "wx/spinbutt.h" // should make wxSpinEvent visible to the app +// Events +class WXDLLIMPEXP_FWD_CORE wxSpinDoubleEvent; + +wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SPINCTRL, wxSpinEvent); +wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_SPINCTRLDOUBLE, wxSpinDoubleEvent); + // ---------------------------------------------------------------------------- -// a spin ctrl is a text control with a spin button which is usually used to -// prompt the user for a numeric input +// A spin ctrl is a text control with a spin button which is usually used to +// prompt the user for a numeric input. +// There are two kinds for number types T=integer or T=double. // ---------------------------------------------------------------------------- -/* there is no generic base class for this control because it's imlpemented - very differently under MSW and other platforms - -class WXDLLEXPORT wxSpinCtrlBase : public wxControl +class WXDLLIMPEXP_CORE wxSpinCtrlBase : public wxControl { public: - wxSpinCtrlBase() { Init(); } + wxSpinCtrlBase() {} - // accessors - virtual int GetValue() const = 0; - virtual int GetMin() const { return m_min; } - virtual int GetMax() const { return m_max; } + // accessor functions that derived classes are expected to have + // T GetValue() const + // T GetMin() const + // T GetMax() const + // T GetIncrement() const + virtual bool GetSnapToTicks() const = 0; + // unsigned GetDigits() const - wxSpinCtrlDouble only - // operations + // operation functions that derived classes are expected to have virtual void SetValue(const wxString& value) = 0; - virtual void SetValue(int val) = 0; - virtual void SetRange(int minVal, int maxVal) = 0; + // void SetValue(T val) + // void SetRange(T minVal, T maxVal) + // void SetIncrement(T inc) + virtual void SetSnapToTicks(bool snap_to_ticks) = 0; + // void SetDigits(unsigned digits) - wxSpinCtrlDouble only + + // The base for numbers display, e.g. 10 or 16. + virtual int GetBase() const = 0; + virtual bool SetBase(int base) = 0; + + // Select text in the textctrl + virtual void SetSelection(long from, long to) = 0; + +private: + wxDECLARE_NO_COPY_CLASS(wxSpinCtrlBase); +}; + +// ---------------------------------------------------------------------------- +// wxSpinDoubleEvent - a wxSpinEvent for double valued controls +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_CORE wxSpinDoubleEvent : public wxNotifyEvent +{ +public: + wxSpinDoubleEvent(wxEventType commandType = wxEVT_NULL, int winid = 0, + double value = 0) + : wxNotifyEvent(commandType, winid), m_value(value) + { + } + + wxSpinDoubleEvent(const wxSpinDoubleEvent& event) + : wxNotifyEvent(event), m_value(event.GetValue()) + { + } + + double GetValue() const { return m_value; } + void SetValue(double value) { m_value = value; } + + virtual wxEvent *Clone() const { return new wxSpinDoubleEvent(*this); } protected: - // initialize m_min/max with the default values - void Init() { m_min = 0; m_max = 100; } + double m_value; - int m_min; - int m_max; +private: + DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSpinDoubleEvent) }; -*/ + +// ---------------------------------------------------------------------------- +// wxSpinDoubleEvent event type, see also wxSpinEvent in wx/spinbutt.h +// ---------------------------------------------------------------------------- + +typedef void (wxEvtHandler::*wxSpinDoubleEventFunction)(wxSpinDoubleEvent&); + +#define wxSpinDoubleEventHandler(func) \ + wxEVENT_HANDLER_CAST(wxSpinDoubleEventFunction, func) + +// macros for handling spinctrl events + +#define EVT_SPINCTRL(id, fn) \ + wx__DECLARE_EVT1(wxEVT_SPINCTRL, id, wxSpinEventHandler(fn)) + +#define EVT_SPINCTRLDOUBLE(id, fn) \ + wx__DECLARE_EVT1(wxEVT_SPINCTRLDOUBLE, id, wxSpinDoubleEventHandler(fn)) // ---------------------------------------------------------------------------- // include the platform-dependent class implementation // ---------------------------------------------------------------------------- +// we may have a native wxSpinCtrl implementation, native wxSpinCtrl and +// wxSpinCtrlDouble implementations or neither, define the appropriate symbols +// and include the generic version if necessary to provide the missing class(es) + #if defined(__WXUNIVERSAL__) - #include "wx/generic/spinctlg.h" -#elif defined(__WXMSW__) && defined(__WIN32__) + // nothing, use generic controls +#elif defined(__WXMSW__) + #define wxHAS_NATIVE_SPINCTRL #include "wx/msw/spinctrl.h" #elif defined(__WXPM__) + #define wxHAS_NATIVE_SPINCTRL #include "wx/os2/spinctrl.h" -#elif defined(__WXGTK__) +#elif defined(__WXGTK20__) + #define wxHAS_NATIVE_SPINCTRL + #define wxHAS_NATIVE_SPINCTRLDOUBLE #include "wx/gtk/spinctrl.h" -#else // Win16 || !Win - #include "wx/generic/spinctlg.h" +#elif defined(__WXGTK__) + #define wxHAS_NATIVE_SPINCTRL + #include "wx/gtk1/spinctrl.h" #endif // platform -#define EVT_SPINCTRL(id, fn) \ - DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_SPINCTRL_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxSpinEventFunction) & fn, (wxObject *) NULL ), +#if !defined(wxHAS_NATIVE_SPINCTRL) || !defined(wxHAS_NATIVE_SPINCTRLDOUBLE) + #include "wx/generic/spinctlg.h" +#endif -#endif // _WX_SPINCTRL_H_ +namespace wxPrivate +{ +// This is an internal helper function currently used by all ports: return the +// string containing hexadecimal representation of the given number. +extern wxString wxSpinCtrlFormatAsHex(long val, long maxVal); + +} // namespace wxPrivate + +// old wxEVT_COMMAND_* constants +#define wxEVT_COMMAND_SPINCTRL_UPDATED wxEVT_SPINCTRL +#define wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED wxEVT_SPINCTRLDOUBLE + +#endif // wxUSE_SPINCTRL + +#endif // _WX_SPINCTRL_H_