NXWidgets: islider.hxx Source File

NXWidgets 1.19

islider.hxx
Go to the documentation of this file.
1 /****************************************************************************
2 * NxWidgets/libnxwidgets/include/islider.hxx
3 *
4 * Copyright (C) 2012, 2014 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_ISLIDER_HXX
71 #define __INCLUDE_ISLIDER_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 /****************************************************************************
85 * Pre-Processor Definitions
86 ****************************************************************************/
87
88 /****************************************************************************
89 * Abstract Base Classes
90 ****************************************************************************/
91
92 #if defined(__cplusplus)
93
94 namespace NXWidgets
95 {
96 /**
97 * Defines the interface for slider widgets.
98 */
99 class ISlider
100 {
101 public:
102 /**
103 * A virtual destructor is required in order to override the ISlider
104 * destructor. We do this because if we delete ISlider, we want the
105 * destructor of the class that inherits from ISlider to run, not this
106 * one.
107 */
108
109 virtual ~ISlider(void) { }
110
111 /**
112 * Get the smallest value that the slider can represent.
113 *
114 * @return The smallest value.
115 */
116
117 virtual const int getMinimumValue(void) const = 0;
118
119 /**
120 * Get the largest value that the slider can represent.
121 *
122 * @return The largest value.
123 */
124
125 virtual const int getMaximumValue(void) const = 0;
126
127 /**
128 * Get the current value of the slider.
129 *
130 * return The current slider value.
131 */
132
133 virtual const int getValue(void) const = 0;
134
135 /**
136 * Get the value represented by the height of the grip.
137 * For sliders, this would typically be 1 (so each new
138 * grip position is worth 1). For scrollbars, this
139 * would be the height of the scrolling widget.
140 *
141 * @return The page size.
142 */
143
144 virtual const nxgl_coord_t getPageSize(void) const = 0;
145
146 /**
147 * Set the smallest value that the slider can represent.
148 *
149 * @param value The smallest value.
150 */
151
152 virtual void setMinimumValue(const int value) = 0;
153
154 /**
155 * Set the largest value that the slider can represent.
156 *
157 * @param value The largest value.
158 */
159
160 virtual void setMaximumValue(const int value) = 0;
161
162 /**
163 * Set the value that of the slider. This will reposition
164 * and redraw the grip.
165 *
166 * @param value The new value.
167 */
168
169 virtual void setValue(const int value) = 0;
170
171 /**
172 * Set the value that of the slider. This will reposition and redraw
173 * the grip. The supplied value should be bitshifted left 16 places.
174 * This ensures greater accuracy than the standard setValue() method if
175 * the slider is being used as a scrollbar.
176 *
177 * @param value The new value.
178 */
179
180 virtual void setValueWithBitshift(const int32_t value) = 0;
181
182 /**
183 * Set the page size represented by the grip.
184 *
185 * @param pageSize The page size.
186 * @see getPageSize().
187 */
188
189 virtual void setPageSize(const nxgl_coord_t pageSize) = 0;
190 };
191 }
192
193 #endif // __cplusplus
194
195 #endif // __INCLUDE_ISLIDER_HXX
196
NXWidgets::ISlider::setMaximumValue
virtual void setMaximumValue(const int value)=0
NXWidgets::ISlider::getMaximumValue
virtual const int getMaximumValue(void) const =0
NXWidgets::ISlider::setValue
virtual void setValue(const int value)=0
NXWidgets::ISlider::setMinimumValue
virtual void setMinimumValue(const int value)=0
NXWidgets::ISlider::getMinimumValue
virtual const int getMinimumValue(void) const =0
NXWidgets
Definition: cbgwindow.hxx:65
NXWidgets::ISlider::getValue
virtual const int getValue(void) const =0
NXWidgets::ISlider::~ISlider
virtual ~ISlider(void)
Definition: islider.hxx:109
NXWidgets::ISlider
Definition: islider.hxx:99
NXWidgets::ISlider::setValueWithBitshift
virtual void setValueWithBitshift(const int32_t value)=0
NXWidgets::ISlider::setPageSize
virtual void setPageSize(const nxgl_coord_t pageSize)=0
NXWidgets::ISlider::getPageSize
virtual const nxgl_coord_t getPageSize(void) const =0