#include <Wt/WFormWidget>
Public Member Functions | |
WFormWidget (WContainerWidget *parent=0) | |
Creates a WFormWidget with an optional parent. | |
~WFormWidget () | |
Destructor. | |
WLabel * | label () const |
Returns the label associated with this widget. | |
virtual void | setHidden (bool hidden) |
Sets the hidden state of this widget. | |
void | setValidator (WValidator *validator) |
Sets a validator for this field. | |
WValidator * | validator () const |
Returns the validator. | |
virtual WValidator::State | validate () |
Validates the field. | |
void | setEnabled (bool enabled) |
Sets whether the widget is enabled. | |
void | setFocus () |
Gives focus. | |
void | setFocus (bool focus) |
Changes focus. | |
virtual void | setTabIndex (int index) |
Sets the tab index. | |
virtual int | tabIndex () const |
Returns the tab index. | |
void | setReadOnly (bool readOnly) |
Sets the element read-only. | |
bool | isReadOnly () const |
Returns whether the form element is read-only. | |
void | setEmptyText (const WString &emptyText) |
Sets the empty text to be shown when the field is empty. | |
const WString & | emptyText () |
Returns the empty text to be shown when the field is empty. | |
EventSignal & | changed () |
Signal emitted when the value was changed. | |
EventSignal & | selected () |
Signal emitted when ?? | |
EventSignal & | blurred () |
Signal emitted when the widget lost focus. | |
EventSignal & | focussed () |
Signal emitted when the widget recieved focus. | |
Protected Member Functions | |
virtual void | enableAjax () |
Progresses to an Ajax-enabled widget. | |
virtual void | propagateSetEnabled (bool enabled) |
Propagates that a widget was enabled or disabled through children. |
A WFormWidget may receive focus, can be disabled, and can have a label that acts as proxy for getting focus. It provides signals which reflect changes to its value, or changes to its focus.
Form widgets also have built-in support for validation, using setValidator(WValidator *). If the validator provide client-side validation, then an invalid validation state is reflected using the style class "Wt-invalid"
. All validators provided by Wt implement client-side validation.
On the server-side, use validate() method to validate the content using a validator previously set.
Wt::WFormWidget::~WFormWidget | ( | ) |
Destructor.
If a label was associated with the widget, its buddy is reset to 0
.
WLabel* Wt::WFormWidget::label | ( | ) | const [inline] |
Returns the label associated with this widget.
Returns the label (if there is one) that acts as a proxy for this widget.
void Wt::WFormWidget::setHidden | ( | bool | hidden | ) | [virtual] |
Sets the hidden state of this widget.
If the widget has a label, it is hidden and shown together with this widget.
Reimplemented from Wt::WWebWidget.
void Wt::WFormWidget::setValidator | ( | WValidator * | validator | ) |
Sets a validator for this field.
The validator is used to validate the current input.
If the validator has no parent yet, then ownership is transferred to the form field, and thus the validator will be deleted together with the form field.
The default value is 0
.
void Wt::WFormWidget::setEnabled | ( | bool | enabled | ) |
Sets whether the widget is enabled.
A widget that is disabled cannot receive focus or user interaction.
This is the opposite of setDisabled().
void Wt::WFormWidget::setFocus | ( | ) |
Gives focus.
Giving focus to an input element only works when JavaScript is enabled.
void Wt::WFormWidget::setFocus | ( | bool | focus | ) |
Changes focus.
When using focus
= false
, you can undo a previous setFocus() call.
void Wt::WFormWidget::setTabIndex | ( | int | index | ) | [virtual] |
Sets the tab index.
For widgets that receive focus, focus is passed on to the next widget in the tabbing chain based on their tab index. When the user navigates through form widgets using the keyboard, widgets receive focus starting from the element with the lowest tab index to elements with the highest tab index.
A tab index only applies to widgets than can receive focus (which are WFormWidget, WAnchor, WPushButton), but setting a tab index on any other type of widget will propagate to its contained form widgets.
Widgets with a same tab index will receive focus in the same order as they are inserted in the widget tree.
The default tab index is 0.
Reimplemented from Wt::WWebWidget.
int Wt::WFormWidget::tabIndex | ( | ) | const [virtual] |
void Wt::WFormWidget::setReadOnly | ( | bool | readOnly | ) |
Sets the element read-only.
A read-only form element cannot be edited, but the contents can still be selected.
By default, a form element area is not read-only.
bool Wt::WFormWidget::isReadOnly | ( | ) | const |
void Wt::WFormWidget::setEmptyText | ( | const WString & | emptyText | ) |
const WString& Wt::WFormWidget::emptyText | ( | ) | [inline] |
void Wt::WFormWidget::enableAjax | ( | ) | [protected, virtual] |
Progresses to an Ajax-enabled widget.
This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.
You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.
Reimplemented from Wt::WWebWidget.
void Wt::WFormWidget::propagateSetEnabled | ( | bool | enabled | ) | [protected, virtual] |
Propagates that a widget was enabled or disabled through children.
When enabling or disabling a widget, you usually also want to disable contained children. This method is called by setDisabled() to propagate its state to all children.
You may want to reimplement this method if they wish to render differently when a widget is disabled. The default implementation will propagate the signal to all children.
Reimplemented from Wt::WWebWidget.