Rocket::Controls::ElementFormControlInput Class Reference
#include <ElementFormControlInput.h>
Public Member Functions | |
| ElementFormControlInput (const Rocket::Core::String &tag) | |
| virtual Rocket::Core::String | GetValue () const |
| virtual void | SetValue (const Rocket::Core::String &value) |
| virtual bool | IsSubmitted () |
Protected Member Functions | |
| virtual void | OnUpdate () |
| Updates the element's underlying type. | |
| virtual void | OnRender () |
| Renders the element's underlying type. | |
| virtual void | OnAttributeChange (const Core::AttributeNameList &changed_attributes) |
| virtual void | OnPropertyChange (const Core::PropertyNameList &changed_properties) |
| virtual void | OnChildAdd (Rocket::Core::Element *child) |
| virtual void | OnChildRemove (Rocket::Core::Element *child) |
| virtual void | ProcessEvent (Core::Event &event) |
| virtual bool | GetIntrinsicDimensions (Rocket::Core::Vector2f &dimensions) |
Detailed Description
A form control for the generic input element. All functionality is handled through an input type interface.
Constructor & Destructor Documentation
| Rocket::Controls::ElementFormControlInput::ElementFormControlInput | ( | const Rocket::Core::String & | tag | ) |
Constructs a new ElementFormControlInput. This should not be called directly; use the Factory instead.
- Parameters:
-
[in] tag The tag the element was declared as in RML.
Member Function Documentation
| Rocket::Core::String Rocket::Controls::ElementFormControlInput::GetValue | ( | ) | const [virtual] |
Returns a string representation of the current value of the form control.
- Returns:
- The value of the form control.
Implements Rocket::Controls::ElementFormControl.
| void Rocket::Controls::ElementFormControlInput::SetValue | ( | const Rocket::Core::String & | value | ) | [virtual] |
Sets the current value of the form control.
- Parameters:
-
value[in] The new value of the form control.
Implements Rocket::Controls::ElementFormControl.
| bool Rocket::Controls::ElementFormControlInput::IsSubmitted | ( | ) | [virtual] |
Returns if this value's type should be submitted with the form.
- Returns:
- True if the form control is to be submitted, false otherwise.
Reimplemented from Rocket::Controls::ElementFormControl.
| void Rocket::Controls::ElementFormControlInput::OnAttributeChange | ( | const Core::AttributeNameList & | changed_attributes | ) | [protected, virtual] |
Checks for necessary functional changes in the control as a result of changed attributes.
- Parameters:
-
[in] changed_attributes The list of changed attributes.
Reimplemented from Rocket::Controls::ElementFormControl.
| void Rocket::Controls::ElementFormControlInput::OnPropertyChange | ( | const Core::PropertyNameList & | changed_properties | ) | [protected, virtual] |
Called when properties on the control are changed.
- Parameters:
-
[in] changed_properties The properties changed on the element.
Reimplemented from Rocket::Core::Element.
| void Rocket::Controls::ElementFormControlInput::OnChildAdd | ( | Rocket::Core::Element * | child | ) | [protected, virtual] |
If we are the added element, this will pass the call onto our type handler.
- Parameters:
-
[in] child The new member of the hierarchy.
Reimplemented from Rocket::Core::Element.
| void Rocket::Controls::ElementFormControlInput::OnChildRemove | ( | Rocket::Core::Element * | child | ) | [protected, virtual] |
If we are the removed element, this will pass the call onto our type handler.
- Parameters:
-
[in] child The member of the hierarchy that was just removed.
Reimplemented from Rocket::Core::Element.
| void Rocket::Controls::ElementFormControlInput::ProcessEvent | ( | Core::Event & | event | ) | [protected, virtual] |
Checks for necessary functional changes in the control as a result of the event.
- Parameters:
-
[in] event The event to process.
Reimplemented from Rocket::Core::Element.
| bool Rocket::Controls::ElementFormControlInput::GetIntrinsicDimensions | ( | Rocket::Core::Vector2f & | dimensions | ) | [protected, virtual] |
Sizes the dimensions to the element's inherent size.
- Returns:
- True.
Reimplemented from Rocket::Core::Element.
The documentation for this class was generated from the following files:
- Include/Rocket/Controls/ElementFormControlInput.h
- Source/Controls/ElementFormControlInput.cpp
