NXWidgets: cstickybutton.hxx Source File

NXWidgets 1.19

cstickybutton.hxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/include/cstickybutton.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_CSTICKYBUTTON_HXX
71 #define __INCLUDE_CSTICKYBUTTON_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
84 #include "cbutton.hxx"
85 #include "cwidgetstyle.hxx"
86
87 /****************************************************************************
88 * Pre-Processor Definitions
89 ****************************************************************************/
90
91 /****************************************************************************
92 * Implementation Classes
93 ****************************************************************************/
94
95 #if defined(__cplusplus)
96
97 namespace NXWidgets
98 {
99 class CWidgetControl;
100
101 /**
102 * CButton that sticks down when clicked.
103 */
104
105 class CStickyButton : public CButton
106 {
107 protected:
108 bool m_isStuckDown; /**< True if the key is stuck down */
109
110 /**
111 * Draws the outline of the button.
112 *
113 * @param port Graphics port to draw to.
114 */
115
116 virtual void drawOutline(CGraphicsPort *port);
117
118 /**
119 * Draw the area of this widget that falls within the clipping region.
120 * Called by the redraw() function to draw all visible regions.
121 *
122 * @param port The CGraphicsPort to draw to.
123 * @see redraw()
124 */
125
126 virtual void drawContents(CGraphicsPort *port);
127
128 /**
129 * Draw the area of this widget that falls within the clipping region.
130 * Called by the redraw() function to draw all visible regions.
131 *
132 * @param port The CGraphicsPort to draw to.
133 * @see redraw()
134 */
135
136 virtual void drawBorder(CGraphicsPort *port);
137
138 /**
139 * Don't redraw on button press events. The button display is
140 * completely controlled by the externally controlled stuck state.
141 *
142 * @param x The x coordinate of the click.
143 * @param y The y coordinate of the click.
144 */
145
146 virtual void onClick(nxgl_coord_t x, nxgl_coord_t y) {}
147
148 /**
149 * Don't redraw on button release events. The button display is
150 * completely controlled by the externally controlled stuck state.
151 *
152 * @param x The x coordinate of the mouse.
153 * @param y The y coordinate of the mouse.
154 */
155
156 virtual void onRelease(nxgl_coord_t x, nxgl_coord_t y) { }
157
158 /**
159 * Don't redraw on button release events. The button display is
160 * completely controlled by the externally controlled stuck state.
161 *
162 * @param x The x coordinate of the mouse.
163 * @param y The y coordinate of the mouse.
164 */
165
166 virtual void onReleaseOutside(nxgl_coord_t x, nxgl_coord_t y) { }
167
168 /**
169 * Copy constructor is protected to prevent usage. The button display is
170 * completely controlled by the externally controlled stuck state.
171 */
172
173 inline CStickyButton(const CStickyButton &button) : CButton(button) { }
174
175 public:
176
177 /**
178 * Constructor for buttons that display a string.
179 *
180 * @param pWidgetControl The controlling widget for the display.
181 * @param x The x coordinate of the button, relative to its parent.
182 * @param y The y coordinate of the button, relative to its parent.
183 * @param width The width of the button.
184 * @param height The height of the button.
185 * @param text The text for the button to display.
186 * @param style The style that the button should use. If this is not
187 * specified, the button will use the global default widget
188 * style.
189 */
190
191 CStickyButton(CWidgetControl *pWidgetControl,
192 nxgl_coord_t x, nxgl_coord_t y,
193 nxgl_coord_t width, nxgl_coord_t height,
194 const CNxString &text,
195 CWidgetStyle *style = (CWidgetStyle *)NULL);
196
197 /**
198 * Destructor.
199 */
200
201 virtual inline ~CStickyButton(void) { }
202
203 /**
204 * Sets the key's stuck down state. If this is true, the key has a
205 * inwards-bevelled border when drawn. If it is false, the key has
206 * an outwards-bevelled border.
207 *
208 * @param stuckDown The new stuck down state.
209 */
210
211 void setStuckDown(bool stuckDown);
212
213 /**
214 * Toggles the key's stuck down state.
215 */
216
217 inline void toggleStuckDown(void)
218 {
219 setStuckDown(!m_isStuckDown);
220 }
221
222 /**
223 * Returns the stuck down state.
224 *
225 * @return True is the button is in the stuck down state.
226 */
227
228 inline const bool isStuckDown(void) const
229 {
230 return m_isStuckDown;
231 }
232 };
233 }
234
235 #endif // __cplusplus
236
237 #endif // __INCLUDE_CSTICKYBUTTON_HXX
NXWidgets::CWidgetStyle
Definition: cwidgetstyle.hxx:125
NXWidgets::CStickyButton::CStickyButton
CStickyButton(const CStickyButton &button)
Definition: cstickybutton.hxx:173
NXWidgets::CStickyButton::drawContents
virtual void drawContents(CGraphicsPort *port)
Definition: cstickybutton.cxx:152
NXWidgets::CStickyButton::onReleaseOutside
virtual void onReleaseOutside(nxgl_coord_t x, nxgl_coord_t y)
Definition: cstickybutton.hxx:166
NXWidgets::CWidgetControl
Definition: cwidgetcontrol.hxx:95
cwidgetstyle.hxx
NXWidgets
Definition: cbgwindow.hxx:65
NXWidgets::CStickyButton::onRelease
virtual void onRelease(nxgl_coord_t x, nxgl_coord_t y)
Definition: cstickybutton.hxx:156
NXWidgets::CStickyButton
Definition: cstickybutton.hxx:105
NXWidgets::CStickyButton::toggleStuckDown
void toggleStuckDown(void)
Definition: cstickybutton.hxx:217
NXWidgets::CStickyButton::drawOutline
virtual void drawOutline(CGraphicsPort *port)
Definition: cstickybutton.cxx:139
cbutton.hxx
NXWidgets::CStickyButton::m_isStuckDown
bool m_isStuckDown
Definition: cstickybutton.hxx:108
NXWidgets::CNxString
Definition: cnxstring.hxx:121
NXWidgets::CStickyButton::onClick
virtual void onClick(nxgl_coord_t x, nxgl_coord_t y)
Definition: cstickybutton.hxx:146
NXWidgets::CStickyButton::isStuckDown
const bool isStuckDown(void) const
Definition: cstickybutton.hxx:228
NXWidgets::CStickyButton::drawBorder
virtual void drawBorder(CGraphicsPort *port)
Definition: cstickybutton.cxx:165
NXWidgets::CStickyButton::setStuckDown
void setStuckDown(bool stuckDown)
Definition: cstickybutton.cxx:127
NXWidgets::CButton
Definition: cbutton.hxx:109
NXWidgets::CStickyButton::~CStickyButton
virtual ~CStickyButton(void)
Definition: cstickybutton.hxx:201
NXWidgets::CGraphicsPort
Definition: cgraphicsport.hxx:106