A vertical list of selectable items with one or multiple columns.
This control provides a vertical list of selectable items that may be in a single or in multiple columns, with each item having options for text and an 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 [kbd]Enter[/kbd]. Item text only supports single-line strings. Newline characters (e.g. [code]\n[/code]) in the string won't produce a newline. Text wrapping is enabled in [constant ICON_MODE_TOP] mode, but the column's width is adjusted to fully fit its content by default. You need to set [member fixed_column_width] greater than zero to wrap the text. All [code]set_*[/code] methods allow negative item indices, i.e. [code]-1[/code] to access the last item, [code]-2[/code] to select the second-to-last item, and so on. [b]Incremental search:[/b] 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 [member ProjectSettings.gui/timers/incremental_search_max_interval_msec].
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 [param icon], or use [code]null[/code] as the [param icon] for a list item with no icon. If [param selectable] is [code]true[/code], the list item will be selectable.
Removes all items from the list.
Ensures the item associated with the specified index is not selected.
Ensures there are no items selected.
Ensure current selection is visible, adjusting the scroll position as necessary.
Forces an update to the list size based on its items. This happens automatically whenever size of the items, or other relevant settings like [member auto_height], change. The method can be used to trigger the update ahead of next drawing pass.
Returns the horizontal scrollbar. [b]Warning:[/b] 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 [member CanvasItem.visible] property.
Returns the item index at the given [param position]. When there is no item at that point, -1 will be returned if [param exact] is [code]true[/code], and the closest item index will be returned otherwise. [b]Note:[/b] The returned value is unreliable if called right after modifying the [ItemList], before it redraws in the next frame.
Returns item's auto translate mode.
Returns the custom background color of the item specified by [param idx] index.
Returns the custom foreground color of the item specified by [param idx] index.
Returns the icon associated with the specified index.
Returns a [Color] modulating item's icon at the specified index.
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 position and size of the item with the specified index, in the coordinate system of the [ItemList] node. If [param expand] is [code]true[/code] the last column expands to fill the rest of the row. [b]Note:[/b] The returned value is unreliable if called right after modifying the [ItemList], before it redraws in the next frame.
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. [b]Warning:[/b] 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 [member CanvasItem.visible] property.
Returns [code]true[/code] if one or more items are selected.
Returns [code]true[/code] if the item at the specified index is disabled.
Returns [code]true[/code] if the item icon will be drawn transposed, i.e. the X and Y axes are swapped.
Returns [code]true[/code] if the item at the specified index is selectable.
Returns [code]true[/code] if the tooltip is enabled for specified item index.
Returns [code]true[/code] if the item at the specified index is currently selected.
Moves item from index [param from_idx] to [param to_idx].
Removes the item specified by [param idx] index from the list.
Select the item at the specified index. [b]Note:[/b] This method does not trigger the item selection signal.
Sets the auto translate mode of the item associated with the specified index. Items use [constant Node.AUTO_TRANSLATE_MODE_INHERIT] by default, which uses the same auto translate mode as the [ItemList] itself.
Sets the background color of the item specified by [param idx] index to the specified [Color].
Sets the foreground color of the item specified by [param idx] index to the specified [Color].
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 [kbd]Enter[/kbd]).
Sets (or replaces) the icon's [Texture2D] associated with the specified index.
Sets a modulating [Color] of the item associated with the specified index.
Sets the region of item's icon used. The whole icon will be used if the region has no area.
Sets whether the item icon will be drawn transposed.
Sets the language code of the text for the item at the given index to [param language]. This is used for line-breaking and text shaping algorithms. If [param language] is empty, the current locale is used.
Sets a value (of any type) to be stored with the item associated with the specified index.
Allows or disallows selection of the item associated with the specified index.
Sets text of the item associated with the specified index.
Sets item's text base writing direction.
Sets the tooltip hint for the item associated with the specified index.
Sets whether the tooltip hint is enabled for specified item index.
Sorts items in the list by their text.
- If [code]true[/code], the currently selected item can be selected again.
- If [code]true[/code], right mouse button click can select items.
- If [code]true[/code], allows navigating the [ItemList] with letter keys through incremental search.
- If [code]true[/code], the control will automatically resize the height to fit its content.
- If [code]true[/code], the control will automatically resize the width to fit its content.
- 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.
- 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.
- The icon position, whether above or to the left of the text. See the [enum IconMode] constants.
- The scale of icon applied after [member fixed_icon_size] and transposing takes effect.
- The number of items currently in the list.
- 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.
- Maximum lines of text allowed in each item. Space will be reserved even when there is not enough lines of text to display. [b]Note:[/b] This property takes effect only when [member icon_mode] is [constant ICON_MODE_TOP]. To make the text wrap, [member fixed_column_width] should be greater than zero.
- Whether all columns will have the same width. If [code]true[/code], the width is equal to the largest column width of all columns.
- Allows single or multiple item selection. See the [enum SelectMode] constants.
- The clipping behavior when the text exceeds an item's bounding rectangle.
- If [code]true[/code], the control will automatically move items into a new row to fit its content. See also [HFlowContainer] for this behavior. If [code]false[/code], the control will add a horizontal scrollbar to make all items visible.
Emitted when any mouse click is issued within the rect of the list but on empty space. [param at_position] is the click position in this control's local coordinate system.
Emitted when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd].
Emitted when specified list item has been clicked with any mouse button. [param at_position] is the click position in this control's local coordinate system.
Emitted when specified item has been selected. Only applicable in single selection mode. [member allow_reselect] must be enabled to reselect an item.
Emitted when a multiple selection is altered on a list allowing multiple selection.
Icon is drawn above the text.
Icon is drawn to the left of the text.
Only allow selecting a single item.
Allows selecting multiple items by holding [kbd]Ctrl[/kbd] or [kbd]Shift[/kbd].
Allows selecting multiple items by toggling them on and off.
Default text [Color] of the item.
Text [Color] used when the item is hovered and not selected yet.
Text [Color] used when the item is hovered and selected.
The tint of text outline of the item.
Text [Color] used when the item is selected, but not hovered.
[Color] of the guideline. The guideline is a line drawn between each row of items.
The horizontal spacing between items.
The spacing between item's icon and text.
The vertical spacing between each line of text.
The size of the item text outline. [b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
The vertical spacing between items.
[Font] of the item's text.
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 everything.
[StyleBox] for the hovered, but not selected items.
[StyleBox] for the hovered and selected items, used when the [ItemList] is not being focused.
[StyleBox] for the hovered and selected items, used when the [ItemList] is being focused.
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.