class `GUIDockSlider`

Inherits: GUIClickable

GUI element used by the dock manager to display a slider between two different dock containers.

The slider can be vertical or horizontal and will process and report mouse drag events.

Public

static const String &GetGuiTypeName()

Returns type name of the GUI element used for finding GUI element styles.

static GUIDockSlider *Create(bool horizontal, const String &styleName = StringUtility::kBlank)

Creates a new GUI dock slider element.

horizontal: Should the slider be rendered horizontal or vertical.
styleName: Optional style to use for the element. Style will be retrieved from GUISkin of the GUIWidget the element is used on. If not specified default style is used.

static GUIDockSlider *Create(bool horizontal, const GUIOptions &options, const String &styleName = StringUtility::kBlank)

Creates a new GUI dock slider element.

horizontal: Should the slider be rendered horizontal or vertical.
options: Options that allow you to control how is the element positioned and sized. This will override any similar options set by style.
styleName: Optional style to use for the element. Style will be retrieved from GUISkin of the GUIWidget the element is used on. If not specified default style is used.

Event<void (const GUIPhysicalPoint &)> OnDragged

Triggered while the user is dragging the slider (pointer down and being moved)

bool DoOnMouseEvent(const GUIMouseEvent &ev) override

Called when a mouse event is received on any GUI element the mouse is interacting with.

Return true if you have processed the event and don't want other elements to process it.

bool HasCustomCursor(const GUIPhysicalPoint &position, CursorType &type) const override

Checks if the GUI element has a custom cursor and outputs the cursor type if it does.

GUIDockSlider(bool horizontal, const String &styleName, const GUISizeConstraints &dimensions)

GUIPhysicalPoint mLastDragPosition

bool mHorizontal

bool mDragInProgress