diff options
Diffstat (limited to 'doc/classes/ItemList.xml')
| -rw-r--r-- | doc/classes/ItemList.xml | 387 |
1 files changed, 137 insertions, 250 deletions
diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 0020cbf242..e3e4a9fa7d 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -12,25 +12,18 @@ </tutorials> <methods> <method name="add_icon_item"> - <return type="int"> - </return> - <argument index="0" name="icon" type="Texture2D"> - </argument> - <argument index="1" name="selectable" type="bool" default="true"> - </argument> + <return type="int" /> + <argument index="0" name="icon" type="Texture2D" /> + <argument 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"> - </return> - <argument index="0" name="text" type="String"> - </argument> - <argument index="1" name="icon" type="Texture2D" default="null"> - </argument> - <argument index="2" name="selectable" type="bool" default="true"> - </argument> + <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" /> <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. @@ -38,433 +31,331 @@ </description> </method> <method name="clear"> - <return type="void"> - </return> + <return type="void" /> <description> Removes all items from the list. </description> </method> <method name="clear_item_opentype_features"> - <return type="void"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> <description> Ensures the item associated with the specified index is not selected. </description> </method> <method name="deselect_all"> - <return type="void"> - </return> + <return type="void" /> <description> Ensures there are no items selected. </description> </method> <method name="ensure_current_is_visible"> - <return type="void"> - </return> + <return type="void" /> <description> Ensure current selection is visible, adjusting the scroll position as necessary. </description> </method> <method name="get_item_at_position" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="exact" type="bool" default="false"> - </argument> + <return type="int" /> + <argument index="0" name="position" type="Vector2" /> + <argument 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. </description> </method> <method name="get_item_count" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the number of items currently in the list. </description> </method> <method name="get_item_custom_bg_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="Color" /> + <argument index="0" name="idx" type="int" /> <description> Returns the custom background color of the item specified by [code]idx[/code] index. </description> </method> <method name="get_item_custom_fg_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="Color" /> + <argument index="0" name="idx" type="int" /> <description> Returns the custom foreground color of the item specified by [code]idx[/code] index. </description> </method> <method name="get_item_icon" qualifiers="const"> - <return type="Texture2D"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="Texture2D" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="Color" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="Rect2" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="String" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="Variant" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="tag" type="String"> - </argument> + <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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="String" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="int" enum="Control.TextDirection" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="String" /> + <argument index="0" name="idx" type="int" /> <description> Returns the tooltip hint associated with the specified index. </description> </method> <method name="get_selected_items"> - <return type="PackedInt32Array"> - </return> + <return type="PackedInt32Array" /> <description> Returns an array with the indexes of the selected items. </description> </method> <method name="get_v_scroll"> - <return type="VScrollBar"> - </return> + <return type="VScrollBar" /> <description> Returns the [Object] ID associated with the list. </description> </method> <method name="is_anything_selected"> - <return type="bool"> - </return> + <return type="bool" /> <description> Returns [code]true[/code] if one or more items are selected. </description> </method> <method name="is_item_disabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="bool" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="bool" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="bool" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="bool" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="bool" /> + <argument 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"> - </return> - <argument index="0" name="from_idx" type="int"> - </argument> - <argument index="1" name="to_idx" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="from_idx" type="int" /> + <argument index="1" name="to_idx" type="int" /> <description> Moves item from index [code]from_idx[/code] to [code]to_idx[/code]. </description> </method> <method name="remove_item"> - <return type="void"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> <description> Removes the item specified by [code]idx[/code] index from the list. </description> </method> <method name="select"> - <return type="void"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="single" type="bool" default="true"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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. </description> </method> <method name="set_item_custom_bg_color"> - <return type="void"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="custom_bg_color" type="Color"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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]. </description> </method> <method name="set_item_custom_fg_color"> - <return type="void"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="custom_fg_color" type="Color"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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]. </description> </method> <method name="set_item_disabled"> - <return type="void"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="disabled" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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]). </description> </method> <method name="set_item_icon"> - <return type="void"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="icon" type="Texture2D"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="modulate" type="Color"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="rect" type="Rect2"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="transposed" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="language" type="String"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="metadata" type="Variant"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="tag" type="String"> - </argument> - <argument index="2" name="value" type="int"> - </argument> + <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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="selectable" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="direction" type="int" enum="Control.TextDirection"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="tooltip" type="String"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument 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"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="idx" type="int" /> + <argument index="1" name="enable" type="bool" /> <description> Sets whether the tooltip hint is enabled for specified item index. </description> </method> <method name="sort_items_by_text"> - <return type="void"> - </return> + <return type="void" /> <description> Sorts items in the list by their text. </description> @@ -484,7 +375,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="Vector2" setter="set_fixed_icon_size" getter="get_fixed_icon_size" default="Vector2(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> @@ -512,20 +403,20 @@ <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="0"> + Sets the clipping behavior when the text exceeds an item's bounding rectangle. See [enum TextParagraph.OverrunBehavior] for a description of all modes. + </member> </members> <signals> <signal name="item_activated"> - <argument index="0" name="index" type="int"> - </argument> + <argument 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_rmb_selected"> - <argument index="0" name="index" type="int"> - </argument> - <argument index="1" name="at_position" type="Vector2"> - </argument> + <argument index="0" name="index" type="int" /> + <argument index="1" name="at_position" type="Vector2" /> <description> 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. @@ -533,18 +424,15 @@ </description> </signal> <signal name="item_selected"> - <argument index="0" name="index" type="int"> - </argument> + <argument 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> - <argument index="1" name="selected" type="bool"> - </argument> + <argument index="0" name="index" type="int" /> + <argument index="1" name="selected" type="bool" /> <description> Triggered when a multiple selection is altered on a list allowing multiple selection. </description> @@ -555,8 +443,7 @@ </description> </signal> <signal name="rmb_clicked"> - <argument index="0" name="at_position" type="Vector2"> - </argument> + <argument index="0" name="at_position" type="Vector2" /> <description> Triggered when a right mouse click is issued within the rect of the list but on empty space. [member allow_rmb_select] must be enabled. @@ -578,55 +465,55 @@ </constant> </constants> <theme_items> - <theme_item name="bg" type="StyleBox"> + <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" type="StyleBox"> + <theme_item name="bg_focus" data_type="style" type="StyleBox"> [StyleBox] used when the [ItemList] is being focused. </theme_item> - <theme_item name="cursor" type="StyleBox"> + <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" type="StyleBox"> + <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="font" type="Font"> + <theme_item name="font" data_type="font" type="Font"> [Font] of the item's text. </theme_item> - <theme_item name="font_color" type="Color" default="Color( 0.63, 0.63, 0.63, 1 )"> + <theme_item name="font_color" data_type="color" type="Color" default="Color(0.63, 0.63, 0.63, 1)"> Default text [Color] of the item. </theme_item> - <theme_item name="font_outline_color" type="Color" default="Color( 1, 1, 1, 1 )"> + <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> The tint of text outline of the item. </theme_item> - <theme_item name="font_selected_color" type="Color" default="Color( 1, 1, 1, 1 )"> + <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="font_size" type="int"> + <theme_item name="font_size" data_type="font_size" type="int"> Font size of the item's text. </theme_item> - <theme_item name="guide_color" type="Color" default="Color( 0, 0, 0, 0.1 )"> + <theme_item name="guide_color" data_type="color" type="Color" default="Color(0, 0, 0, 0.1)"> [Color] of the guideline. The guideline is a line drawn between each row of items. </theme_item> - <theme_item name="hseparation" type="int" default="4"> + <theme_item name="hseparation" data_type="constant" type="int" default="4"> The horizontal spacing between items. </theme_item> - <theme_item name="icon_margin" type="int" default="4"> + <theme_item name="icon_margin" data_type="constant" type="int" default="4"> The spacing between item's icon and text. </theme_item> - <theme_item name="line_separation" type="int" default="2"> + <theme_item name="line_separation" data_type="constant" type="int" default="2"> The vertical spacing between each line of text. </theme_item> - <theme_item name="outline_size" type="int" default="0"> + <theme_item name="outline_size" data_type="constant" type="int" default="0"> The size of the item text outline. </theme_item> - <theme_item name="selected" type="StyleBox"> + <theme_item name="selected" data_type="style" type="StyleBox"> [StyleBox] for the selected items, used when the [ItemList] is not being focused. </theme_item> - <theme_item name="selected_focus" type="StyleBox"> + <theme_item name="selected_focus" data_type="style" type="StyleBox"> [StyleBox] for the selected items, used when the [ItemList] is being focused. </theme_item> - <theme_item name="vseparation" type="int" default="2"> + <theme_item name="vseparation" data_type="constant" type="int" default="2"> The vertical spacing between items. </theme_item> </theme_items> |