ScrollContainer

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 (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.rectMinSize 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).

@GodotBaseClass

struct ScrollContainer {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(ScrollContainer other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static ScrollContainer _new();

void _ensureFocusedVisible(Control arg0);

void _guiInput(InputEvent arg0);

void _scrollMoved(double arg0);

void _updateScrollbarPosition();

long getDeadzone();

long getHScroll();

HScrollBar getHScrollbar();

long getVScroll();

VScrollBar getVScrollbar();

bool isFollowingFocus();

bool isHScrollEnabled();

bool isVScrollEnabled();

void setDeadzone(long deadzone);

void setEnableHScroll(bool enable);

void setEnableVScroll(bool enable);

void setFollowFocus(bool enabled);

void setHScroll(long value);

void setVScroll(long value);

bool followFocus [@property getter];

bool followFocus [@property setter];

long scrollDeadzone [@property getter];

long scrollDeadzone [@property setter];

long scrollHorizontal [@property getter];

long scrollHorizontal [@property setter];

bool scrollHorizontalEnabled [@property getter];

bool scrollHorizontalEnabled [@property setter];

long scrollVertical [@property getter];

long scrollVertical [@property setter];

bool scrollVerticalEnabled [@property getter];

bool scrollVerticalEnabled [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

_ensureFocusedVisible void _ensureFocusedVisible(Control arg0)
_guiInput void _guiInput(InputEvent arg0)
_scrollMoved void _scrollMoved(double arg0)
_updateScrollbarPosition void _updateScrollbarPosition()
getDeadzone long getDeadzone()
getHScroll long getHScroll()
getHScrollbar HScrollBar getHScrollbar(): Returns the horizontal scrollbar HScrollBar of this ScrollContainer.
getVScroll long getVScroll()
getVScrollbar VScrollBar getVScrollbar(): Returns the vertical scrollbar VScrollBar of this ScrollContainer.
isFollowingFocus bool isFollowingFocus()
isHScrollEnabled bool isHScrollEnabled()
isVScrollEnabled bool isVScrollEnabled()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(ScrollContainer other)
opEquals bool opEquals(typeof(null) n)
setDeadzone void setDeadzone(long deadzone)
setEnableHScroll void setEnableHScroll(bool enable)
setEnableVScroll void setEnableVScroll(bool enable)
setFollowFocus void setFollowFocus(bool enabled)
setHScroll void setHScroll(long value)
setVScroll void setVScroll(long value)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

followFocus bool followFocus [@property getter]
bool followFocus [@property setter]: If true, the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.
scrollDeadzone long scrollDeadzone [@property getter]
long scrollDeadzone [@property setter]
scrollHorizontal long scrollHorizontal [@property getter]
long scrollHorizontal [@property setter]: The current horizontal scroll value.
scrollHorizontalEnabled bool scrollHorizontalEnabled [@property getter]
bool scrollHorizontalEnabled [@property setter]: If true, enables horizontal scrolling.
scrollVertical long scrollVertical [@property getter]
long scrollVertical [@property setter]: The current vertical scroll value.
scrollVerticalEnabled bool scrollVerticalEnabled [@property getter]
bool scrollVerticalEnabled [@property setter]: If true, enables vertical scrolling.

Static functions

_new ScrollContainer _new(): Construct a new instance of ScrollContainer. Note: use memnew!ScrollContainer instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot scrollcontainer modules

all

structs

ScrollContainer