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.

Methods

voidadd_icon_item ( Texture icon, bool selectable=true )
voidadd_item ( String text, Texture icon=null, bool selectable=true )
voidclear ( )
voidensure_current_is_visible ( )
intget_item_at_position ( Vector2 position, bool exact=false ) const
intget_item_count ( ) const
Colorget_item_custom_bg_color ( int idx ) const
Colorget_item_custom_fg_color ( int idx ) const
Textureget_item_icon ( int idx ) const
Colorget_item_icon_modulate ( int idx ) const
Rect2get_item_icon_region ( int idx ) const
Variantget_item_metadata ( int idx ) const
Stringget_item_text ( int idx ) const
Stringget_item_tooltip ( int idx ) const
PoolIntArrayget_selected_items ( )
VScrollBarget_v_scroll ( )
boolis_anything_selected ( )
boolis_item_disabled ( int idx ) const
boolis_item_icon_transposed ( int idx ) const
boolis_item_selectable ( int idx ) const
boolis_item_tooltip_enabled ( int idx ) const
boolis_selected ( int idx ) const
voidmove_item ( int from_idx, int to_idx )
voidremove_item ( int idx )
voidselect ( int idx, bool single=true )
voidset_item_custom_bg_color ( int idx, Color custom_bg_color )
voidset_item_custom_fg_color ( int idx, Color custom_fg_color )
voidset_item_disabled ( int idx, bool disabled )
voidset_item_icon ( int idx, Texture icon )
voidset_item_icon_modulate ( int idx, Color modulate )
voidset_item_icon_region ( int idx, Rect2 rect )
voidset_item_icon_transposed ( int idx, bool transposed )
voidset_item_metadata ( int idx, Variant metadata )
voidset_item_selectable ( int idx, bool selectable )
voidset_item_text ( int idx, String text )
voidset_item_tooltip ( int idx, String tooltip )
voidset_item_tooltip_enabled ( int idx, bool enable )
voidsort_items_by_text ( )
voidunselect ( int idx )
voidunselect_all ( )

Theme Properties

StyleBoxbg 
StyleBoxbg_focus 
StyleBoxcursor 
StyleBoxcursor_unfocused 
Fontfont 
Colorfont_colorColor( 0.63, 0.63, 0.63, 1 )
Colorfont_color_selectedColor( 1, 1, 1, 1 )
Colorguide_colorColor( 0, 0, 0, 0.1 )
inthseparation4
inticon_margin4
intline_separation2
StyleBoxselected 
StyleBoxselected_focus 
intvseparation2

Signals

  • item_activated ( int index )

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


  • item_rmb_selected ( int index, Vector2 at_position )

Triggered when specified list item has been selected via right mouse clicking.

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

allow_rmb_select must be enabled.


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


  • nothing_selected ( )

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


  • rmb_clicked ( Vector2 at_position )

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

allow_rmb_select must be enabled.

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

Defaultfalse
Setterset_allow_reselect(value)
Getterget_allow_reselect()

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


  • bool allow_rmb_select
Defaultfalse
Setterset_allow_rmb_select(value)
Getterget_allow_rmb_select()

If true, right mouse button click can select items.


Defaultfalse
Setterset_auto_height(value)
Getterhas_auto_height()

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


  • int fixed_column_width
Default0
Setterset_fixed_column_width(value)
Getterget_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.


DefaultVector2( 0, 0 )
Setterset_fixed_icon_size(value)
Getterget_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.


Default1
Setterset_icon_mode(value)
Getterget_icon_mode()

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


Default1.0
Setterset_icon_scale(value)
Getterget_icon_scale()

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


  • int max_columns
Default1
Setterset_max_columns(value)
Getterget_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
Default1
Setterset_max_text_lines(value)
Getterget_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
Defaultfalse
Setterset_same_column_width(value)
Getteris_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.


Default0
Setterset_select_mode(value)
Getterget_select_mode()

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

Method Descriptions

  • void add_icon_item ( Texture icon, bool selectable=true )

Adds an item to the item list with no text, only an icon.


Adds an item to the item list with specified text. 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 ensure_current_is_visible ( )

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


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.


  • int get_item_count ( ) const

Returns the number of items currently in the list.


  • 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 the metadata value of the specified index.


Returns the text associated with the specified index.


Returns the tooltip hint associated with the specified index.


Returns an array with the indexes of the selected items.


Returns the Object ID associated with the list.


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


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.

var some_string = "Some text"
some_string.set_item_custom_bg_color(0,Color(1, 0, 0, 1) # This will set the background color of the first item of the control to red.

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

var some_string = "Some text"
some_string.set_item_custom_fg_color(0,Color(1, 0, 0, 1) # This will set the foreground color of the first item of the control to red.

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


Sets text of the item associated with the specified index.


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


  • void unselect ( int idx )

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


  • void unselect_all ( )

Ensures there are no items selected.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.