Class reference

ScrollBar

Inherits Range

Abstract base class for scrollbars.

Description

Abstract base class for scrollbars, typically used to navigate through content that extends beyond the visible area of a control. Scrollbars are Range-based controls.

Properties

`float custom_step = -1.0`

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

`int focus_mode = 3`

`float step = 0.0`

Signals

`scrolling()`

Emitted when the scrollbar is being scrolled.

Theme properties

`Texture2D decrement`

Icon used as a button to scroll the ScrollBar left/up. Supports custom step using the ScrollBar.custom_step property.

`Texture2D decrement_highlight`

Displayed when the mouse cursor hovers over the decrement button.

`Texture2D decrement_pressed`

Displayed when the decrement button is being pressed.

`Texture2D increment`

Icon used as a button to scroll the ScrollBar right/down. Supports custom step using the ScrollBar.custom_step property.

`Texture2D increment_highlight`

Displayed when the mouse cursor hovers over the increment button.

`Texture2D increment_pressed`

Displayed when the increment button is being pressed.

`StyleBox grabber`

Used as texture for the grabber, the draggable element representing current scroll.

`StyleBox grabber_highlight`

Used when the mouse hovers over the grabber.

`StyleBox grabber_pressed`

Used when the grabber is being dragged.

`StyleBox scroll`

Used as background of this ScrollBar.

`StyleBox scroll_focus`

Used as background when the ScrollBar has the GUI focus.

Source revision 4f5b14abade2