Rocket::Controls::InputType Class Reference
#include <InputType.h>
Public Member Functions | |
| InputType (ElementFormControlInput *element) | |
| virtual Rocket::Core::String | GetValue () const |
| virtual bool | IsSubmitted () |
| virtual void | OnUpdate () |
| Called every update from the host element. | |
| virtual void | OnRender () |
| Called every render from the host element. | |
| virtual bool | OnAttributeChange (const Core::AttributeNameList &changed_attributes) |
| virtual void | OnPropertyChange (const Core::PropertyNameList &changed_properties) |
| virtual void | OnChildAdd () |
| Called when the element is added into a hierarchy. | |
| virtual void | OnChildRemove () |
| Called when the element is removed from a hierarchy. | |
| virtual void | ProcessEvent (Core::Event &event)=0 |
| virtual bool | GetIntrinsicDimensions (Rocket::Core::Vector2f &dimensions)=0 |
Protected Attributes | |
| ElementFormControlInput * | element |
Detailed Description
An interface for a input type handler used by ElementFormControlInput. A concrete InputType object handles the functionality of an input element.
Member Function Documentation
| Rocket::Core::String Rocket::Controls::InputType::GetValue | ( | ) | const [virtual] |
Returns a string representation of the current value of the form control.
- Returns:
- The value of the form control.
Reimplemented in Rocket::Controls::InputTypeRange.
| bool Rocket::Controls::InputType::IsSubmitted | ( | ) | [virtual] |
Returns if this value should be submitted with the form.
- Returns:
- True if the form control is to be submitted, false otherwise.
Reimplemented in Rocket::Controls::InputTypeButton, Rocket::Controls::InputTypeCheckbox, Rocket::Controls::InputTypeRadio, and Rocket::Controls::InputTypeSubmit.
| virtual bool Rocket::Controls::InputType::OnAttributeChange | ( | const Core::AttributeNameList & | changed_attributes | ) | [virtual] |
Checks for necessary functional changes in the control as a result of changed attributes.
- Parameters:
-
[in] changed_attributes The list of changed attributes.
- Returns:
- True if no layout is required, false if the layout needs to be dirtied.
Reimplemented in Rocket::Controls::InputTypeCheckbox, Rocket::Controls::InputTypeRadio, Rocket::Controls::InputTypeRange, and Rocket::Controls::InputTypeText.
| virtual void Rocket::Controls::InputType::OnPropertyChange | ( | const Core::PropertyNameList & | changed_properties | ) | [virtual] |
Called when properties on the control are changed.
- Parameters:
-
[in] changed_properties The properties changed on the element.
Reimplemented in Rocket::Controls::InputTypeText.
| virtual void Rocket::Controls::InputType::ProcessEvent | ( | Core::Event & | event | ) | [pure virtual] |
Checks for necessary functional changes in the control as a result of the event.
- Parameters:
-
[in] event The event to process.
Implemented in Rocket::Controls::InputTypeButton, Rocket::Controls::InputTypeCheckbox, Rocket::Controls::InputTypeRadio, Rocket::Controls::InputTypeRange, Rocket::Controls::InputTypeSubmit, and Rocket::Controls::InputTypeText.
| virtual bool Rocket::Controls::InputType::GetIntrinsicDimensions | ( | Rocket::Core::Vector2f & | dimensions | ) | [pure virtual] |
Sizes the dimensions to the element's inherent size.
- Returns:
- True.
Implemented in Rocket::Controls::InputTypeButton, Rocket::Controls::InputTypeCheckbox, Rocket::Controls::InputTypeRadio, Rocket::Controls::InputTypeRange, Rocket::Controls::InputTypeSubmit, and Rocket::Controls::InputTypeText.
The documentation for this class was generated from the following files:
- Source/Controls/InputType.h
- Source/Controls/InputType.cpp
