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
|
/*
* 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 ROCKETCOREELEMENTSCROLL_H
#define ROCKETCOREELEMENTSCROLL_H
#include "Header.h"
#include "EventListener.h"
namespace Rocket {
namespace Core {
class Element;
class WidgetSliderScroll;
/**
Manages an element's scrollbars and scrolling state.
@author Peter Curry
*/
class ROCKETCORE_API ElementScroll : public EventListener
{
public:
enum Orientation
{
VERTICAL = 0,
HORIZONTAL = 1
};
ElementScroll(Element* element);
virtual ~ElementScroll();
/// Updates the increment / decrement arrows.
void Update();
/// Enables and sizes one of the scrollbars.
/// @param[in] orientation Which scrollbar (vertical or horizontal) to enable.
/// @param[in] element_width The current computed width of the element, used only to resolve percentage properties.
void EnableScrollbar(Orientation orientation, float element_width);
/// Disables and hides one of the scrollbars.
/// @param[in] orientation Which scrollbar (vertical or horizontal) to disable.
void DisableScrollbar(Orientation orientation);
/// Updates the position of the scrollbar.
/// @param[in] orientation Which scrollbar (vertical or horizontal) to update).
void UpdateScrollbar(Orientation orientation);
/// Returns one of the scrollbar elements.
/// @param[in] orientation Which scrollbar to return.
/// @return The requested scrollbar, or NULL if it does not exist.
Element* GetScrollbar(Orientation orientation);
/// Returns the size, in pixels, of one of the scrollbars; for a vertical scrollbar, this is width, for a horizontal scrollbar, this is height.
/// @param[in] orientation Which scrollbar (vertical or horizontal) to query.
/// @return The size of the scrollbar, or 0 if the scrollbar is disabled.
float GetScrollbarSize(Orientation orientation);
/// Formats the enabled scrollbars based on the current size of the host element.
void FormatScrollbars();
protected:
/// Handles the 'onchange' events for the scrollbars.
void ProcessEvent(Event& event);
private:
struct Scrollbar
{
Scrollbar();
~Scrollbar();
Element* element;
WidgetSliderScroll* widget;
bool enabled;
float size;
};
// Creates one of the scroll component's scrollbar.
bool CreateScrollbar(Orientation orientation);
// Creates the scrollbar corner.
bool CreateCorner();
Element* element;
Scrollbar scrollbars[2];
Element* corner;
};
}
}
#endif
|
