Rocket::Controls::WidgetTextInputSingleLine Class Reference
#include <WidgetTextInputSingleLine.h>
Inheritance diagram for Rocket::Controls::WidgetTextInputSingleLine:
Collaboration diagram for Rocket::Controls::WidgetTextInputSingleLine:
Public Member Functions | |
| WidgetTextInputSingleLine (ElementFormControl *parent) | |
| virtual void | SetValue (const Core::String &value) |
Protected Member Functions | |
| virtual bool | IsCharacterValid (Rocket::Core::word character) |
| virtual void | LineBreak () |
| Called when the user pressed enter. | |
| void | SanitiseValue (Core::String &value) |
| Strips all and characters from the string. | |
Detailed Description
A specialisation of the text input widget for single-line input fields.
Member Function Documentation
| void Rocket::Controls::WidgetTextInputSingleLine::SetValue | ( | const Core::String & | value | ) | [virtual] |
Sets the value of the text field. The value will be stripped of end-lines.
- Parameters:
-
value[in] The new value to set on the text field.
Reimplemented from Rocket::Controls::WidgetTextInput.
Reimplemented in Rocket::Controls::WidgetTextInputSingleLinePassword.
| bool Rocket::Controls::WidgetTextInputSingleLine::IsCharacterValid | ( | Rocket::Core::word | character | ) | [protected, virtual] |
Returns true if the given character is permitted in the input field, false if not.
- Parameters:
-
[in] character The character to validate.
- Returns:
- True if the character is allowed, false if not.
Implements Rocket::Controls::WidgetTextInput.
The documentation for this class was generated from the following files:
- Source/Controls/WidgetTextInputSingleLine.h
- Source/Controls/WidgetTextInputSingleLine.cpp
