Unigine::WidgetSlider Class

Interface for widget slider handling. See also UnigineScript analog.

To use this class, include the UnigineWidgetSlider.h file.

Unigine::WidgetSlider Class

Members

---

static int type ()

WidgetSlider type.

Return value

WidgetSlider type identifier.

static Ptr< WidgetSlider > create (const WidgetPtr & widget)

WidgetSlider constructor.

Arguments

• const WidgetPtr & widget - Widget smart pointer.

static Ptr< WidgetSlider > create (const Ptr< Gui > & gui, int min, int max, int value)

WidgetSlider constructor.

Arguments

• const Ptr< Gui > & gui - Gui pointer.
• int min - Minimum slider value.
• int max - Maximum slider value.
• int value - Initial value.

virtual void setOrientation (int orientation) const =0

Sets orientation of the slider: horizontal (by default) or vertical one.

Arguments

• int orientation - 1 to set horizontal orientation; 0 to set vertical one.

virtual int getOrientation () const =0

Returns the current orientation of the slider: horizontal or vertical one.

Return value

1 if the orientation is vertical; 0 if it is horizontal.

virtual void setButtonWidth (int width) const =0

Sets the width of the slider handle in pixels (for a horizontal slider).

Arguments

• int width - Width of the handle in pixels.

virtual int getButtonWidth () const =0

Returns the width of the slider handle in pixels (for a horizontal slider).

Return value

Width of the handle in pixels.

virtual void setButtonHeight (int height) const =0

Sets the height of the slider handle in pixels (for a vertical slider).

Arguments

• int height - Height of the handle in pixels.

virtual int getButtonHeight () const =0

Returns the height of the slider handle in pixels (for a vertical slider).

Return value

Height of the handle in pixels.

virtual void setMinValue (int value) const =0

Sets the minimum value for the slider.

Arguments

• int value - Minimum value.

virtual int getMinValue () const =0

Returns the minimum value of the slider.

Return value

Minimum value.

virtual void setMaxValue (int value) const =0

Sets the maximum value for the slider.

Arguments

• int value - Maximum value.

virtual int getMaxValue () const =0

Returns the maximum value of the slider.

Return value

Maximum value.

virtual void setMinExpand (int value) const =0

Sets the minimum value, up to which the lower limit of the range of the slider values can be expanded.

Arguments

• int value - Minimum value, up to which the slider's lower limit can be dropped.

virtual int getMinExpand () const =0

Returns the minimum value, up to which the lower limit of the range of the slider values can be expanded. The lower limit of the slider can be expanded only if the slider is attached to an editline with the Unigine::Gui::ATTACH_MIN_EXPAND flag.

Return value

Minimum value, up to which the slider's lower limit can be dropped.

virtual void setMaxExpand (int value) const =0

Sets the maximum value, up to which the upper limit of the range of the slider values can be expanded.

Arguments

• int value - Maximum value, up to which the slider's upper limit can be raised.

virtual int getMaxExpand () const =0

Returns the current maximum value, up to which the upper limit of the range of the slider values can be expanded. The upper limit of the slider can be expanded only if the slider is attached to an editline with the Unigine::Gui::ATTACH_MAX_EXPAND flag.

Return value

Maximum value, up to which the slider's upper limit can be raised.

virtual void setValue (int value) const =0

Sets a new current value for the slider, i.e. its position.

Arguments

• int value - Slider value.

virtual int getValue () const =0

Returns the current value of the slider, i.e. its position.

Return value

Current slider value.