summaryrefslogtreecommitdiff
path: root/doc/classes/Tree.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Tree.xml')
-rw-r--r--doc/classes/Tree.xml26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml
index 0272efeecb..70e85b187f 100644
--- a/doc/classes/Tree.xml
+++ b/doc/classes/Tree.xml
@@ -42,7 +42,7 @@
<argument index="1" name="idx" type="int" default="-1">
</argument>
<description>
- Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the root's last child, or it'll the be the root itself if the tree is empty.
+ Create an item in the tree and add it as the last child of [code]parent[/code]. If [code]parent[/code] is [code]null[/code], it will be added as the root's last child, or it'll be the the root itself if the tree is empty.
</description>
</method>
<method name="ensure_cursor_is_visible">
@@ -92,8 +92,8 @@
<argument index="0" name="position" type="Vector2">
</argument>
<description>
- If [member drop_mode_flags] includes [code]DROP_MODE_INBETWEEN[/code], returns -1 if [code]position[/code] is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if [member drop_mode_flags] includes [code]DROP_MODE_ON_ITEM[/code].
- Otherwise, returns 0. If there are no tree item at [code]position[/code], returns -100.
+ If [member drop_mode_flags] includes [constant DROP_MODE_INBETWEEN], returns -1 if [code]position[/code] is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if [member drop_mode_flags] includes [constant DROP_MODE_ON_ITEM].
+ Otherwise, returns 0. If there are no tree items at [code]position[/code], returns -100.
</description>
</method>
<method name="get_edited" qualifiers="const">
@@ -193,7 +193,7 @@
<argument index="1" name="min_width" type="int">
</argument>
<description>
- Set the minimum width of a column.
+ Sets the minimum width of a column.
</description>
</method>
<method name="set_column_title">
@@ -204,7 +204,7 @@
<argument index="1" name="title" type="String">
</argument>
<description>
- Set the title of a column.
+ Sets the title of a column.
</description>
</method>
<method name="set_column_titles_visible">
@@ -225,10 +225,10 @@
If [code]true[/code], a right mouse button click can select items.
</member>
<member name="columns" type="int" setter="set_columns" getter="get_columns">
- The amount of columns.
+ The number of columns.
</member>
<member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags">
- The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. Once dropping is done, reverts to [code]DROP_MODE_DISABLED[/code]. Setting this during [method Control.can_drop_data] is recommended.
+ The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control.can_drop_data] is recommended.
</member>
<member name="hide_folding" type="bool" setter="set_hide_folding" getter="is_folding_hidden">
If [code]true[/code], the folding arrow is hidden.
@@ -237,7 +237,7 @@
If [code]true[/code], the tree's root is hidden.
</member>
<member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode">
- Allow single or multiple selection. See the [code]SELECT_*[/code] constants.
+ Allows single or multiple selection. See the [code]SELECT_*[/code] constants.
</member>
</members>
<signals>
@@ -268,7 +268,7 @@
<argument index="0" name="arrow_clicked" type="bool">
</argument>
<description>
- Emitted when a cell with the [code]CELL_MODE_CUSTOM[/code] is clicked to be edited.
+ Emitted when a cell with the [constant TreeItem.CELL_MODE_CUSTOM] is clicked to be edited.
</description>
</signal>
<signal name="empty_rmb">
@@ -281,7 +281,7 @@
<argument index="0" name="position" type="Vector2">
</argument>
<description>
- Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty.
+ Emitted when the right mouse button is pressed if right mouse button selection is active and the tree is empty.
</description>
</signal>
<signal name="item_activated">
@@ -335,7 +335,7 @@
<argument index="2" name="selected" type="bool">
</argument>
<description>
- Emitted instead of [code]item_selected[/code] when [code]select_mode[/code] is [code]SELECT_MULTI[/code].
+ Emitted instead of [code]item_selected[/code] if [code]select_mode[/code] is [constant SELECT_MULTI].
</description>
</signal>
<signal name="nothing_selected">
@@ -345,12 +345,12 @@
</signals>
<constants>
<constant name="SELECT_SINGLE" value="0" enum="SelectMode">
- Allow selection of a single item at a time.
+ Allows selection of a single item at a time.
</constant>
<constant name="SELECT_ROW" value="1" enum="SelectMode">
</constant>
<constant name="SELECT_MULTI" value="2" enum="SelectMode">
- Allow selection of multiple items at the same time.
+ Allows selection of multiple items at the same time.
</constant>
<constant name="DROP_MODE_DISABLED" value="0" enum="DropModeFlags">
</constant>