Struct ScrollContainer
A helper node for displaying scrollable elements such as lists.
struct ScrollContainer
;
A ScrollContainer node meant to contain a Control child. ScrollContainers will automatically create a scrollbar child (HScrollBar, 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 Control of the Control relative to the ScrollContainer. Works great with a Panel control. You can set EXPAND 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
| Name | Type | Description |
|---|---|---|
followFocus[get, set]
|
bool | If true, the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.
|
scrollDeadzone[get, set]
|
long | |
scrollHorizontal[get, set]
|
long | The current horizontal scroll value. |
scrollHorizontalEnabled[get, set]
|
bool | If true, enables horizontal scrolling.
|
scrollVertical[get, set]
|
long | The current vertical scroll value. |
scrollVerticalEnabled[get, set]
|
bool | If true, enables vertical scrolling.
|
Methods
| Name | Description |
|---|---|
_ensureFocusedVisible
|
|
_guiInput
|
|
_scrollMoved
|
|
_updateScrollbarPosition
|
|
getDeadzone
|
|
getHScroll
|
|
getHScrollbar
|
Returns the horizontal scrollbar HScrollBar of this ScrollContainer.
|
getVScroll
|
|
getVScrollbar
|
Returns the vertical scrollbar VScrollBar of this ScrollContainer.
|
isFollowingFocus
|
|
isHScrollEnabled
|
|
isVScrollEnabled
|
|
setDeadzone
|
|
setEnableHScroll
|
|
setEnableVScroll
|
|
setFollowFocus
|
|
setHScroll
|
|
setVScroll
|