ItemList

Inherits: Control < CanvasItem < Node < Object

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

Description

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" 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 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 index, which makes the item accessed from the last one.

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

bool

allow_rmb_select

false

bool

auto_height

false

bool

clip_contents

true (overrides Control)

int

fixed_column_width

0

Vector2i

fixed_icon_size

Vector2i(0, 0)

FocusMode

focus_mode

2 (overrides Control)

IconMode

icon_mode

1

float

icon_scale

1.0

int

item_count

0

int

max_columns

1

int

max_text_lines

1

bool

same_column_width

false

SelectMode

select_mode

0

OverrunBehavior

text_overrun_behavior

3

Methods

int

add_icon_item ( Texture2D icon, bool selectable=true )

int

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

void

clear ( )

void

deselect ( int idx )

void

deselect_all ( )

void

ensure_current_is_visible ( )

int

get_item_at_position ( Vector2 position, bool exact=false ) const

Color

get_item_custom_bg_color ( int idx ) const

Color

get_item_custom_fg_color ( int idx ) const

Texture2D

get_item_icon ( int idx ) const

Color

get_item_icon_modulate ( int idx ) const

Rect2

get_item_icon_region ( int idx ) const

String

get_item_language ( int idx ) const

Variant

get_item_metadata ( int idx ) const

String

get_item_text ( int idx ) const

TextDirection

get_item_text_direction ( int idx ) const

String

get_item_tooltip ( int idx ) const

PackedInt32Array

get_selected_items ( )

VScrollBar

get_v_scroll_bar ( )

bool

is_anything_selected ( )

bool

is_item_disabled ( int idx ) const

bool

is_item_icon_transposed ( int idx ) const

bool

is_item_selectable ( int idx ) const

bool

is_item_tooltip_enabled ( int idx ) const

bool

is_selected ( int idx ) const

void

move_item ( int from_idx, int to_idx )

void

remove_item ( int idx )

void

select ( int idx, bool single=true )

void

set_item_custom_bg_color ( int idx, Color custom_bg_color )

void

set_item_custom_fg_color ( int idx, Color custom_fg_color )

void

set_item_disabled ( int idx, bool disabled )

void

set_item_icon ( int idx, Texture2D icon )

void

set_item_icon_modulate ( int idx, Color modulate )

void

set_item_icon_region ( int idx, Rect2 rect )

void

set_item_icon_transposed ( int idx, bool transposed )

void

set_item_language ( int idx, String language )

void

set_item_metadata ( int idx, Variant metadata )

void

set_item_selectable ( int idx, bool selectable )

void

set_item_text ( int idx, String text )

void

set_item_text_direction ( int idx, TextDirection direction )

void

set_item_tooltip ( int idx, String tooltip )

void

set_item_tooltip_enabled ( int idx, bool enable )

void

sort_items_by_text ( )

Theme Properties

Color

font_color

Color(0.65, 0.65, 0.65, 1)

Color

font_outline_color

Color(1, 1, 1, 1)

Color

font_selected_color

Color(1, 1, 1, 1)

Color

guide_color

Color(0.7, 0.7, 0.7, 0.25)

int

h_separation

4

int

icon_margin

4

int

line_separation

2

int

outline_size

0

int

v_separation

2

Font

font

int

font_size

StyleBox

cursor

StyleBox

cursor_unfocused

StyleBox

focus

StyleBox

panel

StyleBox

selected

StyleBox

selected_focus

Signals

  • empty_clicked ( Vector2 at_position, int mouse_button_index )

Triggered when any mouse click is issued within the rect of the list but on empty space.

  • item_activated ( int index )

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

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

Triggered when specified list item has been clicked with any mouse button.

The click position is also provided to allow appropriate popup of context menus at the correct location.

  • item_selected ( int index )

Triggered when specified item has been selected.

allow_reselect must be enabled to reselect an item.

  • multi_selected ( int index, bool selected )

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

Enumerations

enum IconMode:

  • ICON_MODE_TOP = 0 --- Icon is drawn above the text.

  • ICON_MODE_LEFT = 1 --- Icon is drawn to the left of the text.

enum SelectMode:

  • SELECT_SINGLE = 0 --- Only allow selecting a single item.

  • SELECT_MULTI = 1 --- Allows selecting multiple items by holding Ctrl or Shift.

Property Descriptions

  • bool allow_reselect

Default

false

Setter

set_allow_reselect(value)

Getter

get_allow_reselect()

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

  • bool allow_rmb_select

Default

false

Setter

set_allow_rmb_select(value)

Getter

get_allow_rmb_select()

If true, right mouse button click can select items.

Default

false

Setter

set_auto_height(value)

Getter

has_auto_height()

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

  • int fixed_column_width

Default

0

Setter

set_fixed_column_width(value)

Getter

get_fixed_column_width()

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.

Default

Vector2i(0, 0)

Setter

set_fixed_icon_size(value)

Getter

get_fixed_icon_size()

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.

Default

1

Setter

set_icon_mode(value)

Getter

get_icon_mode()

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

Default

1.0

Setter

set_icon_scale(value)

Getter

get_icon_scale()

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

  • int item_count

Default

0

Setter

set_item_count(value)

Getter

get_item_count()

The number of items currently in the list.

  • int max_columns

Default

1

Setter

set_max_columns(value)

Getter

get_max_columns()

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

Default

1

Setter

set_max_text_lines(value)

Getter

get_max_text_lines()

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

Default

false

Setter

set_same_column_width(value)

Getter

is_same_column_width()

Whether all columns will have the same width.

If true, the width is equal to the largest column width of all columns.

Default

0

Setter

set_select_mode(value)

Getter

get_select_mode()

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

Default

3

Setter

set_text_overrun_behavior(value)

Getter

get_text_overrun_behavior()

Sets the clipping behavior when the text exceeds an item's bounding rectangle. See OverrunBehavior for a description of all modes.

Method Descriptions

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

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.

  • 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.

  • 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.

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.

Returns item's text language code.

Returns the metadata value of the specified index.

Returns the text associated with the specified index.

Returns item's text base writing direction.

Returns the tooltip hint associated with the specified index.

Returns an array with the indexes of the selected items.

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_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).

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.

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.

Theme Property Descriptions

Default

Color(0.65, 0.65, 0.65, 1)

Default text Color of the item.

  • Color font_outline_color

Default

Color(1, 1, 1, 1)

The tint of text outline of the item.

  • Color font_selected_color

Default

Color(1, 1, 1, 1)

Text Color used when the item is selected.

Default

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

Default

4

The horizontal spacing between items.

  • int icon_margin

Default

4

The spacing between item's icon and text.

  • int line_separation

Default

2

The vertical spacing between each line of text.

  • int outline_size

Default

0

The size of the item text outline.

  • int v_separation

Default

2

The vertical spacing between items.

Font of the item's text.

  • int font_size

Font size of the item's text.

StyleBox used for the cursor, when the ItemList is being focused.

StyleBox used for the cursor, when the ItemList is not being focused.

The focused style for the ItemList, drawn on top of the background, but below everything else.

The background style for the ItemList.

StyleBox for the selected items, used when the ItemList is not being focused.

StyleBox for the selected items, used when the ItemList is being focused.