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.
All set_*
methods allow negative item index, which makes the item accessed from the last one.
Incremental search: 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 ProjectSettings.gui/timers/incremental_search_max_interval_msec.
Properties¶
|
||
|
||
|
||
clip_contents |
|
|
|
||
|
||
focus_mode |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
Theme Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Signals¶
Triggered when any mouse click is issued within the rect of the list but on empty space.
item_activated ( int index )
Triggered when specified list item is activated via double-clicking or by pressing Enter.
Triggered when specified list item has been clicked with any mouse button.
The click position is also provided to allow appropriate popup of context menus at the correct location.
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.
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¶
bool allow_reselect
Default |
|
Setter |
set_allow_reselect(value) |
Getter |
get_allow_reselect() |
If true
, the currently selected item can be selected again.
bool allow_rmb_select
Default |
|
Setter |
set_allow_rmb_select(value) |
Getter |
get_allow_rmb_select() |
If true
, right mouse button click can select items.
bool auto_height
Default |
|
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
Default |
|
Setter |
set_fixed_column_width(value) |
Getter |
get_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.
Vector2 fixed_icon_size
Default |
|
Setter |
set_fixed_icon_size(value) |
Getter |
get_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.
IconMode icon_mode
Default |
|
Setter |
set_icon_mode(value) |
Getter |
get_icon_mode() |
The icon position, whether above or to the left of the text. See the IconMode constants.
float icon_scale
Default |
|
Setter |
set_icon_scale(value) |
Getter |
get_icon_scale() |
The scale of icon applied after fixed_icon_size and transposing takes effect.
int item_count
Default |
|
Setter |
set_item_count(value) |
Getter |
get_item_count() |
The number of items currently in the list.
int max_columns
Default |
|
Setter |
set_max_columns(value) |
Getter |
get_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
Default |
|
Setter |
set_max_text_lines(value) |
Getter |
get_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
Default |
|
Setter |
set_same_column_width(value) |
Getter |
is_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.
SelectMode select_mode
Default |
|
Setter |
set_select_mode(value) |
Getter |
get_select_mode() |
Allows single or multiple item selection. See the SelectMode constants.
OverrunBehavior text_overrun_behavior
Default |
|
Setter |
set_text_overrun_behavior(value) |
Getter |
get_text_overrun_behavior() |
Sets the clipping behavior when the text exceeds an item's bounding rectangle. See OverrunBehavior for a description of all modes.
Method Descriptions¶
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 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 clear_item_opentype_features ( int idx )
Removes all OpenType features from the item's text.
void deselect ( int idx )
Ensures the item associated with the specified index is not selected.
void deselect_all ( )
Ensures there are no items selected.
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.
Returns the custom background color of the item specified by idx
index.
Returns the custom foreground color of the item specified by 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 OpenType feature tag
of the item's text.
Returns the text associated with the specified index.
TextDirection get_item_text_direction ( int idx ) const
Returns item's text base writing direction.
Returns the tooltip hint associated with the specified index.
PackedInt32Array get_selected_items ( )
Returns an array with the indexes of the selected items.
VScrollBar get_v_scroll_bar ( )
Returns the vertical scrollbar.
Warning: 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 CanvasItem.visible property.
bool is_anything_selected ( )
Returns true
if one or more items are selected.
Returns true
if the item at the specified index is disabled.
Returns true
if the item icon will be drawn transposed, i.e. the X and Y axes are swapped.
Returns true
if the item at the specified index is selectable.
Returns true
if the tooltip is enabled for specified item index.
Returns true
if the 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.
Sets the foreground color of the item specified by 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 Enter).
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 language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
Sets a value (of any type) to be stored with the item associated with the specified index.
Sets OpenType feature tag
for the item's text. More info: OpenType feature tags.
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_text_direction ( int idx, TextDirection direction )
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.
void sort_items_by_text ( )
Sorts items in the list by their text.
Theme Property Descriptions¶
Color font_color
Default |
|
Default text Color of the item.
Color font_outline_color
Default |
|
The tint of text outline of the item.
Color font_selected_color
Default |
|
Text Color used when the item is selected.
Color guide_color
Default |
|
Color of the guideline. The guideline is a line drawn between each row of items.
int h_separation
Default |
|
The horizontal spacing between items.
int icon_margin
Default |
|
The spacing between item's icon and text.
int line_separation
Default |
|
The vertical spacing between each line of text.
int outline_size
Default |
|
The size of the item text outline.
int v_separation
Default |
|
The vertical spacing between items.
Font font
Font of the item's text.
int font_size
Font size of the item's text.
StyleBox bg
Default StyleBox for the ItemList
, i.e. used when the control is not being focused.
StyleBox bg_focus
StyleBox used when the ItemList
is being focused.
StyleBox cursor
StyleBox used for the cursor, when the ItemList
is being focused.
StyleBox cursor_unfocused
StyleBox used for the cursor, when the ItemList
is not being focused.
StyleBox selected
StyleBox for the selected items, used when the ItemList
is not being focused.
StyleBox selected_focus
StyleBox for the selected items, used when the ItemList
is being focused.