ScrollContainer
Inherited By:
A helper node for displaying scrollable elements such as lists.
A ScrollContainer node meant to contain a Control child. ScrollContainers will automatically create a scrollbar child (, VScrollBar, or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the of the Control relative to the ScrollContainer. Works great with a Panel control. You can set on the children’s size flags, so they will upscale to the ScrollContainer’s size if it’s larger (scroll is invisible for the chosen dimension).
Properties
get_h_scrollbar ( ) | |
get_v_scrollbar ( ) |
Theme Properties
bg |
- scroll_ended ( )
- scroll_started ( )
Emitted when scrolling is started.
Property Descriptions
- bool follow_focus
If true
, the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.
- scroll_deadzone
Default | 0 |
Setter | set_deadzone(value) |
Getter | get_deadzone() |
Default | 0 |
Setter | set_h_scroll(value) |
Getter | get_h_scroll() |
The current horizontal scroll value.
- bool scroll_horizontal_enabled
- scroll_vertical
Default | 0 |
Setter | set_v_scroll(value) |
Getter | get_v_scroll() |
The current vertical scroll value.
- bool scroll_vertical_enabled
Default | true |
Setter | set_enable_v_scroll(value) |
Getter | is_v_scroll_enabled() |
If true
, enables vertical scrolling.
- get_h_scrollbar ( )
Returns the horizontal scrollbar HScrollBar of this ScrollContainer
.
- get_v_scrollbar ( )