NXWidgets: cstickybutton.cxx Source File

NXWidgets 1.19

cstickybutton.cxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/src/cstickybutton.cxx
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 /****************************************************************************
71 * Included Files
72 ****************************************************************************/
73
74 #include <nuttx/config.h>
75
76 #include <sys/types.h>
77 #include <stdint.h>
78 #include <stdbool.h>
79
80 #include <nuttx/nx/nxglib.h>
81
82 #include "cstickybutton.hxx"
83 #include "cgraphicsport.hxx"
84
85 /****************************************************************************
86 * Pre-Processor Definitions
87 ****************************************************************************/
88
89 /****************************************************************************
90 * CButton Method Implementations
91 ****************************************************************************/
92
93 using namespace NXWidgets;
94
95 /**
96 * Constructor for buttons that display a string.
97 *
98 * @param pWidgetControl The controlling widget for the display.
99 * @param x The x coordinate of the button, relative to its parent.
100 * @param y The y coordinate of the button, relative to its parent.
101 * @param width The width of the button.
102 * @param height The height of the button.
103 * @param text The text for the button to display.
104 * @param style The style that the button should use. If this is not
105 * specified, the button will use the global default widget
106 * style.
107 */
108
109 CStickyButton::CStickyButton(CWidgetControl *pWidgetControl,
110 nxgl_coord_t x, nxgl_coord_t y,
111 nxgl_coord_t width, nxgl_coord_t height,
112 const CNxString &text,
113 CWidgetStyle *style)
114 : CButton(pWidgetControl, x, y, width, height, text, style)
115 {
116 m_isStuckDown = false;
117 }
118
119 /**
120 * Sets the key's stuck down state. If this is true, the key has a
121 * inwards-bevelled border when drawn. If it is false, the key has
122 * an outwards-bevelled border.
123 *
124 * @param stuckDown The new stuck down state.
125 */
126
127 void CStickyButton::setStuckDown(bool stuckDown)
128 {
129 m_isStuckDown = stuckDown;
130 redraw();
131 }
132
133 /**
134 * Draws the outline of the button.
135 *
136 * @param port Graphics port to draw to.
137 */
138
139 void CStickyButton::drawOutline(CGraphicsPort *port)
140 {
141 CButton::drawOutline(port, m_isStuckDown);
142 }
143
144 /**
145 * Draw the area of this widget that falls within the clipping region.
146 * Called by the redraw() function to draw all visible regions.
147 *
148 * @param port The CGraphicsPort to draw to.
149 * @see redraw()
150 */
151
152 void CStickyButton::drawContents(CGraphicsPort *port)
153 {
154 CButton::drawContents(port, m_isStuckDown);
155 }
156
157 /**
158 * Draw the area of this widget that falls within the clipping region.
159 * Called by the redraw() function to draw all visible regions.
160 *
161 * @param port The CGraphicsPort to draw to.
162 * @see redraw()
163 */
164
165 void CStickyButton::drawBorder(CGraphicsPort *port)
166 {
167 CButton::drawBorder(port, m_isStuckDown);
168 }
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::CWidgetControl
Definition: cwidgetcontrol.hxx:95
NXWidgets::CButton::drawBorder
virtual void drawBorder(CGraphicsPort *port)
Definition: cbutton.cxx:232
cgraphicsport.hxx
NXWidgets::CButton::drawOutline
virtual void drawOutline(CGraphicsPort *port)
Definition: cbutton.cxx:123
NXWidgets::CNxWidget::redraw
void redraw(void)
Definition: cnxwidget.cxx:483
NXWidgets
Definition: cbgwindow.hxx:65
cstickybutton.hxx
NXWidgets::CButton::drawContents
virtual void drawContents(CGraphicsPort *port)
Definition: cbutton.cxx:175
NXWidgets::CStickyButton::drawOutline
virtual void drawOutline(CGraphicsPort *port)
Definition: cstickybutton.cxx:139
NXWidgets::CStickyButton::m_isStuckDown
bool m_isStuckDown
Definition: cstickybutton.hxx:108
NXWidgets::CNxString
Definition: cnxstring.hxx:121
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::CGraphicsPort
Definition: cgraphicsport.hxx:106