Table of Contents

Class ScrollBar

Abstract base class for scrollbars.

Inheritance
ScrollBar
Derived

Remarks

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

custom_step

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

var custom_step : float = -1.0

Property Value

float

Remarks

  • void set_custom_step(float value)
  • float get_custom_step

decrement

Theme Property

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

Texture2D decrement

Property Value

Texture2D

decrement_highlight

Theme Property

Displayed when the mouse cursor hovers over the decrement button.

Texture2D decrement_highlight

Property Value

Texture2D

decrement_pressed

Theme Property

Displayed when the decrement button is being pressed.

Texture2D decrement_pressed

Property Value

Texture2D

increment

Theme Property

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

Texture2D increment

Property Value

Texture2D

increment_highlight

Theme Property

Displayed when the mouse cursor hovers over the increment button.

Texture2D increment_highlight

Property Value

Texture2D

increment_pressed

Theme Property

Displayed when the increment button is being pressed.

Texture2D increment_pressed

Property Value

Texture2D

grabber

Theme Property

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

StyleBox grabber

Property Value

StyleBox

grabber_highlight

Theme Property

Used when the mouse hovers over the grabber.

StyleBox grabber_highlight

Property Value

StyleBox

grabber_pressed

Theme Property

Used when the grabber is being dragged.

StyleBox grabber_pressed

Property Value

StyleBox

scroll

Theme Property

Used as background of this ScrollBar.

StyleBox scroll

Property Value

StyleBox

scroll_focus

Theme Property

Used as background when the ScrollBar has the GUI focus.

StyleBox scroll_focus

Property Value

StyleBox

Events

scrolling

Emitted when the scrollbar is being scrolled.

signal scrolling