1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naess�n and Per Larsson
* Copyright (C) 2011-2014 The ManaPlus Developers
*
*
* Per Larsson a.k.a finalman
* Olof Naess�n a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GCN_SLIDER_HPP
#define GCN_SLIDER_HPP
#include "guichan/keylistener.hpp"
#include "guichan/mouselistener.hpp"
#include "guichan/platform.hpp"
#include "guichan/widget.hpp"
namespace gcn
{
/**
* An implementation of a slider where a user can select different values by
* sliding between a start value and an end value of a scale.
*
* If the selected value is changed an action event will be sent to all
* action listeners of the slider.
*/
class GCN_CORE_DECLSPEC Slider :
public Widget,
public MouseListener,
public KeyListener
{
public:
/**
* Draw orientations for the slider. A slider can be drawn vertically or
* horizontally.
*/
enum Orientation
{
HORIZONTAL = 0,
VERTICAL
};
/**
* Constructor. The default start value of the slider scale is zero.
*
* @param scaleEnd The end value of the slider scale.
*/
explicit Slider(const double scaleEnd = 1.0);
/**
* Constructor.
*
* @param scaleStart The start value of the slider scale.
* @param scaleEnd The end value of the slider scale.
*/
Slider(const double scaleStart, const double scaleEnd);
A_DELETE_COPY(Slider)
/**
* Destructor.
*/
virtual ~Slider()
{ }
/**
* Sets the scale of the slider.
*
* @param scaleStart The start value of the scale.
* @param scaleEnd tThe end of value the scale.
* @see getScaleStart, getScaleEnd
*/
void setScale(double scaleStart, double scaleEnd);
/**
* Gets the start value of the scale.
*
* @return The start value of the scale.
* @see setScaleStart, setScale
*/
double getScaleStart() const;
/**
* Sets the start value of the scale.
*
* @param scaleStart The start value of the scale.
* @see getScaleStart
*/
void setScaleStart(double scaleStart);
/**
* Gets the end value of the scale.
*
* @return The end value of the scale.
* @see setScaleEnd, setScale
*/
double getScaleEnd() const;
/**
* Sets the end value of the scale.
*
* @param scaleEnd The end value of the scale.
* @see getScaleEnd
*/
void setScaleEnd(double scaleEnd);
/**
* Gets the current selected value.
*
* @return The current selected value.
* @see setValue
*/
double getValue() const;
/**
* Sets the current selected value.
*
* @param value The current selected value.
* @see getValue
*/
void setValue(double value);
/**
* Sets the length of the marker.
*
* @param length The length for the marker.
* @see getMarkerLength
*/
void setMarkerLength(int length);
/**
* Gets the length of the marker.
*
* @return The length of the marker.
* @see setMarkerLength
*/
int getMarkerLength() const;
/**
* Sets the orientation of the slider. A slider can be drawn vertically
* or horizontally.
*
* @param orientation The orientation of the slider.
* @see getOrientation
*/
void setOrientation(Orientation orientation);
/**
* Gets the orientation of the slider. A slider can be drawn vertically
* or horizontally.
*
* @return The orientation of the slider.
* @see setOrientation
*/
Orientation getOrientation() const;
/**
* Sets the step length. The step length is used when the keys LEFT
* and RIGHT are pressed to step in the scale.
*
* @param length The step length.
* @see getStepLength
*/
void setStepLength(double length);
/**
* Gets the step length. The step length is used when the keys LEFT
* and RIGHT are pressed to step in the scale.
*
* @return the step length.
* @see setStepLength
*/
double getStepLength() const;
protected:
/**
* Converts a marker position to a value in the scale.
*
* @param position The position to convert.
* @return A scale value corresponding to the position.
* @see valueToMarkerPosition
*/
virtual double markerPositionToValue(int position) const;
/**
* Converts a value to a marker position.
*
* @param value The value to convert.
* @return A marker position corresponding to the value.
* @see markerPositionToValue
*/
virtual int valueToMarkerPosition(double value) const;
/**
* Gets the marker position of the current selected value.
*
* @return The marker position of the current selected value.
*/
virtual int getMarkerPosition() const;
/**
* True if the slider is dragged, false otherwise.
*/
bool mDragged;
/**
* Holds the current selected value.
*/
double mValue;
/**
* Holds the step length. The step length is used when the keys LEFT
* and RIGHT are pressed to step in the scale.
*/
double mStepLength;
/**
* Holds the length of the marker.
*/
int mMarkerLength;
/**
* Holds the start value of the scale.
*/
double mScaleStart;
/**
* Holds the end value of the scale.
*/
double mScaleEnd;
/**
* Holds the orientation of the slider. A slider can be drawn
* vertically or horizontally.
*/
Orientation mOrientation;
};
} // namespace gcn
#endif // end GCN_SLIDER_HPP
|
