]> git.saurik.com Git - wxWidgets.git/blame - include/wx/spinctrl.h
Use correct reload flags on all platforms to avoid compilation errors
[wxWidgets.git] / include / wx / spinctrl.h
CommitLineData
b782f2e0 1/////////////////////////////////////////////////////////////////////////////
80fdcdb9 2// Name: wx/spinctrl.h
b782f2e0
VZ
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
65571936 9// Licence: wxWindows licence
b782f2e0
VZ
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_SPINCTRL_H_
13#define _WX_SPINCTRL_H_
14
2ecf902b
WS
15#include "wx/defs.h"
16
17#if wxUSE_SPINCTRL
18
9d9b7755 19#include "wx/spinbutt.h" // should make wxSpinEvent visible to the app
b782f2e0 20
3c778901
VZ
21// Events
22class WXDLLIMPEXP_FWD_CORE wxSpinDoubleEvent;
23
9b11752c
VZ
24wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SPINCTRL_UPDATED, wxSpinEvent);
25wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, wxSpinDoubleEvent);
3c778901 26
b782f2e0 27// ----------------------------------------------------------------------------
8cd6a9ad
VZ
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.
b782f2e0
VZ
31// ----------------------------------------------------------------------------
32
53a2db12 33class WXDLLIMPEXP_CORE wxSpinCtrlBase : public wxControl
b782f2e0
VZ
34{
35public:
8cd6a9ad 36 wxSpinCtrlBase() {}
b782f2e0 37
8cd6a9ad
VZ
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
b782f2e0 45
8cd6a9ad 46 // operation functions that derived classes are expected to have
36f210c8 47 virtual void SetValue(const wxString& value) = 0;
8cd6a9ad
VZ
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
b782f2e0 53
8cd6a9ad 54 // Select text in the textctrl
14bc59a2
VZ
55 virtual void SetSelection(long from, long to) = 0;
56
8cd6a9ad 57private:
c0c133e1 58 wxDECLARE_NO_COPY_CLASS(wxSpinCtrlBase);
8cd6a9ad
VZ
59};
60
61// ----------------------------------------------------------------------------
62// wxSpinDoubleEvent - a wxSpinEvent for double valued controls
63// ----------------------------------------------------------------------------
64
53a2db12 65class WXDLLIMPEXP_CORE wxSpinDoubleEvent : public wxNotifyEvent
8cd6a9ad
VZ
66{
67public:
68 wxSpinDoubleEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
69 double value = 0)
70 : wxNotifyEvent(commandType, winid), m_value(value)
71 {
72 }
73
74 wxSpinDoubleEvent(const wxSpinDoubleEvent& event)
75 : wxNotifyEvent(event), m_value(event.GetValue())
76 {
77 }
78
79 double GetValue() const { return m_value; }
80 void SetValue(double value) { m_value = value; }
81
82 virtual wxEvent *Clone() const { return new wxSpinDoubleEvent(*this); }
83
b782f2e0 84protected:
8cd6a9ad 85 double m_value;
b782f2e0 86
8cd6a9ad
VZ
87private:
88 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSpinDoubleEvent)
b782f2e0 89};
8cd6a9ad
VZ
90
91// ----------------------------------------------------------------------------
92// wxSpinDoubleEvent event type, see also wxSpinEvent in wx/spinbutt.h
93// ----------------------------------------------------------------------------
94
95typedef void (wxEvtHandler::*wxSpinDoubleEventFunction)(wxSpinDoubleEvent&);
96
97#define wxSpinDoubleEventHandler(func) \
3c778901 98 wxEVENT_HANDLER_CAST(wxSpinDoubleEventFunction, func)
8cd6a9ad
VZ
99
100// macros for handling spinctrl events
101
102#define EVT_SPINCTRL(id, fn) \
103 wx__DECLARE_EVT1(wxEVT_COMMAND_SPINCTRL_UPDATED, id, wxSpinEventHandler(fn))
104
105#define EVT_SPINCTRLDOUBLE(id, fn) \
106 wx__DECLARE_EVT1(wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, id, wxSpinDoubleEventHandler(fn))
b782f2e0
VZ
107
108// ----------------------------------------------------------------------------
109// include the platform-dependent class implementation
110// ----------------------------------------------------------------------------
111
8cd6a9ad
VZ
112// we may have a native wxSpinCtrl implementation, native wxSpinCtrl and
113// wxSpinCtrlDouble implementations or neither, define the appropriate symbols
114// and include the generic version if necessary to provide the missing class(es)
115
116#if defined(__WXUNIVERSAL__) || \
117 defined(__WXMOTIF__) || \
118 defined(__WXCOCOA__)
119 // nothing, use generic controls
3a5bcc4d 120#elif defined(__WXMSW__)
8cd6a9ad 121 #define wxHAS_NATIVE_SPINCTRL
b782f2e0 122 #include "wx/msw/spinctrl.h"
04701dd9 123#elif defined(__WXPM__)
8cd6a9ad 124 #define wxHAS_NATIVE_SPINCTRL
04701dd9 125 #include "wx/os2/spinctrl.h"
1be7a35c 126#elif defined(__WXGTK20__)
8cd6a9ad
VZ
127 #define wxHAS_NATIVE_SPINCTRL
128 #define wxHAS_NATIVE_SPINCTRLDOUBLE
738f9e5a 129 #include "wx/gtk/spinctrl.h"
1be7a35c 130#elif defined(__WXGTK__)
8cd6a9ad 131 #define wxHAS_NATIVE_SPINCTRL
1be7a35c 132 #include "wx/gtk1/spinctrl.h"
1e5e1c40 133#elif defined(__WXMAC__)
8cd6a9ad 134 #define wxHAS_NATIVE_SPINCTRL
ef0e9220 135 #include "wx/osx/spinctrl.h"
b782f2e0
VZ
136#endif // platform
137
8cd6a9ad
VZ
138#if !defined(wxHAS_NATIVE_SPINCTRL) || !defined(wxHAS_NATIVE_SPINCTRLDOUBLE)
139 #include "wx/generic/spinctlg.h"
140#endif
5dd26b08 141
2ecf902b 142#endif // wxUSE_SPINCTRL
b782f2e0 143
2ecf902b 144#endif // _WX_SPINCTRL_H_