NXWidgets: cradiobutton.hxx Source File

NXWidgets 1.19

cradiobutton.hxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/include/cradiobutton.hxx
3 *
4 * Copyright (C) 2012 Gregory Nutt. All rights reserved.
5 * Author: Gregory Nutt <gnutt@nuttx.org>
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
17 * 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
18 * me be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *
34 ****************************************************************************
35 *
36 * Portions of this package derive from Woopsi (http://woopsi.org/) and
37 * portions are original efforts. It is difficult to determine at this
38 * point what parts are original efforts and which parts derive from Woopsi.
39 * However, in any event, the work of Antony Dzeryn will be acknowledged
40 * in most NxWidget files. Thanks Antony!
41 *
42 * Copyright (c) 2007-2011, Antony Dzeryn
43 * All rights reserved.
44 *
45 * Redistribution and use in source and binary forms, with or without
46 * modification, are permitted provided that the following conditions are met:
47 *
48 * * Redistributions of source code must retain the above copyright
49 * notice, this list of conditions and the following disclaimer.
50 * * Redistributions in binary form must reproduce the above copyright
51 * notice, this list of conditions and the following disclaimer in the
52 * documentation and/or other materials provided with the distribution.
53 * * Neither the names "Woopsi", "Simian Zombie" nor the
54 * names of its contributors may be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY Antony Dzeryn ``AS IS'' AND ANY
58 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
59 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
60 * DISCLAIMED. IN NO EVENT SHALL Antony Dzeryn BE LIABLE FOR ANY
61 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
62 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
63 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
64 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
66 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 *
68 ****************************************************************************/
69
70 #ifndef __INCLUDE_CRADIOBUTTON_HXX
71 #define __INCLUDE_CRADIOBUTTON_HXX
72
73 /****************************************************************************
74 * Included Files
75 ****************************************************************************/
76
77 #include <nuttx/config.h>
78
79 #include <stdint.h>
80 #include <stdbool.h>
81
82 #include <nuttx/nx/nxglib.h>
83 #include <nuttx/nx/nx.h>
84
85 #include "cbutton.hxx"
86 #include "cwidgetstyle.hxx"
87
88 /****************************************************************************
89 * Pre-Processor Definitions
90 ****************************************************************************/
91
92 /****************************************************************************
93 * Implementation Classes
94 ****************************************************************************/
95
96 #if defined(__cplusplus)
97
98 namespace NXWidgets
99 {
100 class CWidgetControl;
101 class CRadioButtonGroup;
102
103 /**
104 * Represents a radio button. Radio buttons can only exist as part of a
105 * CRadioButtonGroup class, and should not be instantiated individually.
106 * Radio buttons are tri-state - off, on and "mu".
107 * The mu state cannot be enabled by a user - it can only be set by the
108 * developer.
109 */
110
111 class CRadioButton : public CButton
112 {
113 public:
114
115 /**
116 * Enum listing all possible radio button states.
117 */
118
119 enum RadioButtonState
120 {
121 RADIO_BUTTON_STATE_OFF = 0, /**< Radio button is off */
122 RADIO_BUTTON_STATE_ON = 1, /**< Radio button is on */
123 RADIO_BUTTON_STATE_MU = 2 /**< Radio button is in the third state */
124 };
125
126 protected:
127
128 RadioButtonState m_state; /**< The state of the radio button */
129
130 /**
131 * Draw the area of this widget that falls within the clipping region.
132 * Called by the redraw() function to draw all visible regions.
133 *
134 * @param port The CGraphicsPort to draw to.
135 * @see redraw()
136 */
137
138 virtual void drawContents(CGraphicsPort *port);
139
140 /**
141 * Sets the radiobutton's state to "on".
142 *
143 * @param x The x coordinate of the click.
144 * @param y The y coordinate of the click.
145 */
146
147 virtual void onClick(nxgl_coord_t x, nxgl_coord_t y);
148
149 /**
150 * Destructor.
151 */
152
153 virtual inline ~CRadioButton() { }
154
155 /**
156 * Copy constructor is protected to prevent usage.
157 */
158
159 inline CRadioButton(const CRadioButton &radioButton) : CButton(radioButton) { }
160
161 public:
162
163 /**
164 * Constructor.
165 *
166 * @param pWidgetControl The controlling widget for the display.
167 * @param x The x coordinate of the radio button, relative to its
168 * parent.
169 * @param y The y coordinate of the radio button, relative to its
170 * parent.
171 * @param width The width of the radio button.
172 * @param height The height of the radio button.
173 * @param style The style that the widget should use. If this is not
174 * specified, the widget will use the values stored in the global
175 * defaultCWidgetStyle object. The widget will copy the properties of
176 * the style into its own internal style object.
177 */
178
179 CRadioButton(CWidgetControl *pWidgetControl,
180 nxgl_coord_t x, nxgl_coord_t y,
181 nxgl_coord_t width, nxgl_coord_t height,
182 CWidgetStyle *style = (CWidgetStyle *)NULL);
183
184 /**
185 * Get the current state of the radio button.
186 *
187 * @return The state of the radio button.
188 */
189
190 virtual inline RadioButtonState getState(void)
191 {
192 return m_state;
193 }
194
195 /**
196 * Set the state of the radio button.
197 *
198 * @param state The new radio button state.
199 */
200
201 virtual void setState(RadioButtonState state);
202 };
203 }
204
205 #endif // __cplusplus
206
207 #endif // __INCLUDE_CRADIOBUTTON_HXX
NXWidgets::CRadioButton::m_state
RadioButtonState m_state
Definition: cradiobutton.hxx:128
NXWidgets::CWidgetStyle
Definition: cwidgetstyle.hxx:125
NXWidgets::CRadioButton::RADIO_BUTTON_STATE_ON
Definition: cradiobutton.hxx:122
NXWidgets::CRadioButton::~CRadioButton
virtual ~CRadioButton()
Definition: cradiobutton.hxx:153
NXWidgets::CWidgetControl
Definition: cwidgetcontrol.hxx:95
NXWidgets::CRadioButton
Definition: cradiobutton.hxx:111
NXWidgets::CRadioButton::drawContents
virtual void drawContents(CGraphicsPort *port)
Definition: cradiobutton.cxx:156
cwidgetstyle.hxx
NXWidgets
Definition: cbgwindow.hxx:65
NXWidgets::CRadioButton::RADIO_BUTTON_STATE_OFF
Definition: cradiobutton.hxx:121
NXWidgets::CRadioButton::CRadioButton
CRadioButton(const CRadioButton &radioButton)
Definition: cradiobutton.hxx:159
NXWidgets::CRadioButton::getState
virtual RadioButtonState getState(void)
Definition: cradiobutton.hxx:190
NXWidgets::CRadioButton::RADIO_BUTTON_STATE_MU
Definition: cradiobutton.hxx:123
cbutton.hxx
NXWidgets::CRadioButton::RadioButtonState
RadioButtonState
Definition: cradiobutton.hxx:119
NXWidgets::CRadioButton::setState
virtual void setState(RadioButtonState state)
Definition: cradiobutton.cxx:132
NXWidgets::CRadioButton::onClick
virtual void onClick(nxgl_coord_t x, nxgl_coord_t y)
Definition: cradiobutton.cxx:222
NXWidgets::CButton
Definition: cbutton.hxx:109
NXWidgets::CGraphicsPort
Definition: cgraphicsport.hxx:106