godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ItemList.xml

426 lines
13 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
3.0.7-devel Onwards my precious!
2018-07-31 18:13:10 +00:00
<class name="ItemList" inherits="Control" category="Core" version="3.0.7">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns.
</brief_description>
<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).
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="add_icon_item">
<return type="void">
</return>
<argument index="0" name="icon" type="Texture">
</argument>
<argument index="1" name="selectable" type="bool" default="true">
</argument>
<description>
Adds an item to the item list with no text, only an icon.
</description>
</method>
<method name="add_item">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
<argument index="1" name="icon" type="Texture" default="null">
</argument>
<argument index="2" name="selectable" type="bool" default="true">
</argument>
<description>
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes (cherry picked from commit eaac1e3b81e3c330a23183c6638dfd08efbf427d)
2018-09-22 21:50:45 +00:00
Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
If selectable is true the list item will be selectable.
</description>
</method>
<method name="clear">
<return type="void">
</return>
<description>
Remove all items from the list.
</description>
</method>
<method name="ensure_current_is_visible">
<return type="void">
</return>
<description>
Ensure selection is visible, adjusting the scroll position as necessary.
</description>
</method>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<method name="get_item_at_position" qualifiers="const">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="int">
</return>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="0" name="position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="1" name="exact" type="bool" default="false">
</argument>
<description>
Given a position within the control return the item (if any) at that point.
</description>
</method>
<method name="get_item_count" qualifiers="const">
<return type="int">
</return>
<description>
Return count of items currently in the item list.
</description>
</method>
<method name="get_item_custom_bg_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_item_icon" qualifiers="const">
<return type="Texture">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_item_icon_region" qualifiers="const">
<return type="Rect2">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_item_metadata" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_item_text" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the text for specified item index.
</description>
</method>
<method name="get_item_tooltip" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return tooltip hint for specified item index.
</description>
</method>
<method name="get_selected_items">
<return type="PoolIntArray">
</return>
<description>
Returns the list of selected indexes.
</description>
</method>
<method name="get_v_scroll">
<return type="VScrollBar">
</return>
<description>
Returns the current vertical scroll bar for the List.
</description>
</method>
<method name="is_item_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns whether or not the item at the specified index is disabled
</description>
</method>
<method name="is_item_selectable" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns whether or not 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>
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Returns whether the tooltip is enabled for specified item index.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_selected" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns whether or not item at the specified index is currently selected.
</description>
</method>
<method name="remove_item">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Remove item at specified 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>
<description>
Select the item at the specified index.
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes (cherry picked from commit eaac1e3b81e3c330a23183c6638dfd08efbf427d)
2018-09-22 21:50:45 +00:00
Note: This method does not trigger the item selection signal.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
<description>
</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>
<description>
Disable (or enable) item at specified index.
Disabled items are not be selectable and do not fire activation (Enter or double-click) signals.
</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="Texture">
</argument>
<description>
Set (or replace) icon of the item at 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>
<description>
</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>
<description>
Sets a value (of any type) to be stored with the item at the specified index.
</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>
<description>
Allow or disallow selection of the item at 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>
<description>
Sets text of item at specified index.
</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>
<description>
Sets tooltip hint for item at 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>
<description>
Sets whether the tooltip is enabled for specified item index.
</description>
</method>
<method name="sort_items_by_text">
<return type="void">
</return>
<description>
Sorts items in the list by their text.
</description>
</method>
<method name="unselect">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Ensure item at specified index is not selected.
</description>
</method>
</methods>
<members>
Added "allow_reselect" property to ItemList and enabled it for the method/help lists. (cherry picked from commit 4dbf6ac1b890ff6333d1600d2c091baa176b356c)
2018-02-14 03:24:57 +00:00
<member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect">
If [code]true[/code] the currently selected item may be selected again.
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select">
Added "allow_reselect" property to ItemList and enabled it for the method/help lists. (cherry picked from commit 4dbf6ac1b890ff6333d1600d2c091baa176b356c)
2018-02-14 03:24:57 +00:00
If [code]true[/code] a right mouse button click can select items.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="auto_height" type="bool" setter="set_auto_height" getter="has_auto_height">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="fixed_column_width" type="int" setter="set_fixed_column_width" getter="get_fixed_column_width">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<member name="fixed_icon_size" type="Vector2" setter="set_fixed_icon_size" getter="get_fixed_icon_size">
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="icon_mode" type="int" setter="set_icon_mode" getter="get_icon_mode" enum="ItemList.IconMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="max_columns" type="int" setter="set_max_columns" getter="get_max_columns">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="max_text_lines" type="int" setter="set_max_text_lines" getter="get_max_text_lines">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="same_column_width" type="bool" setter="set_same_column_width" getter="is_same_column_width">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="ItemList.SelectMode">
Added "allow_reselect" property to ItemList and enabled it for the method/help lists. (cherry picked from commit 4dbf6ac1b890ff6333d1600d2c091baa176b356c)
2018-02-14 03:24:57 +00:00
Allow single or multiple selection. See the [code]SELECT_*[/code] constants.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals>
<signal name="item_activated">
<argument index="0" name="index" type="int">
</argument>
<description>
Fired when specified list item is activated via double click or Enter.
</description>
</signal>
<signal name="item_rmb_selected">
<argument index="0" name="index" type="int">
</argument>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="1" name="at_position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Fired 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.
ItemList signals additional documentation Signals: * item_selected * item_rmb_select (cherry picked from commit 65d182a939491013bfc5e4ad0a6a61d521e11498)
2018-10-03 11:58:21 +00:00
[member allow_rmb_select] must be enabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name="item_selected">
<argument index="0" name="index" type="int">
</argument>
<description>
Fired when specified item has been selected.
ItemList signals additional documentation Signals: * item_selected * item_rmb_select (cherry picked from commit 65d182a939491013bfc5e4ad0a6a61d521e11498)
2018-10-03 11:58:21 +00:00
[member allow_reselect] must be enabled to reselect an item.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name="multi_selected">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="selected" type="bool">
</argument>
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Fired when a multiple selection is altered on a list allowing multiple selection.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
doc: Sync classref with current source
2017-11-27 22:37:47 +00:00
<signal name="nothing_selected">
<description>
</description>
</signal>
doc: Sync classref with current source
2017-11-24 08:16:27 +00:00
<signal name="rmb_clicked">
<argument index="0" name="at_position" type="Vector2">
</argument>
<description>
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="ICON_MODE_TOP" value="0" enum="IconMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="ICON_MODE_LEFT" value="1" enum="IconMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SELECT_SINGLE" value="0" enum="SelectMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SELECT_MULTI" value="1" enum="SelectMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
<theme_items>
<theme_item name="bg" type="StyleBox">
</theme_item>
<theme_item name="bg_focus" type="StyleBox">
</theme_item>
<theme_item name="cursor" type="StyleBox">
</theme_item>
<theme_item name="cursor_unfocused" type="StyleBox">
</theme_item>
<theme_item name="font" type="Font">
</theme_item>
<theme_item name="font_color" type="Color">
</theme_item>
<theme_item name="font_color_selected" type="Color">
</theme_item>
<theme_item name="guide_color" type="Color">
</theme_item>
<theme_item name="hseparation" type="int">
</theme_item>
<theme_item name="icon_margin" type="int">
</theme_item>
<theme_item name="line_separation" type="int">
</theme_item>
<theme_item name="selected" type="StyleBox">
</theme_item>
<theme_item name="selected_focus" type="StyleBox">
</theme_item>
<theme_item name="vseparation" type="int">
</theme_item>
</theme_items>
</class>