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
|
/*
* 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 ROCKETCONTROLSWIDGETDROPDOWN_H
#define ROCKETCONTROLSWIDGETDROPDOWN_H
#include "../../Include/Rocket/Core/String.h"
#include "../../Include/Rocket/Core/EventListener.h"
#include "../../Include/Rocket/Controls/SelectOption.h"
#include <vector>
namespace Rocket {
namespace Controls {
class ElementFormControl;
/**
Widget for drop-down functionality.
@author Lloyd Weehuizen
*/
class WidgetDropDown : public Core::EventListener
{
public:
WidgetDropDown(ElementFormControl* element);
virtual ~WidgetDropDown();
/// Updates the selection box layout if necessary.
void OnRender();
/// Positions the drop-down's internal elements.
void OnLayout();
/// Sets the value of the widget.
/// @param[in] value The new value to set.
void SetValue(const Rocket::Core::String& value);
/// Returns the current value of the widget.
/// @return The current value of the widget.
const Rocket::Core::String& GetValue() const;
/// Sets the index of the selection. If the new index lies outside of the bounds, the selection index will be set to -1.
/// @param[in] selection The new selection index.
/// @param[in] force Forces the new selection, even if the widget believes the selection to not have changed.
void SetSelection(int selection, bool force = false);
/// Returns the index of the currently selected item.
/// @return The index of the currently selected item.
int GetSelection() const;
/// Adds a new option to the select control.
/// @param[in] rml The RML content used to represent the option.
/// @param[in] value The value of the option.
/// @param[in] before The index of the element to insert the new option before.
/// @param[in] select True to select the new option.
/// @param[in] selectable If true this option can be selected. If false, this option is not selectable.
/// @return The index of the new option.
int AddOption(const Rocket::Core::String& rml, const Rocket::Core::String& value, int before, bool select, bool selectable = true);
/// Removes an option from the select control.
/// @param[in] index The index of the option to remove.
void RemoveOption(int index);
/// Removes all options from the list.
void ClearOptions();
/// Returns on of the widget's options.
/// @param[in] The index of the desired option.
/// @return The option. This may be NULL if the index was out of bounds.
SelectOption* GetOption(int index);
/// Returns the number of options in the widget.
/// @return The number of options.
int GetNumOptions() const;
/// Processes the incoming event.
virtual void ProcessEvent(Core::Event& event);
private:
typedef std::vector< SelectOption > OptionList;
// Shows or hides the selection box.
void ShowSelectBox(bool show);
// Parent element that holds this widget
ElementFormControl* parent_element;
// The elements making up the drop-down process.
Core::Element* button_element;
Core::Element* selection_element;
Core::Element* value_element;
// The options in the drop down.
OptionList options;
int selected_option;
// The current value of the widget.
Rocket::Core::String value;
bool box_layout_dirty;
bool value_layout_dirty;
};
}
}
#endif
|
