Wt 3.1.10
|
An abstract interface for a loading indicator. More...
#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 |
Sets the message that you want to be displayed. |
An abstract interface for a loading indicator.
The loading indicator displays a message while a response from the server is pending.
By providing a custom implementation of this interface, you may use a custom loading indicator using WApplication::setLoadingIndicator(),instead of the default implementation (WDefaultLoadingIndicator).
Wt::WLoadingIndicator::~WLoadingIndicator | ( | ) | [virtual] |
Destructor.
The destructor must delete the widget().
virtual void Wt::WLoadingIndicator::setMessage | ( | const WString & | text | ) | [pure virtual] |
Sets 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.
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. The widget should be positioned 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 show() and hide() 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.