#include <Wt/WLoadingIndicator>
Public Member Functions | |
virtual | ~WLoadingIndicator () |
Destructor. | |
virtual WWidget * | widget ()=0 |
Returns the widget that visually represents the indicator. | |
virtual void | setMessage (const WString &text)=0 |
Change the message that you want to be displayed. |
The loading indicator displays a message while a response from the server is pending.
You can reimplement this interface, and set an instance using WApplication::setLoadingIndicator() if you would like to provide a custom loading indicator instead of the default implementation (WDefaultLoadingIndicator).
Wt::WLoadingIndicator::~WLoadingIndicator | ( | ) | [virtual] |
Destructor.
The destructor must be reimplemented to delete the widget().
virtual WWidget* Wt::WLoadingIndicator::widget | ( | ) | [pure virtual] |
Returns the widget that visually represents the indicator.
You should reimplement this method to return a widget that will be shown to indicate that a response is pending. You should position the widget on the screen using CSS.
The widget will be shown and hidden using WWidget::show() and WWidget::hide(). If you want to customize this behaviour, you should reimplement the WWidget::setHidden() method. Note that these are stateless slots, and thus you need to make sure that your implementation comforms to that contract, so that it may be optimized to JavaScript (the server-side implementation will only be called during stateless slot prelearning).
Implemented in Wt::WDefaultLoadingIndicator, and Wt::WOverlayLoadingIndicator.
virtual void Wt::WLoadingIndicator::setMessage | ( | const WString & | text | ) | [pure virtual] |
Change the message that you want to be displayed.
If the indicator is capable of displaying a text message, then you should reimplement this method to allow this message to be modified.
Implemented in Wt::WDefaultLoadingIndicator, and Wt::WOverlayLoadingIndicator.