ItemList¶
Inherits: Control < CanvasItem < Node < 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¶
Methods¶
Theme Properties¶
StyleBox | bg |
StyleBox | bg_focus |
StyleBox | cursor |
StyleBox | cursor_unfocused |
Font | font |
Color | font_color |
Color | font_color_selected |
Color | guide_color |
int | hseparation |
int | icon_margin |
int | line_separation |
StyleBox | selected |
StyleBox | selected_focus |
int | vseparation |
Signals¶
- item_activated ( int index )
Triggered when specified list item is activated via double click or Enter.
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.
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_MODE_LEFT = 1
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¶
- bool allow_reselect
Setter | set_allow_reselect(value) |
Getter | get_allow_reselect() |
If true
, the currently selected item can be selected again.
- bool allow_rmb_select
Setter | set_allow_rmb_select(value) |
Getter | get_allow_rmb_select() |
If true
, right mouse button click can select items.
- 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.
- 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.
- Vector2 fixed_icon_size
Setter | set_fixed_icon_size(value) |
Getter | get_fixed_icon_size() |
Sets the default icon size in pixels.
- IconMode icon_mode
Setter | set_icon_mode(value) |
Getter | get_icon_mode() |
Sets the default position of the icon to either ICON_MODE_LEFT or ICON_MODE_TOP.
- 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.
- 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.
- int max_text_lines
Setter | set_max_text_lines(value) |
Getter | get_max_text_lines() |
- 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 fixed_column_width.
- SelectMode select_mode
Setter | set_select_mode(value) |
Getter | get_select_mode() |
Allow single or multiple item selection. See the SELECT_*
constants.
Method Descriptions¶
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 of null for a list item with no icon.
If selectable is true
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.
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.
Returns the Color set by set_item_custom_bg_color. Default value is Color(0, 0, 0, 0)
.
Returns the Color set by set_item_custom_fg_color. Default value is Color(0, 0, 0, 0)
.
Returns the icon associated with the specified index. Default value is null
.
Returns a Color modulating item’s icon at the specified index.
Returns the metadata value of the specified index set by set_item_metadata.
Returns the text associated with the specified index.
Returns the tooltip hint associated with the specified index.
- PoolIntArray get_selected_items ( )
Returns an array with the indexes of the selected items.
- VScrollBar get_v_scroll ( )
Returns the Object ID associated with the list.
- bool is_anything_selected ( )
Returns true
if one or more items are selected.
Returns whether or not the item at the specified index is disabled.
Returns whether or not the item at the specified index is selectable.
Returns whether the tooltip is enabled for specified item index.
Returns whether or not item at the specified index is currently selected.
Moves item from index from_idx
to to_idx
.
- void remove_item ( int idx )
Removes the item specified by idx
index from the list.
Select the item at the specified index.
Note: This method does not trigger the item selection signal.
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.
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.
Disable (or enable) item at the specified index.
Disabled items are not be selectable and do not trigger activation (Enter or double-click) signals.
Set (or replace) the icon’s Texture associated with the specified index.
Sets a modulating Color of the item associated with the specified index.
Sets a value (of any type) to be stored with the item associated with the specified index.
Allow or disallow selection of the item associated with the specified index.
Sets text of the item associated with the specified index.
Sets tooltip hint for the item associated with the specified index.
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.
- void unselect_all ( )
Ensure there are no items selected.