godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (c09d83010)

Browse Source
This commit is contained in:
Rémi Verschelde
2022-06-08 13:39:15 +02:00
parent 869830c6ba
commit 8d5cdb0c7a
304 changed files with 12946 additions and 5236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
classes/class_filedialog.rst
View File

@@ -24,11 +24,11 @@ Properties
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`Access<enum_FileDialog_Access>` | :ref:`access<class_FileDialog_property_access>` | ``0`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_dir<class_FileDialog_property_current_dir>` | ``"res://"`` |
| :ref:`String<class_String>` | :ref:`current_dir<class_FileDialog_property_current_dir>` | |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_file<class_FileDialog_property_current_file>` | ``""`` |
| :ref:`String<class_String>` | :ref:`current_file<class_FileDialog_property_current_file>` | |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_path<class_FileDialog_property_current_path>` | ``"res://"`` |
| :ref:`String<class_String>` | :ref:`current_path<class_FileDialog_property_current_path>` | |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog<class_AcceptDialog_property_dialog_hide_on_ok>`) |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
@@ -63,27 +63,27 @@ Methods
Theme Properties
----------------
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Color<class_Color>` | :ref:`file_icon_modulate<class_FileDialog_theme_color_file_icon_modulate>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Color<class_Color>` | :ref:`files_disabled<class_FileDialog_theme_color_files_disabled>` | ``Color(0, 0, 0, 0.7)`` |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Color<class_Color>` | :ref:`folder_icon_modulate<class_FileDialog_theme_color_folder_icon_modulate>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`back_folder<class_FileDialog_theme_icon_back_folder>` | |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`file<class_FileDialog_theme_icon_file>` | |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folder<class_FileDialog_theme_icon_folder>` | |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`forward_folder<class_FileDialog_theme_icon_forward_folder>` | |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`parent_folder<class_FileDialog_theme_icon_parent_folder>` | |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`reload<class_FileDialog_theme_icon_reload>` | |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`toggle_hidden<class_FileDialog_theme_icon_toggle_hidden>` | |
+-----------------------------------+--------------------------------------------------------------------------------+-------------------------+
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`file_icon_modulate<class_FileDialog_theme_color_file_icon_modulate>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`files_disabled<class_FileDialog_theme_color_files_disabled>` | ``Color(1, 1, 1, 0.25)`` |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`folder_icon_modulate<class_FileDialog_theme_color_folder_icon_modulate>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`back_folder<class_FileDialog_theme_icon_back_folder>` | |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`file<class_FileDialog_theme_icon_file>` | |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folder<class_FileDialog_theme_icon_folder>` | |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`forward_folder<class_FileDialog_theme_icon_forward_folder>` | |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`parent_folder<class_FileDialog_theme_icon_parent_folder>` | |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`reload<class_FileDialog_theme_icon_reload>` | |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`toggle_hidden<class_FileDialog_theme_icon_toggle_hidden>` | |
+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+
Signals
-------
@@ -180,13 +180,11 @@ The file system access scope. See enum ``Access`` constants.
- :ref:`String<class_String>` **current_dir**
+-----------+------------------------+
| *Default* | ``"res://"`` |
+-----------+------------------------+
| *Setter* | set_current_dir(value) |
+-----------+------------------------+
| *Getter* | get_current_dir() |
+-----------+------------------------+
+----------+------------------------+
| *Setter* | set_current_dir(value) |
+----------+------------------------+
| *Getter* | get_current_dir() |
+----------+------------------------+
The current working directory of the file dialog.
@@ -196,13 +194,11 @@ The current working directory of the file dialog.
- :ref:`String<class_String>` **current_file**
+-----------+-------------------------+
| *Default* | ``""`` |
+-----------+-------------------------+
| *Setter* | set_current_file(value) |
+-----------+-------------------------+
| *Getter* | get_current_file() |
+-----------+-------------------------+
+----------+-------------------------+
| *Setter* | set_current_file(value) |
+----------+-------------------------+
| *Getter* | get_current_file() |
+----------+-------------------------+
The currently selected file of the file dialog.
@@ -212,13 +208,11 @@ The currently selected file of the file dialog.
- :ref:`String<class_String>` **current_path**
+-----------+-------------------------+
| *Default* | ``"res://"`` |
+-----------+-------------------------+
| *Setter* | set_current_path(value) |
+-----------+-------------------------+
| *Getter* | get_current_path() |
+-----------+-------------------------+
+----------+-------------------------+
| *Setter* | set_current_path(value) |
+----------+-------------------------+
| *Getter* | get_current_path() |
+----------+-------------------------+
The currently selected file path of the file dialog.
@@ -362,9 +356,9 @@ The color modulation applied to the file icon.
- :ref:`Color<class_Color>` **files_disabled**
+-----------+-------------------------+
| *Default* | ``Color(0, 0, 0, 0.7)`` |
+-----------+-------------------------+
+-----------+--------------------------+
| *Default* | ``Color(1, 1, 1, 0.25)`` |
+-----------+--------------------------+
The color tint for disabled files (when the ``FileDialog`` is used in open folder mode).