godot-docs/classes/class_itemlist.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ItemList.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_ItemList:

ItemList
========

**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

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

Properties
----------

+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                     | :ref:`allow_reselect<class_ItemList_property_allow_reselect>`         |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                     | :ref:`allow_rmb_select<class_ItemList_property_allow_rmb_select>`     |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                     | :ref:`auto_height<class_ItemList_property_auto_height>`               |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`int<class_int>`                       | :ref:`fixed_column_width<class_ItemList_property_fixed_column_width>` |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>`               | :ref:`fixed_icon_size<class_ItemList_property_fixed_icon_size>`       |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`IconMode<enum_ItemList_IconMode>`     | :ref:`icon_mode<class_ItemList_property_icon_mode>`                   |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`float<class_float>`                   | :ref:`icon_scale<class_ItemList_property_icon_scale>`                 |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`int<class_int>`                       | :ref:`max_columns<class_ItemList_property_max_columns>`               |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`int<class_int>`                       | :ref:`max_text_lines<class_ItemList_property_max_text_lines>`         |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`bool<class_bool>`                     | :ref:`same_column_width<class_ItemList_property_same_column_width>`   |
+---------------------------------------------+-----------------------------------------------------------------------+
| :ref:`SelectMode<enum_ItemList_SelectMode>` | :ref:`select_mode<class_ItemList_property_select_mode>`               |
+---------------------------------------------+-----------------------------------------------------------------------+

Methods
-------

+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`add_icon_item<class_ItemList_method_add_icon_item>` **(** :ref:`Texture<class_Texture>` icon, :ref:`bool<class_bool>` selectable=true **)**                              |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`add_item<class_ItemList_method_add_item>` **(** :ref:`String<class_String>` text, :ref:`Texture<class_Texture>` icon=null, :ref:`bool<class_bool>` selectable=true **)** |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`clear<class_ItemList_method_clear>` **(** **)**                                                                                                                          |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`ensure_current_is_visible<class_ItemList_method_ensure_current_is_visible>` **(** **)**                                                                                  |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`get_item_at_position<class_ItemList_method_get_item_at_position>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` exact=false **)** const          |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`get_item_count<class_ItemList_method_get_item_count>` **(** **)** const                                                                                                  |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`               | :ref:`get_item_custom_bg_color<class_ItemList_method_get_item_custom_bg_color>` **(** :ref:`int<class_int>` idx **)** const                                                    |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`               | :ref:`get_item_custom_fg_color<class_ItemList_method_get_item_custom_fg_color>` **(** :ref:`int<class_int>` idx **)** const                                                    |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>`           | :ref:`get_item_icon<class_ItemList_method_get_item_icon>` **(** :ref:`int<class_int>` idx **)** const                                                                          |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`               | :ref:`get_item_icon_modulate<class_ItemList_method_get_item_icon_modulate>` **(** :ref:`int<class_int>` idx **)** const                                                        |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>`               | :ref:`get_item_icon_region<class_ItemList_method_get_item_icon_region>` **(** :ref:`int<class_int>` idx **)** const                                                            |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>`           | :ref:`get_item_metadata<class_ItemList_method_get_item_metadata>` **(** :ref:`int<class_int>` idx **)** const                                                                  |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`             | :ref:`get_item_text<class_ItemList_method_get_item_text>` **(** :ref:`int<class_int>` idx **)** const                                                                          |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`             | :ref:`get_item_tooltip<class_ItemList_method_get_item_tooltip>` **(** :ref:`int<class_int>` idx **)** const                                                                    |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`get_selected_items<class_ItemList_method_get_selected_items>` **(** **)**                                                                                                |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VScrollBar<class_VScrollBar>`     | :ref:`get_v_scroll<class_ItemList_method_get_v_scroll>` **(** **)**                                                                                                            |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_anything_selected<class_ItemList_method_is_anything_selected>` **(** **)**                                                                                            |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_item_disabled<class_ItemList_method_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const                                                                    |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_item_icon_transposed<class_ItemList_method_is_item_icon_transposed>` **(** :ref:`int<class_int>` idx **)** const                                                      |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_item_selectable<class_ItemList_method_is_item_selectable>` **(** :ref:`int<class_int>` idx **)** const                                                                |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_item_tooltip_enabled<class_ItemList_method_is_item_tooltip_enabled>` **(** :ref:`int<class_int>` idx **)** const                                                      |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_selected<class_ItemList_method_is_selected>` **(** :ref:`int<class_int>` idx **)** const                                                                              |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`move_item<class_ItemList_method_move_item>` **(** :ref:`int<class_int>` from_idx, :ref:`int<class_int>` to_idx **)**                                                     |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`remove_item<class_ItemList_method_remove_item>` **(** :ref:`int<class_int>` idx **)**                                                                                    |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`select<class_ItemList_method_select>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=true **)**                                                         |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_custom_bg_color<class_ItemList_method_set_item_custom_bg_color>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` custom_bg_color **)**               |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_custom_fg_color<class_ItemList_method_set_item_custom_fg_color>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` custom_fg_color **)**               |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_disabled<class_ItemList_method_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**                                      |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_icon<class_ItemList_method_set_item_icon>` **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` icon **)**                                            |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_icon_modulate<class_ItemList_method_set_item_icon_modulate>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` modulate **)**                          |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_icon_region<class_ItemList_method_set_item_icon_region>` **(** :ref:`int<class_int>` idx, :ref:`Rect2<class_Rect2>` rect **)**                                  |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_icon_transposed<class_ItemList_method_set_item_icon_transposed>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` rect **)**                            |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_metadata<class_ItemList_method_set_item_metadata>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)**                                |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_selectable<class_ItemList_method_set_item_selectable>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` selectable **)**                                |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_text<class_ItemList_method_set_item_text>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**                                              |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_tooltip<class_ItemList_method_set_item_tooltip>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**                                     |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_item_tooltip_enabled<class_ItemList_method_set_item_tooltip_enabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**                          |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`sort_items_by_text<class_ItemList_method_sort_items_by_text>` **(** **)**                                                                                                |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`unselect<class_ItemList_method_unselect>` **(** :ref:`int<class_int>` idx **)**                                                                                          |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`unselect_all<class_ItemList_method_unselect_all>` **(** **)**                                                                                                            |
+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Theme Properties
----------------

+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | bg                  |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | bg_focus            |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | cursor              |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | cursor_unfocused    |
+---------------------------------+---------------------+
| :ref:`Font<class_Font>`         | font                |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | font_color          |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | font_color_selected |
+---------------------------------+---------------------+
| :ref:`Color<class_Color>`       | guide_color         |
+---------------------------------+---------------------+
| :ref:`int<class_int>`           | hseparation         |
+---------------------------------+---------------------+
| :ref:`int<class_int>`           | icon_margin         |
+---------------------------------+---------------------+
| :ref:`int<class_int>`           | line_separation     |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | selected            |
+---------------------------------+---------------------+
| :ref:`StyleBox<class_StyleBox>` | selected_focus      |
+---------------------------------+---------------------+
| :ref:`int<class_int>`           | vseparation         |
+---------------------------------+---------------------+

Signals
-------

.. _class_ItemList_signal_item_activated:

- **item_activated** **(** :ref:`int<class_int>` index **)**

Triggered when specified list item is activated via double click or Enter.

----

.. _class_ItemList_signal_item_rmb_selected:

- **item_rmb_selected** **(** :ref:`int<class_int>` index, :ref:`Vector2<class_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.

:ref:`allow_rmb_select<class_ItemList_property_allow_rmb_select>` must be enabled.

----

.. _class_ItemList_signal_item_selected:

- **item_selected** **(** :ref:`int<class_int>` index **)**

Triggered when specified item has been selected.

:ref:`allow_reselect<class_ItemList_property_allow_reselect>` must be enabled to reselect an item.

----

.. _class_ItemList_signal_multi_selected:

- **multi_selected** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` selected **)**

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

----

.. _class_ItemList_signal_nothing_selected:

- **nothing_selected** **(** **)**

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

----

.. _class_ItemList_signal_rmb_clicked:

- **rmb_clicked** **(** :ref:`Vector2<class_Vector2>` at_position **)**

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

:ref:`allow_rmb_select<class_ItemList_property_allow_rmb_select>` must be enabled.

Enumerations
------------

.. _enum_ItemList_IconMode:

.. _class_ItemList_constant_ICON_MODE_TOP:

.. _class_ItemList_constant_ICON_MODE_LEFT:

enum **IconMode**:

- **ICON_MODE_TOP** = **0**

- **ICON_MODE_LEFT** = **1**

----

.. _enum_ItemList_SelectMode:

.. _class_ItemList_constant_SELECT_SINGLE:

.. _class_ItemList_constant_SELECT_MULTI:

enum **SelectMode**:

- **SELECT_SINGLE** = **0**

- **SELECT_MULTI** = **1**

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' with a double click (or Enter key).

Property Descriptions
---------------------

.. _class_ItemList_property_allow_reselect:

- :ref:`bool<class_bool>` **allow_reselect**

+----------+---------------------------+
| *Setter* | set_allow_reselect(value) |
+----------+---------------------------+
| *Getter* | get_allow_reselect()      |
+----------+---------------------------+

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

----

.. _class_ItemList_property_allow_rmb_select:

- :ref:`bool<class_bool>` **allow_rmb_select**

+----------+-----------------------------+
| *Setter* | set_allow_rmb_select(value) |
+----------+-----------------------------+
| *Getter* | get_allow_rmb_select()      |
+----------+-----------------------------+

If ``true``, right mouse button click can select items.

----

.. _class_ItemList_property_auto_height:

- :ref:`bool<class_bool>` **auto_height**

+----------+------------------------+
| *Setter* | set_auto_height(value) |
+----------+------------------------+
| *Getter* | has_auto_height()      |
+----------+------------------------+

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

----

.. _class_ItemList_property_fixed_column_width:

- :ref:`int<class_int>` **fixed_column_width**

+----------+-------------------------------+
| *Setter* | set_fixed_column_width(value) |
+----------+-------------------------------+
| *Getter* | get_fixed_column_width()      |
+----------+-------------------------------+

Sets the default column width in pixels.

If left to default value, each item will have a width equal to the width of its content and the columns will have an uneven width.

----

.. _class_ItemList_property_fixed_icon_size:

- :ref:`Vector2<class_Vector2>` **fixed_icon_size**

+----------+----------------------------+
| *Setter* | set_fixed_icon_size(value) |
+----------+----------------------------+
| *Getter* | get_fixed_icon_size()      |
+----------+----------------------------+

Sets the default icon size in pixels.

----

.. _class_ItemList_property_icon_mode:

- :ref:`IconMode<enum_ItemList_IconMode>` **icon_mode**

+----------+----------------------+
| *Setter* | set_icon_mode(value) |
+----------+----------------------+
| *Getter* | get_icon_mode()      |
+----------+----------------------+

Sets the default position of the icon to either :ref:`ICON_MODE_LEFT<class_ItemList_constant_ICON_MODE_LEFT>` or :ref:`ICON_MODE_TOP<class_ItemList_constant_ICON_MODE_TOP>`.

----

.. _class_ItemList_property_icon_scale:

- :ref:`float<class_float>` **icon_scale**

+----------+-----------------------+
| *Setter* | set_icon_scale(value) |
+----------+-----------------------+
| *Getter* | get_icon_scale()      |
+----------+-----------------------+

Sets the icon size to its initial size multiplied by the specified scale. Default value is 1.0.

----

.. _class_ItemList_property_max_columns:

- :ref:`int<class_int>` **max_columns**

+----------+------------------------+
| *Setter* | set_max_columns(value) |
+----------+------------------------+
| *Getter* | get_max_columns()      |
+----------+------------------------+

Sets the maximum columns the list will have.

If set to anything other than the default, the content will be split among the specified columns.

----

.. _class_ItemList_property_max_text_lines:

- :ref:`int<class_int>` **max_text_lines**

+----------+---------------------------+
| *Setter* | set_max_text_lines(value) |
+----------+---------------------------+
| *Getter* | get_max_text_lines()      |
+----------+---------------------------+

----

.. _class_ItemList_property_same_column_width:

- :ref:`bool<class_bool>` **same_column_width**

+----------+------------------------------+
| *Setter* | set_same_column_width(value) |
+----------+------------------------------+
| *Getter* | is_same_column_width()       |
+----------+------------------------------+

If set to ``true``, all columns will have the same width specified by :ref:`fixed_column_width<class_ItemList_property_fixed_column_width>`.

----

.. _class_ItemList_property_select_mode:

- :ref:`SelectMode<enum_ItemList_SelectMode>` **select_mode**

+----------+------------------------+
| *Setter* | set_select_mode(value) |
+----------+------------------------+
| *Getter* | get_select_mode()      |
+----------+------------------------+

Allow single or multiple item selection. See the ``SELECT_*`` constants.

Method Descriptions
-------------------

.. _class_ItemList_method_add_icon_item:

- void **add_icon_item** **(** :ref:`Texture<class_Texture>` icon, :ref:`bool<class_bool>` selectable=true **)**

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

----

.. _class_ItemList_method_add_item:

- void **add_item** **(** :ref:`String<class_String>` text, :ref:`Texture<class_Texture>` icon=null, :ref:`bool<class_bool>` selectable=true **)**

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.

----

.. _class_ItemList_method_clear:

- void **clear** **(** **)**

Remove all items from the list.

----

.. _class_ItemList_method_ensure_current_is_visible:

- void **ensure_current_is_visible** **(** **)**

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

----

.. _class_ItemList_method_get_item_at_position:

- :ref:`int<class_int>` **get_item_at_position** **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` exact=false **)** const

Given a position within the control return the item (if any) at that point.

----

.. _class_ItemList_method_get_item_count:

- :ref:`int<class_int>` **get_item_count** **(** **)** const

Returns the number of items currently in the list.

----

.. _class_ItemList_method_get_item_custom_bg_color:

- :ref:`Color<class_Color>` **get_item_custom_bg_color** **(** :ref:`int<class_int>` idx **)** const

Returns the :ref:`Color<class_Color>` set by :ref:`set_item_custom_bg_color<class_ItemList_method_set_item_custom_bg_color>`. Default value is ``Color(0, 0, 0, 0)``.

----

.. _class_ItemList_method_get_item_custom_fg_color:

- :ref:`Color<class_Color>` **get_item_custom_fg_color** **(** :ref:`int<class_int>` idx **)** const

Returns the :ref:`Color<class_Color>` set by :ref:`set_item_custom_fg_color<class_ItemList_method_set_item_custom_fg_color>`. Default value is ``Color(0, 0, 0, 0)``.

----

.. _class_ItemList_method_get_item_icon:

- :ref:`Texture<class_Texture>` **get_item_icon** **(** :ref:`int<class_int>` idx **)** const

Returns the icon associated with the specified index. Default value is ``null``.

----

.. _class_ItemList_method_get_item_icon_modulate:

- :ref:`Color<class_Color>` **get_item_icon_modulate** **(** :ref:`int<class_int>` idx **)** const

Returns a :ref:`Color<class_Color>` modulating item's icon at the specified index.

----

.. _class_ItemList_method_get_item_icon_region:

- :ref:`Rect2<class_Rect2>` **get_item_icon_region** **(** :ref:`int<class_int>` idx **)** const

----

.. _class_ItemList_method_get_item_metadata:

- :ref:`Variant<class_Variant>` **get_item_metadata** **(** :ref:`int<class_int>` idx **)** const

Returns the metadata value of the specified index set by :ref:`set_item_metadata<class_ItemList_method_set_item_metadata>`.

----

.. _class_ItemList_method_get_item_text:

- :ref:`String<class_String>` **get_item_text** **(** :ref:`int<class_int>` idx **)** const

Returns the text associated with the specified index.

----

.. _class_ItemList_method_get_item_tooltip:

- :ref:`String<class_String>` **get_item_tooltip** **(** :ref:`int<class_int>` idx **)** const

Returns the tooltip hint associated with the specified index.

----

.. _class_ItemList_method_get_selected_items:

- :ref:`PoolIntArray<class_PoolIntArray>` **get_selected_items** **(** **)**

Returns an array with the indexes of the selected items.

----

.. _class_ItemList_method_get_v_scroll:

- :ref:`VScrollBar<class_VScrollBar>` **get_v_scroll** **(** **)**

Returns the :ref:`Object<class_Object>` ID associated with the list.

----

.. _class_ItemList_method_is_anything_selected:

- :ref:`bool<class_bool>` **is_anything_selected** **(** **)**

Returns ``true`` if one or more items are selected.

----

.. _class_ItemList_method_is_item_disabled:

- :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** const

Returns whether or not the item at the specified index is disabled.

----

.. _class_ItemList_method_is_item_icon_transposed:

- :ref:`bool<class_bool>` **is_item_icon_transposed** **(** :ref:`int<class_int>` idx **)** const

----

.. _class_ItemList_method_is_item_selectable:

- :ref:`bool<class_bool>` **is_item_selectable** **(** :ref:`int<class_int>` idx **)** const

Returns whether or not the item at the specified index is selectable.

----

.. _class_ItemList_method_is_item_tooltip_enabled:

- :ref:`bool<class_bool>` **is_item_tooltip_enabled** **(** :ref:`int<class_int>` idx **)** const

Returns whether the tooltip is enabled for specified item index.

----

.. _class_ItemList_method_is_selected:

- :ref:`bool<class_bool>` **is_selected** **(** :ref:`int<class_int>` idx **)** const

Returns whether or not item at the specified index is currently selected.

----

.. _class_ItemList_method_move_item:

- void **move_item** **(** :ref:`int<class_int>` from_idx, :ref:`int<class_int>` to_idx **)**

Moves item from index ``from_idx`` to ``to_idx``.

----

.. _class_ItemList_method_remove_item:

- void **remove_item** **(** :ref:`int<class_int>` idx **)**

Removes the item specified by ``idx`` index from the list.

----

.. _class_ItemList_method_select:

- void **select** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=true **)**

Select the item at the specified index.

Note: This method does not trigger the item selection signal.

----

.. _class_ItemList_method_set_item_custom_bg_color:

- void **set_item_custom_bg_color** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` custom_bg_color **)**

Sets the background color of the item specified by ``idx`` index to the specified :ref:`Color<class_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.

----

.. _class_ItemList_method_set_item_custom_fg_color:

- void **set_item_custom_fg_color** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` custom_fg_color **)**

Sets the foreground color of the item specified by ``idx`` index to the specified :ref:`Color<class_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.

----

.. _class_ItemList_method_set_item_disabled:

- void **set_item_disabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**

Disable (or enable) item at the specified index.

Disabled items are not be selectable and do not trigger activation (Enter or double-click) signals.

----

.. _class_ItemList_method_set_item_icon:

- void **set_item_icon** **(** :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` icon **)**

Set (or replace) the icon's :ref:`Texture<class_Texture>` associated with the specified index.

----

.. _class_ItemList_method_set_item_icon_modulate:

- void **set_item_icon_modulate** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` modulate **)**

Sets a modulating :ref:`Color<class_Color>` of the item associated with the specified index.

----

.. _class_ItemList_method_set_item_icon_region:

- void **set_item_icon_region** **(** :ref:`int<class_int>` idx, :ref:`Rect2<class_Rect2>` rect **)**

----

.. _class_ItemList_method_set_item_icon_transposed:

- void **set_item_icon_transposed** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` rect **)**

----

.. _class_ItemList_method_set_item_metadata:

- void **set_item_metadata** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` metadata **)**

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

----

.. _class_ItemList_method_set_item_selectable:

- void **set_item_selectable** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` selectable **)**

Allow or disallow selection of the item associated with the specified index.

----

.. _class_ItemList_method_set_item_text:

- void **set_item_text** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**

Sets text of the item associated with the specified index.

----

.. _class_ItemList_method_set_item_tooltip:

- void **set_item_tooltip** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**

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

----

.. _class_ItemList_method_set_item_tooltip_enabled:

- void **set_item_tooltip_enabled** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)**

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

----

.. _class_ItemList_method_sort_items_by_text:

- void **sort_items_by_text** **(** **)**

Sorts items in the list by their text.

----

.. _class_ItemList_method_unselect:

- void **unselect** **(** :ref:`int<class_int>` idx **)**

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

----

.. _class_ItemList_method_unselect_all:

- void **unselect_all** **(** **)**

Ensure there are no items selected.