ItemList

Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns.

This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, or both text and icon. Tooltips are supported and may be different for every item in the list. Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key).

@GodotBaseClass

struct ItemList {

enum string _GODOT_internal_name;

union __anonymous;

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

bool opEquals(ItemList other);

ItemList opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static ItemList _new();

enum SelectMode;

enum Constants;

void addItem(StringArg0 text, Texture icon, bool selectable);

void addIconItem(Texture icon, bool selectable);

void setItemText(long idx, StringArg1 text);

String getItemText(long idx);

void setItemIcon(long idx, Texture icon);

Ref!Texture getItemIcon(long idx);

void setItemIconRegion(long idx, Rect2 rect);

Rect2 getItemIconRegion(long idx);

void setItemIconModulate(long idx, Color modulate);

Color getItemIconModulate(long idx);

void setItemSelectable(long idx, bool selectable);

bool isItemSelectable(long idx);

void setItemDisabled(long idx, bool disabled);

bool isItemDisabled(long idx);

void setItemMetadata(long idx, VariantArg1 metadata);

Variant getItemMetadata(long idx);

void setItemCustomBgColor(long idx, Color custom_bg_color);

Color getItemCustomBgColor(long idx);

void setItemCustomFgColor(long idx, Color custom_fg_color);

Color getItemCustomFgColor(long idx);

void setItemTooltipEnabled(long idx, bool enable);

bool isItemTooltipEnabled(long idx);

void setItemTooltip(long idx, StringArg1 tooltip);

String getItemTooltip(long idx);

void select(long idx, bool single);

void unselect(long idx);

void unselectAll();

bool isSelected(long idx);

PoolIntArray getSelectedItems();

void moveItem(long from_idx, long to_idx);

long getItemCount();

void removeItem(long idx);

void clear();

void sortItemsByText();

void setFixedColumnWidth(long width);

long getFixedColumnWidth();

void setSameColumnWidth(bool enable);

bool isSameColumnWidth();

void setMaxTextLines(long lines);

long getMaxTextLines();

void setMaxColumns(long amount);

long getMaxColumns();

void setSelectMode(long mode);

ItemList.SelectMode getSelectMode();

void setIconMode(long mode);

ItemList.IconMode getIconMode();

void setFixedIconSize(Vector2 size);

Vector2 getFixedIconSize();

void setIconScale(double scale);

double getIconScale();

void setAllowRmbSelect(bool allow);

bool getAllowRmbSelect();

void setAllowReselect(bool allow);

bool getAllowReselect();

void setAutoHeight(bool enable);

bool hasAutoHeight();

bool isAnythingSelected();

long getItemAtPosition(Vector2 position, bool exact);

void ensureCurrentIsVisible();

VScrollBar getVScroll();

void _scrollChanged(double arg0);

void _guiInput(InputEvent arg0);

void _setItems(Array arg0);

Array _getItems();

Array items [@property getter];

Array items [@property setter];

ItemList.SelectMode selectMode [@property getter];

long selectMode [@property setter];

bool allowReselect [@property getter];

bool allowReselect [@property setter];

bool allowRmbSelect [@property getter];

bool allowRmbSelect [@property setter];

long maxTextLines [@property getter];

long maxTextLines [@property setter];

bool autoHeight [@property getter];

bool autoHeight [@property setter];

long maxColumns [@property getter];

long maxColumns [@property setter];

bool sameColumnWidth [@property getter];

bool sameColumnWidth [@property setter];

long fixedColumnWidth [@property getter];

long fixedColumnWidth [@property setter];

ItemList.IconMode iconMode [@property getter];

long iconMode [@property setter];

double iconScale [@property getter];

double iconScale [@property setter];

Vector2 fixedIconSize [@property getter];

Vector2 fixedIconSize [@property setter];

}

Members

Aliases

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

Enums

Constants enum Constants
IconMode enum IconMode
SelectMode enum SelectMode

Functions

_getItems Array _getItems()
_guiInput void _guiInput(InputEvent arg0)
_scrollChanged void _scrollChanged(double arg0)
_setItems void _setItems(Array arg0)
addIconItem void addIconItem(Texture icon, bool selectable): Adds an item to the item list with no text, only an icon.
addItem void addItem(StringArg0 text, Texture icon, bool selectable): Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. If selectable is true the list item will be selectable.
clear void clear(): Remove all items from the list.
ensureCurrentIsVisible void ensureCurrentIsVisible(): Ensure selection is visible, adjusting the scroll position as necessary.
getAllowReselect bool getAllowReselect()
getAllowRmbSelect bool getAllowRmbSelect()
getFixedColumnWidth long getFixedColumnWidth()
getFixedIconSize Vector2 getFixedIconSize()
getIconMode ItemList.IconMode getIconMode()
getIconScale double getIconScale()
getItemAtPosition long getItemAtPosition(Vector2 position, bool exact): Given a position within the control return the item (if any) at that point.
getItemCount long getItemCount(): Return count of items currently in the item list.
getItemCustomBgColor Color getItemCustomBgColor(long idx)
getItemCustomFgColor Color getItemCustomFgColor(long idx)
getItemIcon Ref!Texture getItemIcon(long idx)
getItemIconModulate Color getItemIconModulate(long idx): Returns a Color modulating item's icon at the specified index.
getItemIconRegion Rect2 getItemIconRegion(long idx)
getItemMetadata Variant getItemMetadata(long idx)
getItemText String getItemText(long idx): Return the text for specified item index.
getItemTooltip String getItemTooltip(long idx): Return tooltip hint for specified item index.
getMaxColumns long getMaxColumns()
getMaxTextLines long getMaxTextLines()
getSelectMode ItemList.SelectMode getSelectMode()
getSelectedItems PoolIntArray getSelectedItems(): Returns the list of selected indexes.
getVScroll VScrollBar getVScroll(): Returns the current vertical scroll bar for the List.
hasAutoHeight bool hasAutoHeight()
isAnythingSelected bool isAnythingSelected(): Returns true if one or more items are selected.
isItemDisabled bool isItemDisabled(long idx): Returns whether or not the item at the specified index is disabled
isItemSelectable bool isItemSelectable(long idx): Returns whether or not the item at the specified index is selectable.
isItemTooltipEnabled bool isItemTooltipEnabled(long idx): Returns whether the tooltip is enabled for specified item index.
isSameColumnWidth bool isSameColumnWidth()
isSelected bool isSelected(long idx): Returns whether or not item at the specified index is currently selected.
moveItem void moveItem(long from_idx, long to_idx): Moves item at index from_idx to to_idx.
opAssign ItemList opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(ItemList other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
removeItem void removeItem(long idx): Remove item at specified index from the list.
select void select(long idx, bool single): Select the item at the specified index. Note: This method does not trigger the item selection signal.
setAllowReselect void setAllowReselect(bool allow)
setAllowRmbSelect void setAllowRmbSelect(bool allow)
setAutoHeight void setAutoHeight(bool enable)
setFixedColumnWidth void setFixedColumnWidth(long width)
setFixedIconSize void setFixedIconSize(Vector2 size)
setIconMode void setIconMode(long mode)
setIconScale void setIconScale(double scale)
setItemCustomBgColor void setItemCustomBgColor(long idx, Color custom_bg_color)
setItemCustomFgColor void setItemCustomFgColor(long idx, Color custom_fg_color)
setItemDisabled void setItemDisabled(long idx, bool disabled): Disable (or enable) item at specified index. Disabled items are not be selectable and do not fire activation (Enter or double-click) signals.
setItemIcon void setItemIcon(long idx, Texture icon): Set (or replace) icon of the item at the specified index.
setItemIconModulate void setItemIconModulate(long idx, Color modulate): Sets a modulating Color for item's icon at the specified index.
setItemIconRegion void setItemIconRegion(long idx, Rect2 rect)
setItemMetadata void setItemMetadata(long idx, VariantArg1 metadata): Sets a value (of any type) to be stored with the item at the specified index.
setItemSelectable void setItemSelectable(long idx, bool selectable): Allow or disallow selection of the item at the specified index.
setItemText void setItemText(long idx, StringArg1 text): Sets text of item at specified index.
setItemTooltip void setItemTooltip(long idx, StringArg1 tooltip): Sets tooltip hint for item at specified index.
setItemTooltipEnabled void setItemTooltipEnabled(long idx, bool enable): Sets whether the tooltip is enabled for specified item index.
setMaxColumns void setMaxColumns(long amount)
setMaxTextLines void setMaxTextLines(long lines)
setSameColumnWidth void setSameColumnWidth(bool enable)
setSelectMode void setSelectMode(long mode)
sortItemsByText void sortItemsByText(): Sorts items in the list by their text.
unselect void unselect(long idx): Ensure item at specified index is not selected.
unselectAll void unselectAll(): Ensure there are no items selected.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

allowReselect bool allowReselect [@property getter]
bool allowReselect [@property setter]: If true the currently selected item may be selected again.
allowRmbSelect bool allowRmbSelect [@property getter]
bool allowRmbSelect [@property setter]: If true a right mouse button click can select items.
autoHeight bool autoHeight [@property getter]
bool autoHeight [@property setter]
fixedColumnWidth long fixedColumnWidth [@property getter]
long fixedColumnWidth [@property setter]
fixedIconSize Vector2 fixedIconSize [@property setter]
fixedIconSize Vector2 fixedIconSize [@property getter]
iconMode ItemList.IconMode iconMode [@property getter]
long iconMode [@property setter]
iconScale double iconScale [@property getter]
double iconScale [@property setter]
items Array items [@property getter]
Array items [@property setter]
maxColumns long maxColumns [@property getter]
long maxColumns [@property setter]
maxTextLines long maxTextLines [@property getter]
long maxTextLines [@property setter]
sameColumnWidth bool sameColumnWidth [@property getter]
bool sameColumnWidth [@property setter]
selectMode ItemList.SelectMode selectMode [@property getter]
long selectMode [@property setter]: Allow single or multiple selection. See the SELECT_* constants.

Static functions

_new ItemList _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: 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 To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as 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 itemlist structs

ItemList