Sync classref with current source

This commit is contained in:
Rémi Verschelde
2018-09-21 09:49:38 +02:00
parent df6316f918
commit ce0bb7b277
494 changed files with 7138 additions and 7027 deletions

View File

@@ -170,96 +170,96 @@ Theme Properties
Signals
-------
.. _class_Tree_button_pressed:
.. _class_Tree_button_pressed:
- **button_pressed** **(** :ref:`TreeItem<class_TreeItem>` item, :ref:`int<class_int>` column, :ref:`int<class_int>` id **)**
Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button<class_TreeItem_add_button>`).
.. _class_Tree_cell_selected:
.. _class_Tree_cell_selected:
- **cell_selected** **(** **)**
Emitted when a cell is selected.
.. _class_Tree_column_title_pressed:
.. _class_Tree_column_title_pressed:
- **column_title_pressed** **(** :ref:`int<class_int>` column **)**
Emitted when a column's title is pressed.
.. _class_Tree_custom_popup_edited:
.. _class_Tree_custom_popup_edited:
- **custom_popup_edited** **(** :ref:`bool<class_bool>` arrow_clicked **)**
Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited.
.. _class_Tree_empty_tree_rmb_selected:
.. _class_Tree_empty_tree_rmb_selected:
- **empty_tree_rmb_selected** **(** :ref:`Vector2<class_Vector2>` position **)**
Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty.
.. _class_Tree_item_activated:
.. _class_Tree_item_activated:
- **item_activated** **(** **)**
Emitted when an item's label is double-clicked.
.. _class_Tree_item_collapsed:
.. _class_Tree_item_collapsed:
- **item_collapsed** **(** :ref:`TreeItem<class_TreeItem>` item **)**
Emitted when an item is collapsed by a click on the folding arrow.
.. _class_Tree_item_custom_button_pressed:
.. _class_Tree_item_custom_button_pressed:
- **item_custom_button_pressed** **(** **)**
.. _class_Tree_item_double_clicked:
.. _class_Tree_item_double_clicked:
- **item_double_clicked** **(** **)**
Emitted when an item's icon is double-clicked.
.. _class_Tree_item_edited:
.. _class_Tree_item_edited:
- **item_edited** **(** **)**
Emitted when an item is edited.
.. _class_Tree_item_rmb_edited:
.. _class_Tree_item_rmb_edited:
- **item_rmb_edited** **(** **)**
Emitted when an item is edited using the right mouse button.
.. _class_Tree_item_rmb_selected:
.. _class_Tree_item_rmb_selected:
- **item_rmb_selected** **(** :ref:`Vector2<class_Vector2>` position **)**
Emitted when an item is selected with right mouse button.
.. _class_Tree_item_selected:
.. _class_Tree_item_selected:
- **item_selected** **(** **)**
Emitted when an item is selected with right mouse button.
.. _class_Tree_multi_selected:
.. _class_Tree_multi_selected:
- **multi_selected** **(** :ref:`TreeItem<class_TreeItem>` item, :ref:`int<class_int>` column, :ref:`bool<class_bool>` selected **)**
Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``.
.. _class_Tree_nothing_selected:
.. _class_Tree_nothing_selected:
- **nothing_selected** **(** **)**
Enumerations
------------
.. _enum_Tree_DropModeFlags:
.. _enum_Tree_DropModeFlags:
enum **DropModeFlags**:
@@ -267,7 +267,7 @@ enum **DropModeFlags**:
- **DROP_MODE_ON_ITEM** = **1**
- **DROP_MODE_INBETWEEN** = **2**
.. _enum_Tree_SelectMode:
.. _enum_Tree_SelectMode:
enum **SelectMode**:
@@ -296,7 +296,7 @@ Trees are built via code, using :ref:`TreeItem<class_TreeItem>` objects to creat
Property Descriptions
---------------------
.. _class_Tree_allow_reselect:
.. _class_Tree_allow_reselect:
- :ref:`bool<class_bool>` **allow_reselect**
@@ -308,7 +308,7 @@ Property Descriptions
If ``true`` the currently selected cell may be selected again.
.. _class_Tree_allow_rmb_select:
.. _class_Tree_allow_rmb_select:
- :ref:`bool<class_bool>` **allow_rmb_select**
@@ -320,7 +320,7 @@ If ``true`` the currently selected cell may be selected again.
If ``true`` a right mouse button click can select items.
.. _class_Tree_columns:
.. _class_Tree_columns:
- :ref:`int<class_int>` **columns**
@@ -332,7 +332,7 @@ If ``true`` a right mouse button click can select items.
The amount of columns.
.. _class_Tree_drop_mode_flags:
.. _class_Tree_drop_mode_flags:
- :ref:`int<class_int>` **drop_mode_flags**
@@ -344,7 +344,7 @@ The amount of columns.
The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once dropping is done, reverts to ``DROP_MODE_DISABLED``. Setting this during :ref:`can_drop_data<class_Tree_can_drop_data>` is recommended.
.. _class_Tree_hide_folding:
.. _class_Tree_hide_folding:
- :ref:`bool<class_bool>` **hide_folding**
@@ -356,7 +356,7 @@ The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once
If ``true`` the folding arrow is hidden.
.. _class_Tree_hide_root:
.. _class_Tree_hide_root:
- :ref:`bool<class_bool>` **hide_root**
@@ -368,7 +368,7 @@ If ``true`` the folding arrow is hidden.
If ``true`` the tree's root is hidden.
.. _class_Tree_select_mode:
.. _class_Tree_select_mode:
- :ref:`SelectMode<enum_Tree_SelectMode>` **select_mode**
@@ -383,55 +383,55 @@ Allow single or multiple selection. See the ``SELECT_*`` constants.
Method Descriptions
-------------------
.. _class_Tree_are_column_titles_visible:
.. _class_Tree_are_column_titles_visible:
- :ref:`bool<class_bool>` **are_column_titles_visible** **(** **)** const
Returns ``true`` if the column titles are being shown.
.. _class_Tree_clear:
.. _class_Tree_clear:
- void **clear** **(** **)**
Clears the tree. This removes all items.
.. _class_Tree_create_item:
.. _class_Tree_create_item:
- :ref:`TreeItem<class_TreeItem>` **create_item** **(** :ref:`Object<class_Object>` parent=null, :ref:`int<class_int>` idx=-1 **)**
Create an item in the tree and add it as the last child of ``parent``. 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.
.. _class_Tree_ensure_cursor_is_visible:
.. _class_Tree_ensure_cursor_is_visible:
- void **ensure_cursor_is_visible** **(** **)**
Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible.
.. _class_Tree_get_column_at_position:
.. _class_Tree_get_column_at_position:
- :ref:`int<class_int>` **get_column_at_position** **(** :ref:`Vector2<class_Vector2>` position **)** const
Returns the column index under the given point.
.. _class_Tree_get_column_title:
.. _class_Tree_get_column_title:
- :ref:`String<class_String>` **get_column_title** **(** :ref:`int<class_int>` column **)** const
Returns the column's title.
.. _class_Tree_get_column_width:
.. _class_Tree_get_column_width:
- :ref:`int<class_int>` **get_column_width** **(** :ref:`int<class_int>` column **)** const
Returns the column's width in pixels.
.. _class_Tree_get_custom_popup_rect:
.. _class_Tree_get_custom_popup_rect:
- :ref:`Rect2<class_Rect2>` **get_custom_popup_rect** **(** **)** const
Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode<class_TreeItem_set_cell_mode>`.
.. _class_Tree_get_drop_section_at_position:
.. _class_Tree_get_drop_section_at_position:
- :ref:`int<class_int>` **get_drop_section_at_position** **(** :ref:`Vector2<class_Vector2>` position **)** const
@@ -439,85 +439,85 @@ If :ref:`drop_mode_flags<class_Tree_drop_mode_flags>` includes ``DROP_MODE_INBET
Otherwise, returns 0. If there are no tree item at ``position``, returns -100.
.. _class_Tree_get_edited:
.. _class_Tree_get_edited:
- :ref:`TreeItem<class_TreeItem>` **get_edited** **(** **)** const
Returns the currently edited item. This is only available for custom cell mode.
.. _class_Tree_get_edited_column:
.. _class_Tree_get_edited_column:
- :ref:`int<class_int>` **get_edited_column** **(** **)** const
Returns the column for the currently edited item. This is only available for custom cell mode.
.. _class_Tree_get_item_area_rect:
.. _class_Tree_get_item_area_rect:
- :ref:`Rect2<class_Rect2>` **get_item_area_rect** **(** :ref:`Object<class_Object>` item, :ref:`int<class_int>` column=-1 **)** const
Returns the rectangle area for the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns.
.. _class_Tree_get_item_at_position:
.. _class_Tree_get_item_at_position:
- :ref:`TreeItem<class_TreeItem>` **get_item_at_position** **(** :ref:`Vector2<class_Vector2>` position **)** const
Returns the tree item at the specified position (relative to the tree origin position).
.. _class_Tree_get_next_selected:
.. _class_Tree_get_next_selected:
- :ref:`TreeItem<class_TreeItem>` **get_next_selected** **(** :ref:`Object<class_Object>` from **)**
Returns the next selected item after the given one.
.. _class_Tree_get_pressed_button:
.. _class_Tree_get_pressed_button:
- :ref:`int<class_int>` **get_pressed_button** **(** **)** const
Returns the last pressed button's index.
.. _class_Tree_get_root:
.. _class_Tree_get_root:
- :ref:`TreeItem<class_TreeItem>` **get_root** **(** **)**
Returns the tree's root item.
.. _class_Tree_get_scroll:
.. _class_Tree_get_scroll:
- :ref:`Vector2<class_Vector2>` **get_scroll** **(** **)** const
Returns the current scrolling position.
.. _class_Tree_get_selected:
.. _class_Tree_get_selected:
- :ref:`TreeItem<class_TreeItem>` **get_selected** **(** **)** const
Returns the currently selected item.
.. _class_Tree_get_selected_column:
.. _class_Tree_get_selected_column:
- :ref:`int<class_int>` **get_selected_column** **(** **)** const
Returns the current selection's column.
.. _class_Tree_set_column_expand:
.. _class_Tree_set_column_expand:
- void **set_column_expand** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand **)**
If ``true`` the column will have the "Expand" flag of :ref:`Control<class_Control>`.
.. _class_Tree_set_column_min_width:
.. _class_Tree_set_column_min_width:
- void **set_column_min_width** **(** :ref:`int<class_int>` column, :ref:`int<class_int>` min_width **)**
Set the minimum width of a column.
.. _class_Tree_set_column_title:
.. _class_Tree_set_column_title:
- void **set_column_title** **(** :ref:`int<class_int>` column, :ref:`String<class_String>` title **)**
Set the title of a column.
.. _class_Tree_set_column_titles_visible:
.. _class_Tree_set_column_titles_visible:
- void **set_column_titles_visible** **(** :ref:`bool<class_bool>` visible **)**