Wt  3.7.1
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Wt::WSlider Class Reference

A horizontal or vertical slider control. More...

#include <Wt/WSlider>

Inheritance diagram for Wt::WSlider:
Inheritance graph
[legend]

Public Types

enum  TickPosition { TicksAbove = 0x1, TicksBelow = 0x2, TicksLeft = 0x1, TicksRight = 0x2 }
 Enumeration that specifies the location of ticks. More...
 
- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 

Public Member Functions

 WSlider (WContainerWidget *parent=0)
 Creates a default horizontal slider. More...
 
 WSlider (Orientation orientation, WContainerWidget *parent=0)
 Creates a default slider of the given orientation. More...
 
 ~WSlider ()
 Destructor.
 
void setNativeControl (bool nativeControl)
 Configures whether a native HTML5 control should be used. More...
 
bool nativeControl () const
 Returns whether a native HTML5 control is used. More...
 
void setOrientation (Wt::Orientation orientation)
 Sets the slider orientation. More...
 
Orientation orientation () const
 Returns the slider orientation. More...
 
void setTickInterval (int tickInterval)
 Sets the tick interval. More...
 
int tickInterval () const
 Returns the tick interval. More...
 
void setTickPosition (WFlags< TickPosition > tickPosition)
 Sets the tick position. More...
 
WFlags< TickPositiontickPosition () const
 Returns the tick position. More...
 
virtual void setValue (int value)
 Sets the slider value. More...
 
int value () const
 Returns the current slider value. More...
 
void setMaximum (int maximum)
 Sets the maximum value. More...
 
int maximum () const
 Returns the maximum value. More...
 
void setMinimum (int minimum)
 Sets the minimum value. More...
 
int minimum () const
 Returns the minimum value. More...
 
void setRange (int minimum, int maximum)
 Sets the value range. More...
 
Signal< int > & valueChanged ()
 Signal emitted when the user has changed the value of the slider. More...
 
JSignal< int > & sliderMoved ()
 Signal emitted while the user drags the slider. More...
 
void setHandleWidth (int width)
 Sets the slider handle width. More...
 
int handleWidth () const
 Returns the handle width. More...
 
virtual void setDisabled (bool disabled)
 Sets whether the widget is disabled. More...
 
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget. More...
 
virtual WString valueText () const
 Returns the current value. More...
 
virtual void setValueText (const WString &value)
 Sets the value text. More...
 
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget. More...
 
- Public Member Functions inherited from Wt::WFormWidget
 WFormWidget (WContainerWidget *parent=0)
 Creates a WFormWidget with an optional parent.
 
 ~WFormWidget ()
 Destructor. More...
 
WLabellabel () const
 Returns the label associated with this widget. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Sets the hidden state of this widget. More...
 
void setValidator (WValidator *validator)
 Sets a validator for this field. More...
 
virtual WValidatorvalidator () const
 Returns the validator.
 
virtual WValidator::State validate ()
 Validates the field. More...
 
void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
virtual void setReadOnly (bool readOnly)
 Sets the element read-only. More...
 
bool isReadOnly () const
 Returns whether the form element is read-only. More...
 
void setEmptyText (const WString &emptyText)
 Sets the placeholder text (deprecated). More...
 
const WStringemptyText () const
 Returns the placeholder text (deprecated). More...
 
virtual void setPlaceholderText (const WString &placeholder)
 Sets the placeholder text. More...
 
const WStringplaceholderText () const
 Returns the placeholder text. More...
 
EventSignalchanged ()
 Signal emitted when the value was changed. More...
 
EventSignalselected ()
 Signal emitted when ??
 
Signal< WValidator::Result > & validated ()
 Signal emitted when the widget is being validated. More...
 
virtual void refresh ()
 Refresh the widget. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=PlainText)
 Sets a tooltip. More...
 
virtual bool canReceiveFocus () const
 Returns whether the widget can receive focus. More...
 
virtual int tabIndex () const
 Returns the tab index. More...
 
- Public Member Functions inherited from Wt::WInteractWidget
 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...
 
EventSignalenterPressed ()
 Event signal emitted when enter was pressed. More...
 
EventSignalescapePressed ()
 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 unsetDraggable ()
 Disable drag & drop for this widget. 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 setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
- Public Member Functions inherited from Wt::WWebWidget
 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< SideclearSides () 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 bool isHidden () const
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const
 Returns whether the widget is visible. More...
 
virtual bool isDisabled () const
 Returns whether the widget is set disabled. 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 WCssDecorationStyledecorationStyle ()
 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 setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
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 setId (const std::string &id)
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name)
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &id)
 Finds a descendent widget by id.
 
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...
 
std::string htmlTagName () const
 returns the current html tag name More...
 
void setHtmlTagName (const std::string &tag)
 set the custom HTML tag name More...
 
const std::vector< WWidget * > & children () const
 Returns contained widgets. More...
 
SignalchildrenChanged ()
 Signal emitted when children have been added or removed. More...
 
virtual void setCanReceiveFocus (bool enabled)
 Sets whether the widget can receive focus. More...
 
virtual bool setFirstFocus ()
 Set focus on the widget's first descendant. More...
 
virtual void setFocus (bool focus)
 Sets focus. More...
 
virtual bool hasFocus () const
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index)
 Sets the tab index. More...
 
EventSignalblurred ()
 Signal emitted when the widget lost focus. More...
 
EventSignalfocussed ()
 Signal emitted when the widget recieved focus. More...
 
virtual bool scrollVisibilityEnabled () const WT_CXX11ONLY(final override)
 Returns whether scroll visibility detection is enabled for this widget. More...
 
virtual void setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(final override)
 Sets whether scroll visibility detection is enabled for this widget. More...
 
virtual int scrollVisibilityMargin () const WT_CXX11ONLY(final override)
 Returns the margin around the viewport within which the widget is considered visible. More...
 
virtual void setScrollVisibilityMargin (int margin) WT_CXX11ONLY(final override)
 Sets the margin around the viewport within which the widget is considered visible. More...
 
virtual Signal< bool > & scrollVisibilityChanged () WT_CXX11ONLY(final override)
 Signal triggered when the scroll visibility of this widget changes. More...
 
virtual bool isScrollVisible () const WT_CXX11ONLY(final override)
 Returns whether this widget is currently considered scroll visible. More...
 
virtual void setThemeStyleEnabled (bool enabled)
 Sets whether theme styling for a widget is enabled or disabled. More...
 
virtual bool isThemeStyleEnabled () const
 Returns whether this widget is currently styled by the chosen theme. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. 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...
 
void setFocus ()
 Sets focus. 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 setObjectName (const std::string &name)
 Sets an object name. 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...
 
- Public Member Functions inherited from Wt::WObject
 WObject (WObject *parent=0)
 Create a WObject with a given parent object. More...
 
virtual ~WObject ()
 Destructor. 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...
 
void isNotStateless ()
 Marks the current function as not stateless. 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.
 
WObjectparent () const
 Returns the parent object.
 

Static Public Attributes

static const Wt::WFlags< TickPositionNoTicks = 0
 Do not render ticks.
 
static const Wt::WFlags< TickPositionTicksBothSides = TicksAbove | TicksBelow
 Render ticks on both sides.
 

Protected Member Functions

virtual void paintTick (WPainter &painter, int value, int x, int y)
 Paints a slider ticks (for a non-native widget) More...
 
virtual WInteractWidgetcreateHandle ()
 Creates the handle (for a non-native widget) More...
 
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change. More...
 
virtual void render (WFlags< RenderFlag > flags)
 Renders the widget. More...
 
- Protected Member Functions inherited from Wt::WFormWidget
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
- Protected Member Functions inherited from Wt::WWebWidget
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. More...
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 Sets the widget to be aware of its size set by a layout manager. More...
 
 WWidget (WContainerWidget *parent=0)
 Creates a widget. More...
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. More...
 
virtual int boxPadding (Orientation orientation) const
 Returns the widget's built-in padding. More...
 
virtual int boxBorder (Orientation orientation) const
 Returns the widget's built-in border width. More...
 
void scheduleRender (WFlags< RepaintFlag > flags=0)
 Schedules rerendering of the widget. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Wt::WWebWidget
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...
 
- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 Short hand for WString::tr() More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

A horizontal or vertical slider control.

A slider allows the user to specify an integer value within a particular range using a visual slider.

The slider must be sized explicitly using resize() or by a layout manager. The default size is 150 x 50 pixels for a horizontal slider, and 50 x 150 pixels for a vertical slider.

Usage example:

scaleSlider->setMinimum(0);
scaleSlider->setMaximum(20);
scaleSlider->setValue(10);
scaleSlider->setTickInterval(5);
scaleSlider->resize(300, 50);
scaleSlider->valueChanged().connect(this, &ThisClass::scaleShape);
WSlider-1.png
Horizontal slider with ticks on both sides.

CSS

The non-native slider (HTML4, see setNativeControl()) is styled by the current CSS theme.

Member Enumeration Documentation

◆ TickPosition

Enumeration that specifies the location of ticks.

Enumerator
TicksAbove 

Render ticks above (horizontal slider)

TicksBelow 

Render ticks below (horizontal slider)

TicksLeft 

Render ticks on the left side (vertical slider)

TicksRight 

Render ticks on the right side (vertical slider)

Constructor & Destructor Documentation

◆ WSlider() [1/2]

Wt::WSlider::WSlider ( WContainerWidget parent = 0)

Creates a default horizontal slider.

The slider shows no ticks, has a range from 0 to 99, and has tickInterval of 0 (defaulting to three ticks over the whole range).

The initial value is 0.

◆ WSlider() [2/2]

Wt::WSlider::WSlider ( Orientation  orientation,
WContainerWidget parent = 0 
)

Creates a default slider of the given orientation.

The slider shows no ticks, has a range from 0 to 99, and has tickInterval of 0 (defaulting to three ticks over the whole range).

The initial value is 0.

Member Function Documentation

◆ createHandle()

WInteractWidget * Wt::WSlider::createHandle ( )
protectedvirtual

Creates the handle (for a non-native widget)

The default implementation creates a container widget. You may want to specialize this function if you want to have more control on the handle appearance or if you want to associate with the handle a tooltip or other information (e.g. a popup balloon).

◆ enableAjax()

void Wt::WSlider::enableAjax ( )
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.

See also
WApplication::enableAjax()

Reimplemented from Wt::WFormWidget.

◆ handleWidth()

int Wt::WSlider::handleWidth ( ) const

Returns the handle width.

See also
setHandleWidth()

◆ layoutSizeChanged()

void Wt::WSlider::layoutSizeChanged ( int  width,
int  height 
)
protectedvirtual

Virtual method that indicates a size change.

This method propagates the client-side width and height of the widget when the widget is contained by a layout manager and setLayoutSizeAware(true) was called.

See also
setLayoutSizeAware()

Reimplemented from Wt::WWidget.

◆ maximum()

int Wt::WSlider::maximum ( ) const

Returns the maximum value.

See also
setMaximum(int)

◆ minimum()

int Wt::WSlider::minimum ( ) const

Returns the minimum value.

See also
setMinimum(int)

◆ nativeControl()

bool Wt::WSlider::nativeControl ( ) const

Returns whether a native HTML5 control is used.

Taking into account the preference for a native control, configured using setNativeControl(), this method returns whether a native control is actually being used.

◆ orientation()

Orientation Wt::WSlider::orientation ( ) const

Returns the slider orientation.

See also
setOrientation()

◆ paintTick()

void Wt::WSlider::paintTick ( WPainter painter,
int  value,
int  x,
int  y 
)
protectedvirtual

Paints a slider ticks (for a non-native widget)

The default implementation draws ticks taking into account the the tickPosition.

The mid point for the tick should be at position (x, y). The value that corresponds to the tick is also passed.

◆ render()

void Wt::WSlider::render ( WFlags< RenderFlag flags)
protectedvirtual

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Reimplemented from Wt::WFormWidget.

◆ resize()

void Wt::WSlider::resize ( const WLength width,
const WLength height 
)
virtual

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:

  • a block widget takes by default the width of the parent, and the height that it needs based on its contents
  • an inline widget takes the width and height that it needs based on its contents (possibly wrapping over multiple lines). The width and height of an inline widget cannot be changed (by the letter of CSS, although most browsers will react to it in varying ways).

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.

See also
width(), height()

Reimplemented from Wt::WWebWidget.

◆ setDisabled()

void Wt::WSlider::setDisabled ( bool  disabled)
virtual

Sets whether the widget is disabled.

Enables or disables the widget (including all its descendant widgets). setDisabled(false) will enable this widget and all descendant widgets that are not disabled. A widget is only enabled if it and all its ancestors in the widget tree are disabled.

Typically, a disabled form widget will not allow changing the value, and disabled widgets will not react to mouse click events.

Note
enable() and disable() are considered to be stateless slots by default. If you override setDisabled() and need to modify server state whenever it is called, you'll need to call WObject::isNotStateless().
See also
disable(), enable()

Reimplemented from Wt::WWebWidget.

◆ setHandleWidth()

void Wt::WSlider::setHandleWidth ( int  width)

Sets the slider handle width.

This sets the width for the handle, which is needed to accurately position the handle.

The default value is 20 pixels.

◆ setMaximum()

void Wt::WSlider::setMaximum ( int  maximum)

Sets the maximum value.

The maximum value defines the upper limit of the valid range. The lower limit and current value are automatically adjusted to remain valid.

See also
maximum(), setMinimum(), setRange()

◆ setMinimum()

void Wt::WSlider::setMinimum ( int  minimum)

Sets the minimum value.

The minimum value defines the lower limit of the valid range. The upper limit and current value are automatically adjusted to remain valid.

See also
minimum(), setMaximum(), setRange()

◆ setNativeControl()

void Wt::WSlider::setNativeControl ( bool  nativeControl)

Configures whether a native HTML5 control should be used.

When native, the new "range" input element, specified by HTML5 and when implemented by the browser, is used rather than the built-in element. A native control is styled by the browser (usually in sync with the OS) rather than through the theme chosen. Settings like tick interval and tick position are ignored.

Note
Vertically oriented sliders are in theory supported by the HTML5 input element, but in practice are usually not rendered correctly by the browser.

◆ setOrientation()

void Wt::WSlider::setOrientation ( Wt::Orientation  orientation)

Sets the slider orientation.

See also
orientation()

◆ setRange()

void Wt::WSlider::setRange ( int  minimum,
int  maximum 
)

Sets the value range.

See also
setMinimum(), setMaximum()

◆ setTickInterval()

void Wt::WSlider::setTickInterval ( int  tickInterval)

Sets the tick interval.

The tick interval specifies the interval for placing ticks along the slider. The interval is specified in value units (not pixel units). A value of 0 specifies an automatic tick interval, which defaults to 3 ticks spanning the whole range.

See also
tickInterval(), setTickPosition()

◆ setTickPosition()

void Wt::WSlider::setTickPosition ( WFlags< TickPosition tickPosition)

Sets the tick position.

The tick position indicates if and where ticks are placed around the slider groove.

See also
tickPosition(), setTickInterval()

◆ setValue()

void Wt::WSlider::setValue ( int  value)
virtual

Sets the slider value.

The value is automatically trimmed to the valid range (minimum() to maximum()).

See also
value()

◆ setValueText()

void Wt::WSlider::setValueText ( const WString value)
virtual

Sets the value text.

This sets the current value from a string value.

Implements Wt::WFormWidget.

◆ sliderMoved()

JSignal<int>& Wt::WSlider::sliderMoved ( )

Signal emitted while the user drags the slider.

The current dragged position is passed as the argument. Note that the slider value is not changed while dragging the slider, but only after the slider has been released.

See also
valueChanged()

◆ tickInterval()

int Wt::WSlider::tickInterval ( ) const

Returns the tick interval.

See also
setTickInterval()

◆ tickPosition()

WFlags<TickPosition> Wt::WSlider::tickPosition ( ) const

Returns the tick position.

See also
setTickPosition(), setTickInterval()

◆ value()

int Wt::WSlider::value ( ) const

Returns the current slider value.

See also
setValue()

◆ valueChanged()

Signal<int>& Wt::WSlider::valueChanged ( )

Signal emitted when the user has changed the value of the slider.

The new value is passed as the argument.

See also
sliderMoved()

◆ valueText()

WString Wt::WSlider::valueText ( ) const
virtual

Returns the current value.

This returns the current value as a string.

Implements Wt::WFormWidget.


Generated on Tue Dec 15 2020 for the C++ Web Toolkit (Wt) by doxygen 1.8.13