ItemList

Category: Core

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

Properties

Methods

Signals

• item_activated ( index )

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

• item_rmb_selected ( int index, 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 ( index )

Triggered when specified item has been selected.

allow_reselect must be enabled to reselect an item.

• multi_selected ( 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 ( 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_MODE_LEFT = 1

enum SelectMode:

• SELECT_SINGLE = 0
• SELECT_MULTI = 1

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

• allow_reselect

If , the currently selected item can be selected again.

• bool allow_rmb_select

If true, right mouse button click can select items.

• auto_height

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

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

• icon_mode

Sets the default position of the icon to either ICON_MODE_LEFT or .

• float icon_scale

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

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

• int max_text_lines

• same_column_width

If set to true, all columns will have the same width specified by fixed_column_width.

• select_mode

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

Method Descriptions

• void add_icon_item ( Texture icon, selectable=true )

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

• void add_item ( String text, icon=null, 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 the list item will be selectable.

• void clear ( )

Remove all items from the list.

• void ensure_current_is_visible ( )

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

• get_item_at_position ( Vector2 position, exact=false ) const

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

• int get_item_count ( ) const

Returns the number of items currently in the list.

• get_item_custom_bg_color ( int idx ) const

Returns the set by set_item_custom_bg_color. Default value is Color(0, 0, 0, 0).

• get_item_custom_fg_color ( int idx ) const

Returns the set by set_item_custom_fg_color. Default value is Color(0, 0, 0, 0).

• get_item_icon ( int idx ) const

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

• get_item_icon_modulate ( int idx ) const

Returns a modulating item’s icon at the specified index.

• Rect2 get_item_icon_region ( idx ) const

• Variant get_item_metadata ( idx ) const

Returns the metadata value of the specified index set by set_item_metadata.

• get_item_text ( int idx ) const

Returns the text associated with the specified index.

• get_item_tooltip ( int idx ) const

Returns the tooltip hint associated with the specified index.

• get_selected_items ( )

Returns an array with the indexes of the selected items.

• VScrollBar get_v_scroll ( )

Returns the ID associated with the list.

• bool is_anything_selected ( )

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

• is_item_icon_transposed ( int idx ) const

• is_item_selectable ( int idx ) const

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

• is_item_tooltip_enabled ( int idx ) const

Returns whether the tooltip is enabled for specified item index.

• is_selected ( int idx ) const

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

• void move_item ( from_idx, int to_idx )

Moves item from index to to_idx.

• void remove_item ( idx )

Removes the item specified by idx index from the list.

• void select ( int idx, 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, custom_bg_color )

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

• void set_item_custom_fg_color ( idx, Color custom_fg_color )

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

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

• void set_item_icon ( int idx, icon )

Set (or replace) the icon’s Texture associated with the specified index.

• void set_item_icon_modulate ( idx, Color modulate )

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

• void set_item_icon_region ( int idx, rect )

• void set_item_icon_transposed ( int idx, rect )

• void set_item_metadata ( int idx, metadata )

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

• void set_item_selectable ( int idx, selectable )

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

• void set_item_text ( int idx, text )

Sets text of the item associated with the specified index.

• void set_item_tooltip ( int idx, tooltip )

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

• void set_item_tooltip_enabled ( int idx, 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 )

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

Ensure there are no items selected.