summaryrefslogtreecommitdiff
path: root/doc/classes/ItemList.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ItemList.xml')
-rw-r--r--doc/classes/ItemList.xml193
1 files changed, 85 insertions, 108 deletions
diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml
index 83e7eba5e5..844f260971 100644
--- a/doc/classes/ItemList.xml
+++ b/doc/classes/ItemList.xml
@@ -8,26 +8,27 @@
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 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 index, which makes the item accessed from the last one.
+ [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].
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_icon_item">
<return type="int" />
- <argument index="0" name="icon" type="Texture2D" />
- <argument index="1" name="selectable" type="bool" default="true" />
+ <param index="0" name="icon" type="Texture2D" />
+ <param index="1" name="selectable" type="bool" default="true" />
<description>
Adds an item to the item list with no text, only an icon. Returns the index of an added item.
</description>
</method>
<method name="add_item">
<return type="int" />
- <argument index="0" name="text" type="String" />
- <argument index="1" name="icon" type="Texture2D" default="null" />
- <argument index="2" name="selectable" type="bool" default="true" />
+ <param index="0" name="text" type="String" />
+ <param index="1" name="icon" type="Texture2D" default="null" />
+ <param index="2" name="selectable" type="bool" default="true" />
<description>
Adds an item to the item list with specified text. Returns the index of an added item.
- Specify an [code]icon[/code], or use [code]null[/code] as the [code]icon[/code] for a list item with no icon.
+ Specify an [param icon], or use [code]null[/code] as the [param icon] for a list item with no icon.
If selectable is [code]true[/code], the list item will be selectable.
</description>
</method>
@@ -37,16 +38,9 @@
Removes all items from the list.
</description>
</method>
- <method name="clear_item_opentype_features">
- <return type="void" />
- <argument index="0" name="idx" type="int" />
- <description>
- Removes all OpenType features from the item's text.
- </description>
- </method>
<method name="deselect">
<return type="void" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Ensures the item associated with the specified index is not selected.
</description>
@@ -65,87 +59,79 @@
</method>
<method name="get_item_at_position" qualifiers="const">
<return type="int" />
- <argument index="0" name="position" type="Vector2" />
- <argument index="1" name="exact" type="bool" default="false" />
+ <param index="0" name="position" type="Vector2" />
+ <param index="1" name="exact" type="bool" default="false" />
<description>
- Returns the item index at the given [code]position[/code].
- When there is no item at that point, -1 will be returned if [code]exact[/code] is [code]true[/code], and the closest item index will be returned otherwise.
+ 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.
</description>
</method>
<method name="get_item_custom_bg_color" qualifiers="const">
<return type="Color" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
- Returns the custom background color of the item specified by [code]idx[/code] index.
+ Returns the custom background color of the item specified by [param idx] index.
</description>
</method>
<method name="get_item_custom_fg_color" qualifiers="const">
<return type="Color" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
- Returns the custom foreground color of the item specified by [code]idx[/code] index.
+ Returns the custom foreground color of the item specified by [param idx] index.
</description>
</method>
<method name="get_item_icon" qualifiers="const">
<return type="Texture2D" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns the icon associated with the specified index.
</description>
</method>
<method name="get_item_icon_modulate" qualifiers="const">
<return type="Color" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns a [Color] modulating item's icon at the specified index.
</description>
</method>
<method name="get_item_icon_region" qualifiers="const">
<return type="Rect2" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns the region of item's icon used. The whole icon will be used if the region has no area.
</description>
</method>
<method name="get_item_language" qualifiers="const">
<return type="String" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns item's text language code.
</description>
</method>
<method name="get_item_metadata" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns the metadata value of the specified index.
</description>
</method>
- <method name="get_item_opentype_feature" qualifiers="const">
- <return type="int" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="tag" type="String" />
- <description>
- Returns OpenType feature [code]tag[/code] of the item's text.
- </description>
- </method>
<method name="get_item_text" qualifiers="const">
<return type="String" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns the text associated with the specified index.
</description>
</method>
<method name="get_item_text_direction" qualifiers="const">
<return type="int" enum="Control.TextDirection" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns item's text base writing direction.
</description>
</method>
<method name="get_item_tooltip" qualifiers="const">
<return type="String" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns the tooltip hint associated with the specified index.
</description>
@@ -171,58 +157,58 @@
</method>
<method name="is_item_disabled" qualifiers="const">
<return type="bool" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns [code]true[/code] if the item at the specified index is disabled.
</description>
</method>
<method name="is_item_icon_transposed" qualifiers="const">
<return type="bool" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns [code]true[/code] if the item icon will be drawn transposed, i.e. the X and Y axes are swapped.
</description>
</method>
<method name="is_item_selectable" qualifiers="const">
<return type="bool" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns [code]true[/code] if the item at the specified index is selectable.
</description>
</method>
<method name="is_item_tooltip_enabled" qualifiers="const">
<return type="bool" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns [code]true[/code] if the tooltip is enabled for specified item index.
</description>
</method>
<method name="is_selected" qualifiers="const">
<return type="bool" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
Returns [code]true[/code] if the item at the specified index is currently selected.
</description>
</method>
<method name="move_item">
<return type="void" />
- <argument index="0" name="from_idx" type="int" />
- <argument index="1" name="to_idx" type="int" />
+ <param index="0" name="from_idx" type="int" />
+ <param index="1" name="to_idx" type="int" />
<description>
- Moves item from index [code]from_idx[/code] to [code]to_idx[/code].
+ Moves item from index [param from_idx] to [param to_idx].
</description>
</method>
<method name="remove_item">
<return type="void" />
- <argument index="0" name="idx" type="int" />
+ <param index="0" name="idx" type="int" />
<description>
- Removes the item specified by [code]idx[/code] index from the list.
+ Removes the item specified by [param idx] index from the list.
</description>
</method>
<method name="select">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="single" type="bool" default="true" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="single" type="bool" default="true" />
<description>
Select the item at the specified index.
[b]Note:[/b] This method does not trigger the item selection signal.
@@ -230,24 +216,24 @@
</method>
<method name="set_item_custom_bg_color">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="custom_bg_color" type="Color" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="custom_bg_color" type="Color" />
<description>
- Sets the background color of the item specified by [code]idx[/code] index to the specified [Color].
+ Sets the background color of the item specified by [param idx] index to the specified [Color].
</description>
</method>
<method name="set_item_custom_fg_color">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="custom_fg_color" type="Color" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="custom_fg_color" type="Color" />
<description>
- Sets the foreground color of the item specified by [code]idx[/code] index to the specified [Color].
+ Sets the foreground color of the item specified by [param idx] index to the specified [Color].
</description>
</method>
<method name="set_item_disabled">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="disabled" type="bool" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="disabled" type="bool" />
<description>
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]).
@@ -255,97 +241,88 @@
</method>
<method name="set_item_icon">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="icon" type="Texture2D" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="icon" type="Texture2D" />
<description>
Sets (or replaces) the icon's [Texture2D] associated with the specified index.
</description>
</method>
<method name="set_item_icon_modulate">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="modulate" type="Color" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="modulate" type="Color" />
<description>
Sets a modulating [Color] of the item associated with the specified index.
</description>
</method>
<method name="set_item_icon_region">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="rect" type="Rect2" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="rect" type="Rect2" />
<description>
Sets the region of item's icon used. The whole icon will be used if the region has no area.
</description>
</method>
<method name="set_item_icon_transposed">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="transposed" type="bool" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="transposed" type="bool" />
<description>
Sets whether the item icon will be drawn transposed.
</description>
</method>
<method name="set_item_language">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="language" type="String" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="language" type="String" />
<description>
Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
</description>
</method>
<method name="set_item_metadata">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="metadata" type="Variant" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="metadata" type="Variant" />
<description>
Sets a value (of any type) to be stored with the item associated with the specified index.
</description>
</method>
- <method name="set_item_opentype_feature">
- <return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="tag" type="String" />
- <argument index="2" name="value" type="int" />
- <description>
- Sets OpenType feature [code]tag[/code] for the item's text. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url].
- </description>
- </method>
<method name="set_item_selectable">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="selectable" type="bool" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="selectable" type="bool" />
<description>
Allows or disallows selection of the item associated with the specified index.
</description>
</method>
<method name="set_item_text">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="text" type="String" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="text" type="String" />
<description>
Sets text of the item associated with the specified index.
</description>
</method>
<method name="set_item_text_direction">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="direction" type="int" enum="Control.TextDirection" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="direction" type="int" enum="Control.TextDirection" />
<description>
Sets item's text base writing direction.
</description>
</method>
<method name="set_item_tooltip">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="tooltip" type="String" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="tooltip" type="String" />
<description>
Sets the tooltip hint for the item associated with the specified index.
</description>
</method>
<method name="set_item_tooltip_enabled">
<return type="void" />
- <argument index="0" name="idx" type="int" />
- <argument index="1" name="enable" type="bool" />
+ <param index="0" name="idx" type="int" />
+ <param index="1" name="enable" type="bool" />
<description>
Sets whether the tooltip hint is enabled for specified item index.
</description>
@@ -372,7 +349,7 @@
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.
</member>
- <member name="fixed_icon_size" type="Vector2" setter="set_fixed_icon_size" getter="get_fixed_icon_size" default="Vector2(0, 0)">
+ <member name="fixed_icon_size" type="Vector2i" setter="set_fixed_icon_size" getter="get_fixed_icon_size" default="Vector2i(0, 0)">
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.
</member>
@@ -402,43 +379,43 @@
<member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="ItemList.SelectMode" default="0">
Allows single or multiple item selection. See the [enum SelectMode] constants.
</member>
- <member name="text_overrun_behavior" type="int" setter="set_text_overrun_behavior" getter="get_text_overrun_behavior" enum="TextParagraph.OverrunBehavior" default="3">
- Sets the clipping behavior when the text exceeds an item's bounding rectangle. See [enum TextParagraph.OverrunBehavior] for a description of all modes.
+ <member name="text_overrun_behavior" type="int" setter="set_text_overrun_behavior" getter="get_text_overrun_behavior" enum="TextServer.OverrunBehavior" default="3">
+ Sets the clipping behavior when the text exceeds an item's bounding rectangle. See [enum TextServer.OverrunBehavior] for a description of all modes.
</member>
</members>
<signals>
<signal name="empty_clicked">
- <argument index="0" name="at_position" type="Vector2" />
- <argument index="1" name="mouse_button_index" type="int" />
+ <param index="0" name="at_position" type="Vector2" />
+ <param index="1" name="mouse_button_index" type="int" />
<description>
Triggered when any mouse click is issued within the rect of the list but on empty space.
</description>
</signal>
<signal name="item_activated">
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Triggered when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd].
</description>
</signal>
<signal name="item_clicked">
- <argument index="0" name="index" type="int" />
- <argument index="1" name="at_position" type="Vector2" />
- <argument index="2" name="mouse_button_index" type="int" />
+ <param index="0" name="index" type="int" />
+ <param index="1" name="at_position" type="Vector2" />
+ <param index="2" name="mouse_button_index" type="int" />
<description>
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.
</description>
</signal>
<signal name="item_selected">
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Triggered when specified item has been selected.
[member allow_reselect] must be enabled to reselect an item.
</description>
</signal>
<signal name="multi_selected">
- <argument index="0" name="index" type="int" />
- <argument index="1" name="selected" type="bool" />
+ <param index="0" name="index" type="int" />
+ <param index="1" name="selected" type="bool" />
<description>
Triggered when a multiple selection is altered on a list allowing multiple selection.
</description>
@@ -468,7 +445,7 @@
<theme_item name="font_selected_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
Text [Color] used when the item is selected.
</theme_item>
- <theme_item name="guide_color" data_type="color" type="Color" default="Color(0, 0, 0, 0.1)">
+ <theme_item name="guide_color" data_type="color" type="Color" default="Color(0.7, 0.7, 0.7, 0.25)">
[Color] of the guideline. The guideline is a line drawn between each row of items.
</theme_item>
<theme_item name="h_separation" data_type="constant" type="int" default="4">
@@ -492,18 +469,18 @@
<theme_item name="font_size" data_type="font_size" type="int">
Font size of the item's text.
</theme_item>
- <theme_item name="bg" data_type="style" type="StyleBox">
- Default [StyleBox] for the [ItemList], i.e. used when the control is not being focused.
- </theme_item>
- <theme_item name="bg_focus" data_type="style" type="StyleBox">
- [StyleBox] used when the [ItemList] is being focused.
- </theme_item>
<theme_item name="cursor" data_type="style" type="StyleBox">
[StyleBox] used for the cursor, when the [ItemList] is being focused.
</theme_item>
<theme_item name="cursor_unfocused" data_type="style" type="StyleBox">
[StyleBox] used for the cursor, when the [ItemList] is not being focused.
</theme_item>
+ <theme_item name="focus" data_type="style" type="StyleBox">
+ The focused style for the [ItemList], drawn on top of the background, but below everything else.
+ </theme_item>
+ <theme_item name="panel" data_type="style" type="StyleBox">
+ The background style for the [ItemList].
+ </theme_item>
<theme_item name="selected" data_type="style" type="StyleBox">
[StyleBox] for the selected items, used when the [ItemList] is not being focused.
</theme_item>