Class reference

ItemList

Inherits Control

A vertical list of selectable items with one or multiple columns.

Description

This control provides a vertical list of selectable items that may be in a single or in multiple columns, with each item having options for text and an 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" by double-clicking them or by pressing Enter. Item text only supports single-line strings. Newline characters (e.g. \n) in the string won't produce a newline. Text wrapping is enabled in ICON_MODE_TOP mode, but the column's width is adjusted to fully fit its content by default. You need to set fixed_column_width greater than zero to wrap the text. All set_* methods allow negative item indices, i.e. -1 to access the last item, -2 to select the second-to-last item, and so on. Incremental search: Like PopupMenu and Tree, ItemList supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing ProjectSettings.gui/timers/incremental_search_max_interval_msec.

Properties

`bool allow_reselect = false`

If true, the currently selected item can be selected again.

`bool allow_rmb_select = false`

If true, right mouse button click can select items.

`bool allow_search = true`

If true, allows navigating the ItemList with letter keys through incremental search.

`bool auto_height = false`

If true, the control will automatically resize the height to fit its content.

`bool auto_width = false`

If true, the control will automatically resize the width to fit its content.

`bool clip_contents = true`

`int fixed_column_width = 0`

The width all columns will be adjusted to. A value of zero disables the adjustment, each item will have a width equal to the width of its content and the columns will have an uneven width.

`Vector2i fixed_icon_size = Vector2i(0, 0)`

The size all icons will be adjusted to. If either X or Y component is not greater than zero, icon size won't be affected.

`int focus_mode = 2`

`int icon_mode = 1`

The icon position, whether above or to the left of the text. See the IconMode constants.

`float icon_scale = 1.0`

The scale of icon applied after fixed_icon_size and transposing takes effect.

`int item_count = 0`

The number of items currently in the list.

`int max_columns = 1`

Maximum columns the list will have. If greater than zero, the content will be split among the specified columns. A value of zero means unlimited columns, i.e. all items will be put in the same row.

`int max_text_lines = 1`

Maximum lines of text allowed in each item. Space will be reserved even when there is not enough lines of text to display. Note: This property takes effect only when icon_mode is ICON_MODE_TOP. To make the text wrap, fixed_column_width should be greater than zero.

`bool same_column_width = false`

Whether all columns will have the same width. If true, the width is equal to the largest column width of all columns.

`int select_mode = 0`

Allows single or multiple item selection. See the SelectMode constants.

`int text_overrun_behavior = 3`

The clipping behavior when the text exceeds an item's bounding rectangle.

`bool wraparound_items = true`

If true, the control will automatically move items into a new row to fit its content. See also HFlowContainer for this behavior. If false, the control will add a horizontal scrollbar to make all items visible.

Methods

`int add_icon_item(Texture2D icon, bool selectable = true)`

Adds an item to the item list with no text, only an icon. Returns the index of an added item.

`int add_item(String text, Texture2D icon = null, bool selectable = true)`

Adds an item to the item list with specified text. Returns the index of an added item. Specify an icon, or use null as the icon for a list item with no icon. If selectable is true, the list item will be selectable.

`void clear()`

Removes all items from the list.

`void deselect(int idx)`

Ensures the item associated with the specified index is not selected.

`void deselect_all()`

Ensures there are no items selected.

`void ensure_current_is_visible()`

Ensure current selection is visible, adjusting the scroll position as necessary.

`void force_update_list_size()`

Forces an update to the list size based on its items. This happens automatically whenever size of the items, or other relevant settings like auto_height, change. The method can be used to trigger the update ahead of next drawing pass.

`HScrollBar get_h_scroll_bar()`

Returns the horizontal scrollbar. Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.

`int get_item_at_position(Vector2 position, bool exact = false) const`

Returns the item index at the given position. When there is no item at that point, -1 will be returned if exact is true, and the closest item index will be returned otherwise. Note: The returned value is unreliable if called right after modifying the ItemList, before it redraws in the next frame.

`int get_item_auto_translate_mode(int idx) const`

Returns item's auto translate mode.

`Color get_item_custom_bg_color(int idx) const`

Returns the custom background color of the item specified by idx index.

`Color get_item_custom_fg_color(int idx) const`

Returns the custom foreground color of the item specified by idx index.

`Texture2D get_item_icon(int idx) const`

Returns the icon associated with the specified index.

`Color get_item_icon_modulate(int idx) const`

Returns a Color modulating item's icon at the specified index.

`Rect2 get_item_icon_region(int idx) const`

Returns the region of item's icon used. The whole icon will be used if the region has no area.

`String get_item_language(int idx) const`

Returns item's text language code.

`Variant get_item_metadata(int idx) const`

Returns the metadata value of the specified index.

`Rect2 get_item_rect(int idx, bool expand = true) const`

Returns the position and size of the item with the specified index, in the coordinate system of the ItemList node. If expand is true the last column expands to fill the rest of the row. Note: The returned value is unreliable if called right after modifying the ItemList, before it redraws in the next frame.

`String get_item_text(int idx) const`

Returns the text associated with the specified index.

`int get_item_text_direction(int idx) const`

Returns item's text base writing direction.

`String get_item_tooltip(int idx) const`

Returns the tooltip hint associated with the specified index.

`PackedInt32Array get_selected_items()`

Returns an array with the indexes of the selected items.

`VScrollBar get_v_scroll_bar()`

Returns the vertical scrollbar. Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.

`bool is_anything_selected()`

Returns true if one or more items are selected.

`bool is_item_disabled(int idx) const`

Returns true if the item at the specified index is disabled.

`bool is_item_icon_transposed(int idx) const`

Returns true if the item icon will be drawn transposed, i.e. the X and Y axes are swapped.

`bool is_item_selectable(int idx) const`

Returns true if the item at the specified index is selectable.

`bool is_item_tooltip_enabled(int idx) const`

Returns true if the tooltip is enabled for specified item index.

`bool is_selected(int idx) const`

Returns true if the item at the specified index is currently selected.

`void move_item(int from_idx, int to_idx)`

Moves item from index from_idx to to_idx.

`void remove_item(int idx)`

Removes the item specified by idx index from the list.

`void select(int idx, bool single = true)`

Select the item at the specified index. Note: This method does not trigger the item selection signal.

`void set_item_auto_translate_mode(int idx, int mode)`

Sets the auto translate mode of the item associated with the specified index. Items use Node.AUTO_TRANSLATE_MODE_INHERIT by default, which uses the same auto translate mode as the ItemList itself.

`void set_item_custom_bg_color(int idx, Color custom_bg_color)`

Sets the background color of the item specified by idx index to the specified Color.

`void set_item_custom_fg_color(int idx, Color custom_fg_color)`

Sets the foreground color of the item specified by idx index to the specified Color.

`void set_item_disabled(int idx, bool disabled)`

Disables (or enables) the item at the specified index. Disabled items cannot be selected and do not trigger activation signals (when double-clicking or pressing Enter).

`void set_item_icon(int idx, Texture2D icon)`

Sets (or replaces) the icon's Texture2D associated with the specified index.

`void set_item_icon_modulate(int idx, Color modulate)`

Sets a modulating Color of the item associated with the specified index.

`void set_item_icon_region(int idx, Rect2 rect)`

Sets the region of item's icon used. The whole icon will be used if the region has no area.

`void set_item_icon_transposed(int idx, bool transposed)`

Sets whether the item icon will be drawn transposed.

`void set_item_language(int idx, String language)`

Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.

`void set_item_metadata(int idx, Variant metadata)`

Sets a value (of any type) to be stored with the item associated with the specified index.

`void set_item_selectable(int idx, bool selectable)`

Allows or disallows selection of the item associated with the specified index.

`void set_item_text(int idx, String text)`

Sets text of the item associated with the specified index.

`void set_item_text_direction(int idx, int direction)`

Sets item's text base writing direction.

`void set_item_tooltip(int idx, String tooltip)`

Sets the tooltip hint for the item associated with the specified index.

`void set_item_tooltip_enabled(int idx, bool enable)`

Sets whether the tooltip hint is enabled for specified item index.

`void sort_items_by_text()`

Sorts items in the list by their text.

Signals

`empty_clicked(Vector2 at_position, int mouse_button_index)`

Emitted when any mouse click is issued within the rect of the list but on empty space. at_position is the click position in this control's local coordinate system.

`item_activated(int index)`

Emitted when specified list item is activated via double-clicking or by pressing Enter.

`item_clicked(int index, Vector2 at_position, int mouse_button_index)`

Emitted when specified list item has been clicked with any mouse button. at_position is the click position in this control's local coordinate system.

`item_selected(int index)`

Emitted when specified item has been selected. Only applicable in single selection mode. allow_reselect must be enabled to reselect an item.

`multi_selected(int index, bool selected)`

Emitted when a multiple selection is altered on a list allowing multiple selection.

Constants

`ICON_MODE_TOP = 0`

Enum: IconMode

Icon is drawn above the text.

`ICON_MODE_LEFT = 1`

Enum: IconMode

Icon is drawn to the left of the text.

`SELECT_SINGLE = 0`

Enum: SelectMode

Only allow selecting a single item.

`SELECT_MULTI = 1`

Enum: SelectMode

Allows selecting multiple items by holding Ctrl or Shift.

`SELECT_TOGGLE = 2`

Enum: SelectMode

Allows selecting multiple items by toggling them on and off.

Theme properties

`Color font_color = Color(0.65, 0.65, 0.65, 1)`

Default text Color of the item.

`Color font_hovered_color = Color(0.95, 0.95, 0.95, 1)`

Text Color used when the item is hovered and not selected yet.

`Color font_hovered_selected_color = Color(1, 1, 1, 1)`

Text Color used when the item is hovered and selected.

`Color font_outline_color = Color(0, 0, 0, 1)`

The tint of text outline of the item.

`Color font_selected_color = Color(1, 1, 1, 1)`

Text Color used when the item is selected, but not hovered.

`Color guide_color = Color(0.7, 0.7, 0.7, 0.25)`

Color of the guideline. The guideline is a line drawn between each row of items.

`int h_separation = 4`

The horizontal spacing between items.

`int icon_margin = 4`

The spacing between item's icon and text.

`int line_separation = 2`

The vertical spacing between each line of text.

`int outline_size = 0`

The size of the item text outline. Note: If using a font with FontFile.multichannel_signed_distance_field enabled, its FontFile.msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.