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.xml70
1 files changed, 35 insertions, 35 deletions
diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml
index aa287b1ed0..416a9eb656 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">
@@ -93,7 +93,7 @@
</argument>
<description>
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 item at [code]position[/code], returns -100.
+ 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">
@@ -218,26 +218,26 @@
</method>
</methods>
<members>
- <member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect">
+ <member name="allow_reselect" type="bool" setter="set_allow_reselect" getter="get_allow_reselect" default="false">
If [code]true[/code], the currently selected cell may be selected again.
</member>
- <member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select">
+ <member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select" default="false">
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.
+ <member name="columns" type="int" setter="set_columns" getter="get_columns" default="1">
+ The number of columns.
</member>
- <member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags">
+ <member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags" default="0">
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">
+ <member name="hide_folding" type="bool" setter="set_hide_folding" getter="is_folding_hidden" default="false">
If [code]true[/code], the folding arrow is hidden.
</member>
- <member name="hide_root" type="bool" setter="set_hide_root" getter="is_root_hidden">
+ <member name="hide_root" type="bool" setter="set_hide_root" getter="is_root_hidden" default="false">
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.
+ <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode" default="0">
+ Allows single or multiple selection. See the [code]SELECT_*[/code] constants.
</member>
</members>
<signals>
@@ -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 [constant SELECT_MULTI].
+ 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>
@@ -368,7 +368,7 @@
</theme_item>
<theme_item name="bg_focus" type="StyleBox">
</theme_item>
- <theme_item name="button_margin" type="int">
+ <theme_item name="button_margin" type="int" default="4">
</theme_item>
<theme_item name="button_pressed" type="StyleBox">
</theme_item>
@@ -376,43 +376,43 @@
</theme_item>
<theme_item name="cursor" type="StyleBox">
</theme_item>
- <theme_item name="cursor_color" type="Color">
+ <theme_item name="cursor_color" type="Color" default="Color( 0, 0, 0, 1 )">
</theme_item>
<theme_item name="cursor_unfocused" type="StyleBox">
</theme_item>
<theme_item name="custom_button" type="StyleBox">
</theme_item>
- <theme_item name="custom_button_font_highlight" type="Color">
+ <theme_item name="custom_button_font_highlight" type="Color" default="Color( 0.941176, 0.941176, 0.941176, 1 )">
</theme_item>
<theme_item name="custom_button_hover" type="StyleBox">
</theme_item>
<theme_item name="custom_button_pressed" type="StyleBox">
</theme_item>
- <theme_item name="draw_guides" type="int">
+ <theme_item name="draw_guides" type="int" default="1">
</theme_item>
- <theme_item name="draw_relationship_lines" type="int">
+ <theme_item name="draw_relationship_lines" type="int" default="0">
</theme_item>
- <theme_item name="drop_position_color" type="Color">
+ <theme_item name="drop_position_color" type="Color" default="Color( 1, 0.3, 0.2, 1 )">
</theme_item>
<theme_item name="font" type="Font">
</theme_item>
- <theme_item name="font_color" type="Color">
+ <theme_item name="font_color" type="Color" default="Color( 0.690196, 0.690196, 0.690196, 1 )">
</theme_item>
- <theme_item name="font_color_selected" type="Color">
+ <theme_item name="font_color_selected" type="Color" default="Color( 1, 1, 1, 1 )">
</theme_item>
- <theme_item name="guide_color" type="Color">
+ <theme_item name="guide_color" type="Color" default="Color( 0, 0, 0, 0.1 )">
</theme_item>
- <theme_item name="guide_width" type="int">
+ <theme_item name="guide_width" type="int" default="2">
</theme_item>
- <theme_item name="hseparation" type="int">
+ <theme_item name="hseparation" type="int" default="4">
</theme_item>
- <theme_item name="item_margin" type="int">
+ <theme_item name="item_margin" type="int" default="12">
</theme_item>
- <theme_item name="relationship_line_color" type="Color">
+ <theme_item name="relationship_line_color" type="Color" default="Color( 0.27451, 0.27451, 0.27451, 1 )">
</theme_item>
- <theme_item name="scroll_border" type="int">
+ <theme_item name="scroll_border" type="int" default="4">
</theme_item>
- <theme_item name="scroll_speed" type="int">
+ <theme_item name="scroll_speed" type="int" default="12">
</theme_item>
<theme_item name="select_arrow" type="Texture">
</theme_item>
@@ -420,9 +420,9 @@
</theme_item>
<theme_item name="selected_focus" type="StyleBox">
</theme_item>
- <theme_item name="selection_color" type="Color">
+ <theme_item name="selection_color" type="Color" default="Color( 0.1, 0.1, 1, 0.8 )">
</theme_item>
- <theme_item name="title_button_color" type="Color">
+ <theme_item name="title_button_color" type="Color" default="Color( 0.878431, 0.878431, 0.878431, 1 )">
</theme_item>
<theme_item name="title_button_font" type="Font">
</theme_item>
@@ -436,7 +436,7 @@
</theme_item>
<theme_item name="updown" type="Texture">
</theme_item>
- <theme_item name="vseparation" type="int">
+ <theme_item name="vseparation" type="int" default="4">
</theme_item>
</theme_items>
</class>