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
|
/*
* 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 ROCKETCONTROLSELEMENTFORMCONTROLTEXTAREA_H
#define ROCKETCONTROLSELEMENTFORMCONTROLTEXTAREA_H
#include "Header.h"
#include "ElementFormControl.h"
namespace Rocket {
namespace Controls {
class WidgetTextInput;
/**
Default Rocket implemention of a text area.
@author Peter Curry
*/
class ROCKETCONTROLS_API ElementFormControlTextArea : public ElementFormControl
{
public:
/// Constructs a new ElementFormControlTextArea. This should not be called directly; use the
/// Factory instead.
/// @param[in] tag The tag the element was declared as in RML.
ElementFormControlTextArea(const Rocket::Core::String& tag);
virtual ~ElementFormControlTextArea();
/// Returns a string representation of the current value of the form control. This is the value of the control
/// regardless of whether it has been selected / checked (as appropriate for the control).
/// @return The value of the form control.
virtual Rocket::Core::String GetValue() const;
/// Sets the current value of the form control.
/// @param[in] value The new value of the form control.
virtual void SetValue(const Rocket::Core::String& value);
/// Sets the number of characters visible across the text area. Note that this will only be precise when using
/// a fixed-width font.
/// @param[in] size The number of visible characters.
void SetNumColumns(int num_columns);
/// Returns the approximate number of characters visible at once.
/// @return The number of visible characters.
int GetNumColumns() const;
/// Sets the number of visible lines of text in the text area.
/// @param[in] num_rows The new number of visible lines of text.
void SetNumRows(int num_rows);
/// Returns the number of visible lines of text in the text area.
/// @return The number of visible lines of text.
int GetNumRows() const;
/// Sets the maximum length (in characters) of this text area.
/// @param[in] max_length The new maximum length of the text area. A number lower than zero will mean infinite
/// characters.
void SetMaxLength(int max_length);
/// Returns the maximum length (in characters) of this text area.
/// @return The maximum number of characters allowed in this text area.
int GetMaxLength() const;
/// Enables or disables word-wrapping in the text area.
/// @param[in] word_wrap True to enable word-wrapping, false to disable.
void SetWordWrap(bool word_wrap);
/// Returns the state of word-wrapping in the text area.
/// @return True if the text area is word-wrapping, false otherwise.
bool GetWordWrap();
/// Returns the control's inherent size, based on the length of the input field and the current font size.
/// @return True.
virtual bool GetIntrinsicDimensions(Rocket::Core::Vector2f& dimensions);
protected:
/// Updates the control's widget.
void OnUpdate();
/// Renders the control's widget.
void OnRender();
/// Formats the element.
void OnLayout();
/// Called when attributes on the element are changed.
virtual void OnAttributeChange(const Core::AttributeNameList& changed_attributes);
/// Called when properties on the control are changed.
/// @param[in] changed_properties The properties changed on the element.
virtual void OnPropertyChange(const Core::PropertyNameList& changed_properties);
/// Returns the text content of the element.
/// @param[out] content The content of the element.
virtual void GetInnerRML(Rocket::Core::String& content) const;
private:
WidgetTextInput* widget;
};
}
}
#endif
|
