]>
Commit | Line | Data |
---|---|---|
1 | /////////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/univ/checkbox.h | |
3 | // Purpose: wxCheckBox declaration | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 07.09.00 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com) | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_UNIV_CHECKBOX_H_ | |
13 | #define _WX_UNIV_CHECKBOX_H_ | |
14 | ||
15 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) | |
16 | #pragma interface "univcheckbox.h" | |
17 | #endif | |
18 | ||
19 | #include "wx/button.h" // for wxStdButtonInputHandler | |
20 | ||
21 | // ---------------------------------------------------------------------------- | |
22 | // the actions supported by wxCheckBox | |
23 | // ---------------------------------------------------------------------------- | |
24 | ||
25 | #define wxACTION_CHECKBOX_CHECK _T("check") // SetValue(true) | |
26 | #define wxACTION_CHECKBOX_CLEAR _T("clear") // SetValue(false) | |
27 | #define wxACTION_CHECKBOX_TOGGLE _T("toggle") // toggle the check state | |
28 | ||
29 | // additionally it accepts wxACTION_BUTTON_PRESS and RELEASE | |
30 | ||
31 | // ---------------------------------------------------------------------------- | |
32 | // wxCheckBox | |
33 | // ---------------------------------------------------------------------------- | |
34 | ||
35 | // X11 headers may define this | |
36 | #ifdef Status | |
37 | #undef Status | |
38 | #endif | |
39 | ||
40 | class WXDLLEXPORT wxCheckBox : public wxCheckBoxBase | |
41 | { | |
42 | public: | |
43 | // checkbox constants | |
44 | enum State | |
45 | { | |
46 | State_Normal, | |
47 | State_Pressed, | |
48 | State_Disabled, | |
49 | State_Current, | |
50 | State_Max | |
51 | }; | |
52 | ||
53 | enum Status | |
54 | { | |
55 | Status_Checked, | |
56 | Status_Unchecked, | |
57 | Status_Unknown, | |
58 | Status_Max | |
59 | }; | |
60 | ||
61 | // constructors | |
62 | wxCheckBox() { Init(); } | |
63 | ||
64 | wxCheckBox(wxWindow *parent, | |
65 | wxWindowID id, | |
66 | const wxString& label, | |
67 | const wxPoint& pos = wxDefaultPosition, | |
68 | const wxSize& size = wxDefaultSize, | |
69 | long style = 0, | |
70 | const wxValidator& validator = wxDefaultValidator, | |
71 | const wxString& name = wxCheckBoxNameStr) | |
72 | { | |
73 | Init(); | |
74 | ||
75 | Create(parent, id, label, pos, size, style, validator, name); | |
76 | } | |
77 | ||
78 | bool Create(wxWindow *parent, | |
79 | wxWindowID id, | |
80 | const wxString& label, | |
81 | const wxPoint& pos = wxDefaultPosition, | |
82 | const wxSize& size = wxDefaultSize, | |
83 | long style = 0, | |
84 | const wxValidator& validator = wxDefaultValidator, | |
85 | const wxString& name = wxCheckBoxNameStr); | |
86 | ||
87 | // implement the checkbox interface | |
88 | virtual void SetValue(bool value); | |
89 | virtual bool GetValue() const; | |
90 | ||
91 | // set/get the bitmaps to use for the checkbox indicator | |
92 | void SetBitmap(const wxBitmap& bmp, State state, Status status); | |
93 | virtual wxBitmap GetBitmap(State state, Status status) const; | |
94 | ||
95 | // wxCheckBox actions | |
96 | void Toggle(); | |
97 | virtual void Press(); | |
98 | virtual void Release(); | |
99 | virtual void ChangeValue(bool value); | |
100 | ||
101 | // overridden base class virtuals | |
102 | virtual bool IsPressed() const { return m_isPressed; } | |
103 | ||
104 | virtual bool HasTransparentBackground() { return true; } | |
105 | ||
106 | protected: | |
107 | virtual bool PerformAction(const wxControlAction& action, | |
108 | long numArg = -1, | |
109 | const wxString& strArg = wxEmptyString); | |
110 | virtual void DoDraw(wxControlRenderer *renderer); | |
111 | virtual wxSize DoGetBestClientSize() const; | |
112 | ||
113 | virtual bool CanBeHighlighted() const { return true; } | |
114 | ||
115 | // get the size of the bitmap using either the current one or the default | |
116 | // one (query renderer then) | |
117 | virtual wxSize GetBitmapSize() const; | |
118 | ||
119 | // common part of all ctors | |
120 | void Init(); | |
121 | ||
122 | // send command event notifying about the checkbox state change | |
123 | virtual void SendEvent(); | |
124 | ||
125 | // called when the checkbox becomes checked - radio button hook | |
126 | virtual void OnCheck(); | |
127 | ||
128 | // get the state corresponding to the flags (combination of wxCONTROL_XXX) | |
129 | wxCheckBox::State GetState(int flags) const; | |
130 | ||
131 | // directly access the bitmaps array without trying to find a valid bitmap | |
132 | // to use as GetBitmap() does | |
133 | wxBitmap DoGetBitmap(State state, Status status) const | |
134 | { return m_bitmaps[state][status]; } | |
135 | ||
136 | // get the current status | |
137 | Status GetStatus() const { return m_status; } | |
138 | ||
139 | private: | |
140 | // the current check status | |
141 | Status m_status; | |
142 | ||
143 | // the bitmaps to use for the different states | |
144 | wxBitmap m_bitmaps[State_Max][Status_Max]; | |
145 | ||
146 | // is the checkbox currently pressed? | |
147 | bool m_isPressed; | |
148 | ||
149 | DECLARE_DYNAMIC_CLASS(wxCheckBox) | |
150 | }; | |
151 | ||
152 | // ---------------------------------------------------------------------------- | |
153 | // wxStdCheckboxInputHandler: handles the mouse events for the check and radio | |
154 | // boxes (handling the keyboard input is simple, but its handling differs a | |
155 | // lot between GTK and MSW, so a new class should be derived for this) | |
156 | // ---------------------------------------------------------------------------- | |
157 | ||
158 | class WXDLLEXPORT wxStdCheckboxInputHandler : public wxStdButtonInputHandler | |
159 | { | |
160 | public: | |
161 | wxStdCheckboxInputHandler(wxInputHandler *inphand); | |
162 | ||
163 | // we have to override this one as wxStdButtonInputHandler version works | |
164 | // only with the buttons | |
165 | virtual bool HandleActivation(wxInputConsumer *consumer, bool activated); | |
166 | }; | |
167 | ||
168 | #endif // _WX_UNIV_CHECKBOX_H_ |