ItemList

public ItemList();

Creates an empty list: Single, no selection, AllowReselect/AllowRmbSelect off, AllowSearch on.

public bool AllowReselect { get; set; }

Allows repeated user single-selection notification, default false. Does not make direct Select emit ItemSelected.

public bool AllowRmbSelect { get; set; }

Allows right-button selection, default false. Does not create a context menu or restrict programmatic Select.

public bool AllowSearch { get; set; }

Allows incremental typed search in the focused list, default true. Does not filter the model or add a search field.

public bool AutoHeight { get; set; }

Use content height as minimum height, default false. Not automatic scrolling to the last item; depends on columns and is calculated during layout refresh.

public bool AutoWidth { get; set; }

Use content width as Control minimum width, default false. After recalculation can expand the parent container and bypass ordinary width-fitting of columns. Leave false for a bounded list.

public int FixedColumnWidth { get; set; }

Configured column/text width in local pixels, default 0 uses content width. Requires ≥ 0. For text wrapping use positive width with IconMode.Top and MaxTextLines; theme item spacing contributes separately.

public Vector2I FixedIconSize { get; set; }

Fixed icon slot; default Vector2I.Zero uses source-region size. Applies when both components are positive; slot is multiplied by IconScale and drawing fits preserving aspect. Does not modify the resource.

public ItemList.IconModeEnum IconMode { get; set; }

Main icon Left by default or Top. Top permits a wrapped label under bounded width; does not change original text or icon pixels.

public float IconScale { get; set; }

Icon drawing/layout size multiplier, default 1. Must be finite; use a positive value for normal display. Also scales FixedIconSize without modifying Texture2D.

public int ItemCount { get; set; }

Record count, default 0. Setter requires ≥ 0: new records are empty, selectable and unselected; shrinking discards the tail without selection signals. Reset/restore selection explicitly after structural changes.

public int MaxColumns { get; set; }

Column-count upper bound, default 1. 0 means no configured cap rather than zero columns. Wrapping can reduce actual count to fit available width. Requires ≥ 0.

public int MaxTextLines { get; set; }

Maximum label lines, default 1; requires ≥ 1. Wrapping applies in IconMode.Top and requires bounded width, such as FixedColumnWidth. Increasing it in Left does not enable multiline layout.

public bool SameColumnWidth { get; set; }

Equalizes widths using the widest item, default false. Does not fix column count or itself constrain text width.

public ItemList.ScrollHintModeEnum ScrollHintMode { get; set; }

Decorative vertical-scroll hint: default Disabled, Both/Top/Bottom. Uses the theme scroll_hint and current range; does not enable scrolling or replace ScrollBar.

public ItemList.SelectModeEnum SelectMode { get; set; }

Selection mode, default Single, Multi or Toggle. Toggle switches selection by clicking without Ctrl. Setter does not normalize existing selected flags; for Multi/Toggle → Single call DeselectAll first and restore the desired record.

public TextServer.OverrunBehavior TextOverrunBehavior { get; set; }

Text trimming/ellipsis under bounded width, default TrimEllipsis. Does not itself set width or enable wrapping; coordinate with FixedColumnWidth, MaxTextLines and IconMode.

public bool TileScrollHint { get; set; }

Tile the scroll_hint texture instead of stretching, default false. Relevant when ScrollHintMode is enabled and more content exists above/below.

public bool WraparoundItems { get; set; }

Wrap items into following rows to fit width, default true. This is layout rather than cyclic keyboard selection. false allows horizontal overflow; MaxColumns still limits row length.

public int AddIconItem(Texture2D icon, bool selectable = true);

Adds a record with a shared icon and empty text, returning its index. selectable controls selection eligibility; adding does not select it.

public int AddItem(string text, Texture2D icon = null, bool selectable = true);

Appends text, an optional shared icon and selectable flag; returns the new index. Does not automatically change selection or emit ItemSelected.

public void CenterOnCurrent(bool centerVerically = true, bool centerHorizontally = true);

Centers the internal current item on requested axes through ScrollBar.Value. Refresh layout first; at least one flag must be true. Does nothing without a valid current; range bounds limit centering near edges.

public void Clear();

Removes all records and resets selection/internal current index. Does not emit ItemSelected/MultiSelected; explicitly refresh dependent panels.

public void Deselect(int idx);

Clears the specified record’s selected flag without selection signals. In Single also resets the internal current index, so pass the actual selected record; use DeselectAll for a full reset.

public void DeselectAll();

Clears all selected flags and resets internal current index without ItemSelected/MultiSelected. Useful before mode changes or restoring selection after rebuilding.

public void EnsureCurrentIsVisible();

Requests deferred reveal of the internal current item during drawing rather than every selected Multi/Toggle record. Does not change selection. Establish size/records and a current item with single Select first; restore selection after structural changes.

public void ForceUpdateListSize();

Recalculates list geometry, scroll ranges and auto minimums immediately when layout is dirty. Call after populating/resizing before GetItemRect/geometry queries. Not a forced full redraw or reset of every cache.

public bool GetAllowReselect();

Allows repeated user single-selection notification, default false. Does not make direct Select emit ItemSelected.

public bool GetAllowRmbSelect();

Allows right-button selection, default false. Does not create a context menu or restrict programmatic Select.

public bool GetAllowSearch();

Allows incremental typed search in the focused list, default true. Does not filter the model or add a search field.

public int GetFixedColumnWidth();

Configured column/text width in local pixels, default 0 uses content width. Requires ≥ 0. For text wrapping use positive width with IconMode.Top and MaxTextLines; theme item spacing contributes separately.

public Vector2I GetFixedIconSize();

Fixed icon slot; default Vector2I.Zero uses source-region size. Applies when both components are positive; slot is multiplied by IconScale and drawing fits preserving aspect. Does not modify the resource.

public HScrollBar GetHScrollBar();

Shared internal HScrollBar. Do not free/remove it; horizontal overflow is associated with WraparoundItems = false. RTL direction/range can differ from LTR.

public ItemList.IconModeEnum GetIconMode();

Main icon Left by default or Top. Top permits a wrapped label under bounded width; does not change original text or icon pixels.

public float GetIconScale();

Icon drawing/layout size multiplier, default 1. Must be finite; use a positive value for normal display. Also scales FixedIconSize without modifying Texture2D.

public int GetItemAtPosition(Vector2 position, bool exact = false);

Queries an ItemList-local position, accounting for margins, scrolling and RTL. exact = true requires a hit; false can return the nearest record outside it. The last column can have an extended hit area. Disabled/nonselectable records can match; check flags separately.

public Entity.AutoTranslateModeEnum GetItemAutoTranslateMode(int idx);

Stored per-record translation mode.

public int GetItemCount();

Record count, default 0. Setter requires ≥ 0: new records are empty, selectable and unselected; shrinking discards the tail without selection signals. Reset/restore selection explicitly after structural changes.

public Color GetItemCustomBgColor(int idx);

Stored custom background color/alpha.

public Color GetItemCustomFgColor(int idx);

Stored text color; (0, 0, 0, 1) means use the theme rather than necessarily draw black.

public Texture2D GetItemIcon(int idx);

Shared icon Texture2D, or null; source dimensions need not equal the drawing slot.

public Color GetItemIconModulate(int idx);

Stored icon color/alpha multiplier.

public Rect2 GetItemIconRegion(int idx);

Stored source Rect2 rather than final screen area.

public string GetItemLanguage(int idx);

Stored shaping language, or empty for the control locale.

public Variant GetItemMetadata(int idx);

Returns metadata Variant, Nil when unassigned. Use an expected ID type and an ordinary valid index; nested containers can remain shared.

public Rect2 GetItemRect(int idx, bool expand = true);

Cached item rectangle in content coordinates with panel margins, without subtracting scroll or applying screen transforms. In RTL also do not treat it as a ready screen rectangle. expand can extend the last column. Call ForceUpdateListSize after changes before reading.

public string GetItemText(int idx);

Returns the original string rather than translated display.

public Control.TextDirection GetItemTextDirection(int idx);

Stored text direction, default Inherited.

public string GetItemTooltip(int idx);

Returns the assigned tooltip string even when display is disabled.

public int GetMaxColumns();

Column-count upper bound, default 1. 0 means no configured cap rather than zero columns. Wrapping can reduce actual count to fit available width. Requires ≥ 0.

public int GetMaxTextLines();

Maximum label lines, default 1; requires ≥ 1. Wrapping applies in IconMode.Top and requires bounded width, such as FixedColumnWidth. Increasing it in Left does not enable multiline layout.

public ItemList.ScrollHintModeEnum GetScrollHintMode();

Decorative vertical-scroll hint: default Disabled, Both/Top/Bottom. Uses the theme scroll_hint and current range; does not enable scrolling or replace ScrollBar.

public ItemList.SelectModeEnum GetSelectMode();

Selection mode, default Single, Multi or Toggle. Toggle switches selection by clicking without Ctrl. Setter does not normalize existing selected flags; for Multi/Toggle → Single call DeselectAll first and restore the desired record.

public int[] GetSelectedItems();

New array of selected indices in list order. In Single stops at the first flag even if others remain after a mode change. Editing the array does not mutate the list.

public TextServer.OverrunBehavior GetTextOverrunBehavior();

Text trimming/ellipsis under bounded width, default TrimEllipsis. Does not itself set width or enable wrapping; coordinate with FixedColumnWidth, MaxTextLines and IconMode.

public VScrollBar GetVScrollBar();

Shared internal VScrollBar owned by ItemList. Do not free/remove it. Scroll through Value; range/page/visibility are managed by list layout.

public bool HasAutoHeight();

Use content height as minimum height, default false. Not automatic scrolling to the last item; depends on columns and is calculated during layout refresh.

public bool HasAutoWidth();

Use content width as Control minimum width, default false. After recalculation can expand the parent container and bypass ordinary width-fitting of columns. Leave false for a bounded list.

public bool HasWraparoundItems();

Wrap items into following rows to fit width, default true. This is layout rather than cyclic keyboard selection. false allows horizontal overflow; MaxColumns still limits row length.

public bool IsAnythingSelected();

Checks for at least one selected flag. Disabled/nonselectable changes do not automatically clear a previously selected flag.

public bool IsItemDisabled(int idx);

Disabled flag rather than selection state.

public bool IsItemIconTransposed(int idx);

Icon-axis transpose flag.

public bool IsItemSelectable(int idx);

Selectable flag, separate from disabled and selected.

public bool IsItemTooltipEnabled(int idx);

Tooltip permission flag rather than current visibility.

public bool IsSameColumnWidth();

Equalizes widths using the widest item, default false. Does not fix column count or itself constrain text width.

public bool IsScrollHintTiled();

Tile the scroll_hint texture instead of stretching, default false. Relevant when ScrollHintMode is enabled and more content exists above/below.

public bool IsSelected(int idx);

Returns a record’s selected flag. Can remain true for multiple records after Multi/Toggle → Single until explicitly normalized.

public void MoveItem(int fromIdx, int toIdx);

Moves a complete record to final index toIdx; both indices are 0…ItemCount-1, use ItemCount - 1 for the end. Text, metadata and selected move together. No selection signals; explicitly restore current selection by ID after rebuilding.

public void RemoveItem(int idx);

Removes a record and shifts later indices without selection signals. Remaining selected flags stay with their records; internal current index is not a reliable ID. Reset/restore selection after removal.

public void Select(int idx, bool single = true);

Selects an eligible selectable, non-disabled record without ItemSelected/MultiSelected. Default single = true replaces all selection; false accumulates in Multi or Toggle. In Single mode false still performs single selection.

public void SetAllowReselect(bool allow);

Allows repeated user single-selection notification, default false. Does not make direct Select emit ItemSelected.

public void SetAllowRmbSelect(bool allow);

Allows right-button selection, default false. Does not create a context menu or restrict programmatic Select.

public void SetAllowSearch(bool allow);

Allows incremental typed search in the focused list, default true. Does not filter the model or add a search field.

public void SetAutoHeight(bool enable);

Use content height as minimum height, default false. Not automatic scrolling to the last item; depends on columns and is calculated during layout refresh.

public void SetAutoWidth(bool enable);

Use content width as Control minimum width, default false. After recalculation can expand the parent container and bypass ordinary width-fitting of columns. Leave false for a bounded list.

public void SetFixedColumnWidth(int width);

Configured column/text width in local pixels, default 0 uses content width. Requires ≥ 0. For text wrapping use positive width with IconMode.Top and MaxTextLines; theme item spacing contributes separately.

public void SetFixedIconSize(Vector2I size);

Fixed icon slot; default Vector2I.Zero uses source-region size. Applies when both components are positive; slot is multiplied by IconScale and drawing fits preserving aspect. Does not modify the resource.

public void SetIconMode(ItemList.IconModeEnum mode);

Main icon Left by default or Top. Top permits a wrapped label under bounded width; does not change original text or icon pixels.

public void SetIconScale(float scale);

Icon drawing/layout size multiplier, default 1. Must be finite; use a positive value for normal display. Also scales FixedIconSize without modifying Texture2D.

public void SetItemAutoTranslateMode(int idx, Entity.AutoTranslateModeEnum mode);

Record translation mode: Inherit uses control policy, Always requests translation, Disabled displays original text. Does not rewrite GetItemText. Supports negative indices.

public void SetItemCount(int count);

Record count, default 0. Setter requires ≥ 0: new records are empty, selectable and unselected; shrinking discards the tail without selection signals. Reset/restore selection explicitly after structural changes.

public void SetItemCustomBgColor(int idx, Color customBgColor);

Custom record background, default transparent black. Drawn when alpha > 0.001; separate from theme selected/hovered style colors. Supports negative indices.

public void SetItemCustomFgColor(int idx, Color customFgColor);

Overrides text color. new Color(0, 0, 0, 1) is the sentinel for theme text colors; do not confuse it with C# new Color(), whose alpha is 0. A custom color takes priority over theme selected/disabled text colors. Supports negative indices.

public void SetItemDisabled(int idx, bool disabled);

Changes the disabled flag: Select and user selection reject that target. A previously selected record retains selected. Supports negative indexing from the end.

public void SetItemIcon(int idx, Texture2D icon);

Assigns a shared Texture2D; null removes the icon. Marks layout dirty when the reference changes; does not copy the image. Internal resizing of the same resource does not guarantee geometry recalculation. Supports negative indexing from the end.

public void SetItemIconModulate(int idx, Color modulate);

Icon color/alpha multiplier, default white. Does not change text color or Texture2D pixels. Supports negative indices.

public void SetItemIconRegion(int idx, Rect2 rect);

Source-texture region in pixels. Zero width or height uses whole-texture dimensions. Supply a valid rectangle; affects natural slot size without physically cropping the resource. Supports negative indices.

public void SetItemIconTransposed(int idx, bool transposed);

Transposes icon axes for drawing and natural sizing without editing texture data. Combines with IconRegion/FixedIconSize/IconScale. Supports negative indices.

public void SetItemLanguage(int idx, string language);

Record shaping language; empty uses the control locale. Does not translate original Text. Supports negative indexing from the end.

public void SetItemMetadata(int idx, Variant metadata);

Sets record Variant data, such as a stable ID. Array/Dictionary can remain shared; this is not a deep copy. Supports negative indexing from the end.

public void SetItemSelectable(int idx, bool selectable);

Allows/disallows future record selection. Does not clear an existing selection; call Deselect separately when needed. Supports a negative index from the end.

public void SetItemText(int idx, string text);

Changes original text and refreshes translation/shaping. Does not rewrite index or metadata. Supports negative indexing from the end.

public void SetItemTextDirection(int idx, Control.TextDirection direction);

Record shaping direction; Inherited uses layout direction. Does not reverse the original string. Supports negative indexing from the end.

public void SetItemTooltip(int idx, string tooltip);

Sets a separate tooltip string without changing record text. Supports negative indexing from the end. Use SetItemTooltipEnabled to prevent display.

public void SetItemTooltipEnabled(int idx, bool enable);

Allows tooltip display, default true. Disabling does not clear the stored tooltip. Supports negative indexing from the end.

public void SetMaxColumns(int amount);

Column-count upper bound, default 1. 0 means no configured cap rather than zero columns. Wrapping can reduce actual count to fit available width. Requires ≥ 0.

public void SetMaxTextLines(int lines);

Maximum label lines, default 1; requires ≥ 1. Wrapping applies in IconMode.Top and requires bounded width, such as FixedColumnWidth. Increasing it in Left does not enable multiline layout.

public void SetSameColumnWidth(bool enable);

Equalizes widths using the widest item, default false. Does not fix column count or itself constrain text width.

public void SetScrollHintMode(ItemList.ScrollHintModeEnum scrollHintMode);

Decorative vertical-scroll hint: default Disabled, Both/Top/Bottom. Uses the theme scroll_hint and current range; does not enable scrolling or replace ScrollBar.

public void SetSelectMode(ItemList.SelectModeEnum mode);

Selection mode, default Single, Multi or Toggle. Toggle switches selection by clicking without Ctrl. Setter does not normalize existing selected flags; for Multi/Toggle → Single call DeselectAll first and restore the desired record.

public void SetTextOverrunBehavior(TextServer.OverrunBehavior overrunBehavior);

Text trimming/ellipsis under bounded width, default TrimEllipsis. Does not itself set width or enable wrapping; coordinate with FixedColumnWidth, MaxTextLines and IconMode.

public void SetTileScrollHint(bool tileScrollHint);

Tile the scroll_hint texture instead of stretching, default false. Relevant when ScrollHintMode is enabled and more content exists above/below.

public void SetWraparoundItems(bool enable);

Wrap items into following rows to fit width, default true. This is layout rather than cyclic keyboard selection. false allows horizontal overflow; MaxColumns still limits row length.

public void SortItemsByText();

Sorts records by original Text comparison rather than translation or locale-aware natural order. Selected/metadata move with records; do not assume stable ordering of equal strings. Does not emit selection signals.

public event ItemList.EmptyClickedEventHandler EmptyClicked;

Click on empty space. Does not itself promise deselection; call DeselectAll in the handler and refresh the panel when that behavior is desired.

public event ItemList.ItemActivatedEventHandler ItemActivated;

Record activation, usually double click or ui_accept. Not selection and not emitted by simple Select. Check application-model permission before opening/executing.

public event ItemList.ItemClickedEventHandler ItemClicked;

Record click action; selection may be unchanged. Supplies index, local position and mouse button. For a context menu inspect the button separately from AllowRmbSelect.

public event ItemList.ItemSelectedEventHandler ItemSelected;

User selection notification in single mode. Direct Select/Deselect/list rebuilding do not emit it. Supplies a current index rather than stable ID.

public event ItemList.MultiSelectedEventHandler MultiSelected;

User-input selected-flag change in multiple mode. Direct Select/Deselect do not emit it. Range selection can produce multiple events.