ScrollContainer

public ScrollContainer();

Creates an area with Auto on both axes, ClipContents = true and FollowFocus = false. Put the list in one child Container and let parent layout supply its visible size.

public bool DrawFocusBorder { get; set; }

Draws an outline for eligible own/descendant focus; false by default. Does not call GrabFocus or create keyboard routing. Can affect internal styled margins.

public bool FollowFocus { get; set; }

Automatic reveal when focus changes to a descendant, false by default. Does not define Tab/arrow order. Enabling it does not immediately reveal an already focused item.

public ScrollContainer.ScrollMode HorizontalScrollMode { get; set; }

Horizontal-axis mode, Auto by default. Disabled affects content minimum while ShowNever only hides the bar. Changing it requests layout rather than changing child-list orientation.

public int ScrollDeadzone { get; set; }

Accumulated touch-drag movement threshold in logical pixels before scrolling starts. Initialized from gui/common/default_scroll_deadzone. Neither a setter minimum offset nor a wheel step.

public ScrollContainer.ScrollHintModeEnum ScrollHintMode { get; set; }

Which edges show decorative scroll hints; Disabled by default. Requires suitable theme textures/colors. Does not enable/disable scrolling itself.

public int ScrollHorizontal { get; set; }

Integer horizontal offset in logical pixels. Normal range is bounded by scrollbar MaxValue − Page. Setter cancels dragging; layout repositions content. Getter truncates a fractional scrollbar Value.

public bool ScrollHorizontalByDefault { get; set; }

Prefers the horizontal wheel axis, false by default; Shift changes the choice. Does not replace HorizontalScrollMode or reorient content.

public float ScrollHorizontalCustomStep { get; set; }

Internal horizontal scrollbar step. Negative values, default -1, use normal Step; nonnegative values set a custom step. Not a universal wheel, pan or touch-drag speed.

public int ScrollVertical { get; set; }

Integer vertical offset; normal upper bound is scrollbar MaxValue − Page. Neither content height nor item index. Setter cancels dragging and an immediate descendant rectangle can still be stale.

public float ScrollVerticalCustomStep { get; set; }

Internal vertical scrollbar step; default -1 uses its Step. 0 sets a zero custom step rather than disabling all scrolling methods. Container wheel input follows separate logic.

public bool TileScrollHint { get; set; }

Tiles hint textures instead of stretching them, false by default. Affects hint appearance rather than scroll step/range.

public ScrollContainer.ScrollMode VerticalScrollMode { get; set; }

Vertical-axis mode, Auto by default. ShowNever keeps scrolling without a bar; Reserve keeps its space. Disabled/MaximizeFirst can make content height contribute to the container minimum.

public void EnsureControlVisible(Control control);

Scrolls toward a descendant using its current rectangle. Call after layout; sizes immediately after AddChild can be stale. Neither assigns focus nor enlarges the visible area for an oversized target.

public int GetDeadzone();

Accumulated touch-drag movement threshold in logical pixels before scrolling starts. Initialized from gui/common/default_scroll_deadzone. Neither a setter minimum offset nor a wheel step.

public bool GetDrawFocusBorder();

Draws an outline for eligible own/descendant focus; false by default. Does not call GrabFocus or create keyboard routing. Can affect internal styled margins.

public int GetHScroll();

Integer horizontal offset in logical pixels. Normal range is bounded by scrollbar MaxValue − Page. Setter cancels dragging; layout repositions content. Getter truncates a fractional scrollbar Value.

public HScrollBar GetHScrollBar();

Returns the internal HScrollBar owned by ScrollContainer. Exposes ValueChanged and Range bounds. Do not free it separately; the container recalculates MaxValue/Page.

public float GetHorizontalCustomStep();

Internal horizontal scrollbar step. Negative values, default -1, use normal Step; nonnegative values set a custom step. Not a universal wheel, pan or touch-drag speed.

public ScrollContainer.ScrollMode GetHorizontalScrollMode();

Horizontal-axis mode, Auto by default. Disabled affects content minimum while ShowNever only hides the bar. Changing it requests layout rather than changing child-list orientation.

public ScrollContainer.ScrollHintModeEnum GetScrollHintMode();

Which edges show decorative scroll hints; Disabled by default. Requires suitable theme textures/colors. Does not enable/disable scrolling itself.

public int GetVScroll();

Integer vertical offset; normal upper bound is scrollbar MaxValue − Page. Neither content height nor item index. Setter cancels dragging and an immediate descendant rectangle can still be stale.

public VScrollBar GetVScrollBar();

Returns the internal VScrollBar rather than a new independent resource. ValueChanged observes offset changes from different sources. Retain the reference only while the parent remains alive.

public float GetVerticalCustomStep();

Internal vertical scrollbar step; default -1 uses its Step. 0 sets a zero custom step rather than disabling all scrolling methods. Container wheel input follows separate logic.

public ScrollContainer.ScrollMode GetVerticalScrollMode();

Vertical-axis mode, Auto by default. ShowNever keeps scrolling without a bar; Reserve keeps its space. Disabled/MaximizeFirst can make content height contribute to the container minimum.

public bool IsFollowingFocus();

Automatic reveal when focus changes to a descendant, false by default. Does not define Tab/arrow order. Enabling it does not immediately reveal an already focused item.

public bool IsScrollHintTiled();

Tiles hint textures instead of stretching them, false by default. Affects hint appearance rather than scroll step/range.

public bool IsScrollHorizontalByDefault();

Prefers the horizontal wheel axis, false by default; Shift changes the choice. Does not replace HorizontalScrollMode or reorient content.

public void SetDeadzone(int deadzone);

Accumulated touch-drag movement threshold in logical pixels before scrolling starts. Initialized from gui/common/default_scroll_deadzone. Neither a setter minimum offset nor a wheel step.

public void SetDrawFocusBorder(bool draw);

Draws an outline for eligible own/descendant focus; false by default. Does not call GrabFocus or create keyboard routing. Can affect internal styled margins.

public void SetFollowFocus(bool enabled);

Automatic reveal when focus changes to a descendant, false by default. Does not define Tab/arrow order. Enabling it does not immediately reveal an already focused item.

public void SetHScroll(int value);

Integer horizontal offset in logical pixels. Normal range is bounded by scrollbar MaxValue − Page. Setter cancels dragging; layout repositions content. Getter truncates a fractional scrollbar Value.

public void SetHorizontalCustomStep(float value);

Internal horizontal scrollbar step. Negative values, default -1, use normal Step; nonnegative values set a custom step. Not a universal wheel, pan or touch-drag speed.

public void SetHorizontalScrollMode(ScrollContainer.ScrollMode enable);

Horizontal-axis mode, Auto by default. Disabled affects content minimum while ShowNever only hides the bar. Changing it requests layout rather than changing child-list orientation.

public void SetScrollHintMode(ScrollContainer.ScrollHintModeEnum scrollHintMode);

Which edges show decorative scroll hints; Disabled by default. Requires suitable theme textures/colors. Does not enable/disable scrolling itself.

public void SetScrollHorizontalByDefault(bool enable);

Prefers the horizontal wheel axis, false by default; Shift changes the choice. Does not replace HorizontalScrollMode or reorient content.

public void SetTileScrollHint(bool tileScrollHint);

Tiles hint textures instead of stretching them, false by default. Affects hint appearance rather than scroll step/range.

public void SetVScroll(int value);

Integer vertical offset; normal upper bound is scrollbar MaxValue − Page. Neither content height nor item index. Setter cancels dragging and an immediate descendant rectangle can still be stale.

public void SetVerticalCustomStep(float value);

Internal vertical scrollbar step; default -1 uses its Step. 0 sets a zero custom step rather than disabling all scrolling methods. Container wheel input follows separate logic.

public void SetVerticalScrollMode(ScrollContainer.ScrollMode enable);

Vertical-axis mode, Auto by default. ShowNever keeps scrolling without a bar; Reserve keeps its space. Disabled/MaximizeFirst can make content height contribute to the container minimum.

public event Action ScrollEnded;

Signal when a drag that crossed the deadzone ends or is canceled. Setting an offset can cancel active dragging. Not completion of every programmatic move.

public event Action ScrollStarted;

Signal when drag scrolling crosses the deadzone. Not guaranteed for wheel input or SetVScroll/SetHScroll; use scrollbar ValueChanged to observe values.