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
|
/*
* This source file is part of libRocket, the HTML/CSS Interface Middleware
*
* For the latest information, see http://www.librocket.com
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#ifndef ROCKETCONTROLSWIDGETSLIDER_H
#define ROCKETCONTROLSWIDGETSLIDER_H
#include "../../Include/Rocket/Core/EventListener.h"
namespace Rocket {
namespace Controls {
class ElementFormControl;
/**
A generic widget for incorporating sliding functionality into an element.
@author Peter Curry
*/
class WidgetSlider : public Core::EventListener
{
public:
enum Orientation
{
VERTICAL,
HORIZONTAL
};
WidgetSlider(ElementFormControl* parent);
virtual ~WidgetSlider();
/// Initialises the slider's hidden elements.
bool Initialise();
/// Updates the key repeats for the increment / decrement arrows.
void Update();
/// Sets the position of the bar.
/// @param[in] bar_position The new position of the bar (0 representing the start of the track, 1 representing the end).
void SetBarPosition(float bar_position);
/// Returns the current position of the bar.
/// @return The current position of the bar (0 representing the start of the track, 1 representing the end).
float GetBarPosition();
/// Sets the orientation of the slider.
/// @param[in] orientation The slider's new orientation.
void SetOrientation(Orientation orientation);
/// Returns the slider's orientation.
/// @return The orientation of the slider.
Orientation GetOrientation() const;
/// Sets the dimensions to the size of the slider.
/// @param[in] dimensions The dimensions to size.
void GetDimensions(Rocket::Core::Vector2f& dimensions) const;
protected:
/// Lays out and resizes the slider's internal elements.
/// @param[in] containing_block The padded box containing the slider. This is used to resolve relative properties.
/// @param[in] slider_length The total length, in pixels, of the slider widget.
/// @param[in] bar_length The total length of the bar, as a proportion of the track length. If this is -1, the intrinsic length will be used.
void FormatElements(const Rocket::Core::Vector2f& containing_block, float slider_length, float bar_length = -1);
/// Lays out and positions the bar element.
/// @param[in] bar_length The total length of the bar, as a proportion of the track length. If this is -1, the intrinsic length will be used.
void FormatBar(float bar_length = -1);
/// Returns the widget's parent element.
Core::Element* GetParent() const;
/// Handles events coming through from the slider's components.
virtual void ProcessEvent(Core::Event& event);
/// Called when the slider's bar position is set or dragged.
/// @param[in] bar_position The new position of the bar (0 representing the start of the track, 1 representing the end).
/// @return The new position of the bar.
virtual float OnBarChange(float bar_position) = 0;
/// Called when the slider is incremented by one 'line', either by the down / right key or a mouse-click on the
/// increment arrow.
/// @return The new position of the bar.
virtual float OnLineIncrement() = 0;
/// Called when the slider is decremented by one 'line', either by the up / left key or a mouse-click on the
/// decrement arrow.
/// @return The new position of the bar.
virtual float OnLineDecrement() = 0;
/// Called when the slider is incremented by one 'page', either by the page-up key or a mouse-click on the
/// track below / right of the bar.
/// @param[in] click_position The parametric position of the click along the track, or -1 if this was not generated by a mouse click.
/// @return The new position of the bar.
virtual float OnPageIncrement(float click_position) = 0;
/// Called when the slider is incremented by one 'page', either by the page-down key or a mouse-click on the
/// track above / left of the bar.
/// @param[in] click_position The parametric position of the click along the track, or -1 if this was not generated by a mouse click.
/// @return The new position of the bar.
virtual float OnPageDecrement(float click_position) = 0;
private:
void PositionBar();
ElementFormControl* parent;
Orientation orientation;
// The background track element, across which the bar slides.
Core::Element* track;
// The bar element. This is the element that is dragged across the trough.
Core::Element* bar;
// The two (optional) buttons for incrementing and decrementing the slider.
Core::Element* arrows[2];
// A number from 0 to 1, indicating how far along the track the bar is.
float bar_position;
// If the bar is being dragged, this is the pixel offset from the start of the bar to where it was picked up.
int bar_drag_anchor;
// Set to the auto-repeat timer if either of the arrow buttons have been pressed, -1 if they haven't.
float arrow_timers[2];
float last_update_time;
};
}
}
#endif
|
