Inheritance #

Table of contents

ScrollBar #

Node, core, not_builtin_classes

Abstract base class for scrollbars.

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.

Members #

var custom_step: float = -1.0#

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

var step: float = 0.0#

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

signal scrolling()#

Emitted when the scrollbar is being scrolled.

Theme Items #

self["theme_override_icons/decrement"] = icon as Texture2D#

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

self["theme_override_icons/decrement_highlight"] = icon as Texture2D#

Displayed when the mouse cursor hovers over the decrement button.

self["theme_override_icons/decrement_pressed"] = icon as Texture2D#

Displayed when the decrement button is being pressed.

self["theme_override_icons/increment"] = icon as Texture2D#

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

self["theme_override_icons/increment_highlight"] = icon as Texture2D#

Displayed when the mouse cursor hovers over the increment button.

self["theme_override_icons/increment_pressed"] = icon as Texture2D#

Displayed when the increment button is being pressed.

self["theme_override_styles/grabber"] = style as StyleBox#

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

self["theme_override_styles/grabber_highlight"] = style as StyleBox#

Used when the mouse hovers over the grabber.

self["theme_override_styles/grabber_pressed"] = style as StyleBox#

Used when the grabber is being dragged.

self["theme_override_styles/scroll"] = style as StyleBox#

Used as background of this ScrollBar.

self["theme_override_styles/scroll_focus"] = style as StyleBox#

Used as background when the ScrollBar has the GUI focus.

Tutorials #