A progress bar. More...
Public Member Functions | |
WProgressBar (WContainerWidget *parent=0) | |
Creates a progress bar. | |
void | setMinimum (double minimum) |
Sets the minimum value. More... | |
double | minimum () const |
Returns the minimum value. More... | |
void | setMaximum (double maximum) |
Sets the maximum value. More... | |
double | maximum () const |
Returns the maximum value. More... | |
void | setRange (double minimum, double maximum) |
Sets the range. More... | |
void | setValue (double value) |
Sets the current progress. More... | |
double | value () const |
Returns the current progress. | |
void | setFormat (const WString &format) |
Sets the progress format string. More... | |
const WString & | format () const |
Returns the progress format string. More... | |
virtual WString | text () const |
Returns the text displayed inside the progress bar. More... | |
Signal< double > & | valueChanged () |
A signal that indicates when the value has changed. More... | |
Signal & | progressCompleted () |
A signal that indicates when 100% is reached. More... | |
virtual void | resize (const WLength &width, const WLength &height) |
Resizes the widget. More... | |
![]() | |
WInteractWidget (WContainerWidget *parent=0) | |
Create an InteractWidget with optional parent. | |
EventSignal< WKeyEvent > & | keyWentDown () |
Event signal emitted when a keyboard key is pushed down. More... | |
EventSignal< WKeyEvent > & | keyPressed () |
Event signal emitted when a "character" was entered. More... | |
EventSignal< WKeyEvent > & | keyWentUp () |
Event signal emitted when a keyboard key is released. More... | |
EventSignal & | enterPressed () |
Event signal emitted when enter was pressed. More... | |
EventSignal & | escapePressed () |
Event signal emitted when escape was pressed. More... | |
EventSignal< WMouseEvent > & | clicked () |
Event signal emitted when a mouse key was clicked on this widget. More... | |
EventSignal< WMouseEvent > & | doubleClicked () |
Event signal emitted when a mouse key was double clicked on this widget. More... | |
EventSignal< WMouseEvent > & | mouseWentDown () |
Event signal emitted when a mouse key was pushed down on this widget. More... | |
EventSignal< WMouseEvent > & | mouseWentUp () |
Event signal emitted when a mouse key was released on this widget. More... | |
EventSignal< WMouseEvent > & | mouseWentOut () |
Event signal emitted when the mouse went out of this widget. More... | |
EventSignal< WMouseEvent > & | mouseWentOver () |
Event signal emitted when the mouse entered this widget. More... | |
EventSignal< WMouseEvent > & | mouseMoved () |
Event signal emitted when the mouse moved over this widget. More... | |
EventSignal< WMouseEvent > & | mouseDragged () |
Event signal emitted when the mouse is dragged over this widget. More... | |
EventSignal< WMouseEvent > & | mouseWheel () |
Event signal emitted when the mouse scroll wheel was used. More... | |
EventSignal< WTouchEvent > & | touchStarted () |
Event signal emitted when a finger is placed on the screen. More... | |
EventSignal< WTouchEvent > & | touchEnded () |
Event signal emitted when a finger is removed from the screen. More... | |
EventSignal< WTouchEvent > & | touchMoved () |
Event signal emitted when a finger, which is already placed on the screen, is moved across the screen. More... | |
EventSignal< WGestureEvent > & | gestureStarted () |
Event signal emitted when a gesture is started. More... | |
EventSignal< WGestureEvent > & | gestureChanged () |
Event signal emitted when a gesture is changed. More... | |
EventSignal< WGestureEvent > & | gestureEnded () |
Event signal emitted when a gesture is ended. More... | |
void | setDraggable (const std::string &mimeType, WWidget *dragWidget=0, bool isDragWidgetOnly=false, WObject *sourceWidget=0) |
Configure dragging for drag and drop. More... | |
void | setMouseOverDelay (int delay) |
Sets a delay for the mouse over event. More... | |
int | mouseOverDelay () const |
Returns the mouse over signal delay. More... | |
virtual void | load () |
Loads content just before the widget is used. More... | |
virtual bool | isEnabled () const |
Returns whether the widget is enabled. More... | |
![]() | |
WWebWidget (WContainerWidget *parent=0) | |
Construct a WebWidget with a given parent. More... | |
virtual void | setPositionScheme (PositionScheme scheme) |
Sets the CSS position scheme. More... | |
virtual PositionScheme | positionScheme () const |
Returns the CSS position scheme. More... | |
virtual void | setOffsets (const WLength &offset, WFlags< Side > sides=All) |
Sets CSS offsets for a non-statically positioned widget. More... | |
virtual WLength | offset (Side s) const |
Returns a CSS offset. More... | |
virtual WLength | width () const |
Returns the width. More... | |
virtual WLength | height () const |
Returns the height. More... | |
virtual void | setMinimumSize (const WLength &width, const WLength &height) |
Sets a minimum size. More... | |
virtual WLength | minimumWidth () const |
Returns the minimum width. More... | |
virtual WLength | minimumHeight () const |
Returns the minimum height. More... | |
virtual void | setMaximumSize (const WLength &width, const WLength &height) |
Sets a maximum size. More... | |
virtual WLength | maximumWidth () const |
Returns the maximum width. More... | |
virtual WLength | maximumHeight () const |
Returns the maximum height. More... | |
virtual void | setLineHeight (const WLength &height) |
Sets the CSS line height for contained text. | |
virtual WLength | lineHeight () const |
Returns the CSS line height for contained text. More... | |
virtual void | setFloatSide (Side s) |
Specifies a CSS float side. More... | |
virtual Side | floatSide () const |
Returns the CSS float side. More... | |
virtual void | setClearSides (WFlags< Side > sides) |
Sets the sides that should be cleared of floats. More... | |
virtual WFlags< Side > | clearSides () const |
Returns the sides that should remain empty. More... | |
virtual void | setMargin (const WLength &margin, WFlags< Side > sides=All) |
Sets CSS margins around the widget. More... | |
virtual WLength | margin (Side side) const |
Returns a CSS margin set. More... | |
virtual void | setHiddenKeepsGeometry (bool enabled) |
Sets whether the widget keeps its geometry when hidden. More... | |
virtual bool | hiddenKeepsGeometry () const |
Returns whether the widget keeps its geometry when hidden. More... | |
virtual void | setHidden (bool hidden, const WAnimation &animation=WAnimation()) |
Hides or shows the widget. More... | |
virtual bool | isHidden () const |
Returns whether the widget is set hidden. More... | |
virtual bool | isVisible () const |
Returns whether the widget is visible. More... | |
virtual void | setDisabled (bool disabled) |
Sets whether the widget is disabled. More... | |
virtual bool | isDisabled () const |
Returns whether the widget is set disabled. More... | |
virtual void | setPopup (bool popup) |
Lets the widget overlay over other sibling widgets. More... | |
virtual bool | isPopup () const |
Returns whether the widget is overlayed. More... | |
virtual void | setInline (bool isInline) |
Sets whether the widget is displayed inline or as a block. More... | |
virtual bool | isInline () const |
Returns whether the widget is displayed inline or as block. More... | |
virtual void | setDecorationStyle (const WCssDecorationStyle &style) |
Sets a CSS decoration style. More... | |
virtual WCssDecorationStyle & | decorationStyle () |
Returns the decoration style of this widget. More... | |
virtual void | setStyleClass (const WString &styleClass) |
Sets (one or more) CSS style classes. More... | |
virtual WString | styleClass () const |
Returns the CSS style class. More... | |
virtual void | addStyleClass (const WString &styleClass, bool force=false) |
Adds a CSS style class. More... | |
virtual void | removeStyleClass (const WString &styleClass, bool force=false) |
Removes a CSS style class. More... | |
virtual bool | hasStyleClass (const WString &styleClass) const |
Returns whether the widget has a style class. | |
virtual void | setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength()) |
Sets the vertical alignment. More... | |
virtual AlignmentFlag | verticalAlignment () const |
Returns the vertical alignment. More... | |
virtual WLength | verticalAlignmentLength () const |
Returns the fixed vertical alignment that was set. More... | |
virtual void | setToolTip (const WString &text, TextFormat textFormat=PlainText) |
Sets a tooltip. More... | |
virtual const WString & | toolTip () const |
Returns the tooltip. | |
virtual void | refresh () |
Refresh the widget. More... | |
virtual void | setAttributeValue (const std::string &name, const WString &value) |
Sets an attribute value. More... | |
virtual WString | attributeValue (const std::string &name) const |
Returns an attribute value. More... | |
virtual void | setJavaScriptMember (const std::string &name, const std::string &value) |
Sets a JavaScript member. More... | |
virtual std::string | javaScriptMember (const std::string &name) const |
Returns the value of a JavaScript member. More... | |
virtual void | callJavaScriptMember (const std::string &name, const std::string &args) |
Calls a JavaScript member. More... | |
virtual bool | loaded () const |
Returns whether this widget has been loaded. More... | |
virtual void | setTabIndex (int index) |
Sets the tab index. More... | |
virtual int | tabIndex () const |
Returns the tab index. More... | |
virtual void | setId (const std::string &id) |
Sets the CSS Id. More... | |
virtual WWidget * | find (const std::string &name) |
Finds a descendent widget by name. More... | |
virtual void | setSelectable (bool selectable) |
Sets as selectable. More... | |
virtual void | doJavaScript (const std::string &javascript) |
Executes the given JavaScript statements when the widget is rendered or updated. More... | |
virtual const std::string | id () const |
Returns the (unique) identifier for this object. More... | |
void | setLoadLaterWhenInvisible (bool) |
Change the way the widget is loaded when invisible. More... | |
const std::vector< WWidget * > & | children () const |
Returns contained widgets. More... | |
Signal & | childrenChanged () |
Signal emitted when children have been added or removed. More... | |
![]() | |
virtual | ~WWidget () |
Destructor. More... | |
WWidget * | parent () const |
Returns the parent widget. More... | |
void | setWidth (const WLength &width) |
Sets the width. More... | |
void | setHeight (const WLength &height) |
Sets the height. More... | |
virtual void | positionAt (const WWidget *widget, Orientation orientation=Vertical) |
Positions a widget next to another widget. More... | |
virtual void | toggleStyleClass (const WString &styleClass, bool add, bool force=false) |
Toggles a CSS style class. | |
std::string | jsRef () const |
Returns a JavaScript expression to the corresponding DOM node. More... | |
virtual void | acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString()) |
Sets a mime type to be accepted for dropping. More... | |
virtual void | stopAcceptDrops (const std::string &mimeType) |
Indicates that a mime type is no longer accepted for dropping. More... | |
virtual void | htmlText (std::ostream &out) |
Streams the (X)HTML representation. More... | |
bool | isRendered () const |
Returns whether the widget is rendered. More... | |
void | hide () |
Hides the widget. More... | |
void | animateHide (const WAnimation &animation) |
Hides the widget using an animation. More... | |
void | show () |
Shows the widget. More... | |
void | animateShow (const WAnimation &animation) |
Shows the widget using an animation. More... | |
void | enable () |
Enables the widget. More... | |
void | disable () |
Disable thes widget. More... | |
bool | layoutSizeAware () const |
Returns whether the widget is layout size aware. More... | |
![]() | |
WObject (WObject *parent=0) | |
Create a WObject with a given parent object. More... | |
virtual | ~WObject () |
Destructor. More... | |
void | setObjectName (const std::string &name) |
Sets an object name. More... | |
virtual std::string | objectName () const |
Returns the object name. More... | |
void | resetLearnedSlots () |
Resets learned stateless slot implementations. More... | |
template<class T > | |
void | resetLearnedSlot (void(T::*method)()) |
Resets a learned stateless slot implementation. More... | |
template<class T > | |
WStatelessSlot * | implementStateless (void(T::*method)()) |
Declares a slot to be stateless and learn client-side behaviour on first invocation. More... | |
template<class T > | |
WStatelessSlot * | implementStateless (void(T::*method)(), void(T::*undoMethod)()) |
Declares a slot to be stateless and learn client-side behaviour in advance. More... | |
template<class T > | |
WStatelessSlot * | implementJavaScript (void(T::*method)(), const std::string &jsCode) |
Provides a JavaScript implementation for a method. More... | |
void | addChild (WObject *child) |
Adds a child object. More... | |
const std::vector< WObject * > & | children () const |
Returns the children. | |
WObject * | parent () const |
Returns the parent object. | |
Additional Inherited Members | |
![]() | |
typedef void(WObject::* | Method )() |
Typedef for a WObject method without arguments. | |
![]() | |
static WString | escapeText (const WString &text, bool newlinesToo=false) |
Escape HTML control characters in the text, to display literally (deprecated). More... | |
static std::string & | escapeText (std::string &text, bool newlinestoo=false) |
Escape HTML control characters in the text, to display literally (deprecated). More... | |
static bool | removeScript (WString &text) |
Remove tags/attributes from text that are not passive (deprecated). More... | |
static std::string | jsStringLiteral (const std::string &v, char delimiter= '\'') |
Turn a UTF8 encoded string into a JavaScript string literal. More... | |
![]() | |
virtual void | propagateSetEnabled (bool enabled) |
Propagates that a widget was enabled or disabled through children. More... | |
![]() | |
static WObject * | sender () |
Returns the sender of the current slot call. More... | |
A progress bar.
The progress bar can be used to indicate the progress of a certain operation. The text displayed in the progress bar can be customized by specializing text().
To use the progress bar, you need to give it a range (minimum and maximum value), and update the progress using setValue().
WProgressBar is an inline widget.
const WString& Wt::WProgressBar::format | ( | ) | const |
Returns the progress format string.
double Wt::WProgressBar::maximum | ( | ) | const |
Returns the maximum value.
double Wt::WProgressBar::minimum | ( | ) | const |
Returns the minimum value.
Signal& Wt::WProgressBar::progressCompleted | ( | ) |
A signal that indicates when 100% is reached.
This signal is emitted when setValue(maximum()) is called.
Resizes the widget.
Specifies a fixed size for this widget, setting CSS width
and height
properties. By default a widget has automatic width and height, which sets a size for the widget following CSS rules.
When the widget is not managed by a layout manager, the automatic (natural) size of a widget depends on whether they widget is a block or inline widget:
When inserted in a layout manager, the size set will be used as a widget's preferred size, but the widget may be given a different size by the layout manager based on available space and stretch factors. The actual size given by a layout manager may be retrieved by making the widget "layout size aware", using setLayoutSizeAware(). If you have defined a "wtResize()"
JavaScript method for the widget, then this method will also be called.
The default width and height of a widget is WLength::Auto.
Reimplemented from Wt::WWebWidget.
void Wt::WProgressBar::setFormat | ( | const WString & | format) |
Sets the progress format string.
The format is used by text() to indicate the progress value.
The default value is "%.0f %%"
void Wt::WProgressBar::setMaximum | ( | double | maximum) |
Sets the maximum value.
The maximum value is the value that corresponds to 100%.
The default value is 100.
void Wt::WProgressBar::setMinimum | ( | double | minimum) |
Sets the minimum value.
The minimum value is the value that corresponds to 0%.
The default value is 0.
void Wt::WProgressBar::setRange | ( | double | minimum, |
double | maximum | ||
) |
Sets the range.
void Wt::WProgressBar::setValue | ( | double | value) |
|
virtual |
Signal<double>& Wt::WProgressBar::valueChanged | ( | ) |
A signal that indicates when the value has changed.
This signal is emitted when setValue() is called.