NXWidgets: clatchbutton.hxx Source File

NXWidgets 1.19

clatchbutton.hxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/include/clatchbutton.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 all 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_CLATCHBUTTON_HXX
71 #define __INCLUDE_CLATCHBUTTON_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 "cstickybutton.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 latches down when clicked and unlatches when clicked again.
103 */
104
105 class CLatchButton : public CStickyButton
106 {
107 protected:
108 /**
109 * Handles button click events
110 *
111 * @param x The x coordinate of the click.
112 * @param y The y coordinate of the click.
113 */
114
115 virtual void onClick(nxgl_coord_t x, nxgl_coord_t y);
116
117 /**
118 * Redraws the button.
119 *
120 * @param x The x coordinate of the mouse.
121 * @param y The y coordinate of the mouse.
122 */
123
124 /**
125 * Copy constructor is protected to prevent usage.
126 */
127
128 inline CLatchButton(const CLatchButton &button) : CStickyButton(button) { }
129
130 public:
131
132 /**
133 * Constructor for buttons that display a string.
134 *
135 * @param pWidgetControl The controlling widget for the display.
136 * @param x The x coordinate of the button, relative to its parent.
137 * @param y The y coordinate of the button, relative to its parent.
138 * @param width The width of the button.
139 * @param height The height of the button.
140 * @param text The text for the button to display.
141 * @param style The style that the button should use. If this is not
142 * specified, the button will use the global default widget
143 * style.
144 */
145
146 CLatchButton(CWidgetControl *pWidgetControl,
147 nxgl_coord_t x, nxgl_coord_t y,
148 nxgl_coord_t width, nxgl_coord_t height,
149 const CNxString &text,
150 CWidgetStyle *style = (CWidgetStyle *)NULL);
151
152 /**
153 * Destructor.
154 */
155
156 virtual inline ~CLatchButton(void) { }
157
158 /**
159 * Check if the button is latched
160 *
161 * @return True if the button is latched
162 */
163
164 inline const bool isLatched(void) const
165 {
166 return isStuckDown();
167 }
168 };
169 }
170
171 #endif // __cplusplus
172
173 #endif // __INCLUDE_CLATCHBUTTON_HXX
NXWidgets::CLatchButton::isLatched
const bool isLatched(void) const
Definition: clatchbutton.hxx:164
NXWidgets::CWidgetStyle
Definition: cwidgetstyle.hxx:125
NXWidgets::CWidgetControl
Definition: cwidgetcontrol.hxx:95
NXWidgets::CLatchButton
Definition: clatchbutton.hxx:105
cwidgetstyle.hxx
NXWidgets
Definition: cbgwindow.hxx:65
NXWidgets::CLatchButton::~CLatchButton
virtual ~CLatchButton(void)
Definition: clatchbutton.hxx:156
NXWidgets::CStickyButton
Definition: cstickybutton.hxx:105
cstickybutton.hxx
NXWidgets::CLatchButton::CLatchButton
CLatchButton(const CLatchButton &button)
Definition: clatchbutton.hxx:128
NXWidgets::CLatchButton::onClick
virtual void onClick(nxgl_coord_t x, nxgl_coord_t y)
Definition: clatchbutton.cxx:126
NXWidgets::CNxString
Definition: cnxstring.hxx:121
NXWidgets::CStickyButton::isStuckDown
const bool isStuckDown(void) const
Definition: cstickybutton.hxx:228