Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.24 KB

class_scrollbar.rst

File metadata and controls

59 lines (39 loc) · 2.24 KB
github_url:hide

ScrollBar

Inherits: :ref:`Range<class_Range>` < :ref:`Control<class_Control>` < :ref:`CanvasItem<class_CanvasItem>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`

Inherited By: :ref:`HScrollBar<class_HScrollBar>`, :ref:`VScrollBar<class_VScrollBar>`

Base class for scroll bars.

Description

Scrollbars are a :ref:`Range<class_Range>`-based :ref:`Control<class_Control>`, that display a draggable area (the size of the page). Horizontal (:ref:`HScrollBar<class_HScrollBar>`) and Vertical (:ref:`VScrollBar<class_VScrollBar>`) versions are available.

Properties

:ref:`float<class_float>` :ref:`custom_step<class_ScrollBar_property_custom_step>` -1.0
:ref:`int<class_int>` size_flags_vertical O: 0
:ref:`float<class_float>` step O: 0.0

Signals

  • scrolling ( )

Emitted when the scrollbar is being scrolled.

Property Descriptions

Default -1.0
Setter set_custom_step(value)
Getter get_custom_step()

Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the ScrollBar is focused.