godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
045efee3ee4cf120ad9b726f6df7c562cb135aeb
godot-docs/classes/class_filedialog.rst
Godot Organization 045efee3ee classref: Sync with current master branch (8e951fd)
2024-03-01 16:12:44 +00:00

782 lines
35 KiB
ReStructuredText
Raw Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FileDialog.xml.
.. _class_FileDialog:
FileDialog
==========
**Inherits:** :ref:`ConfirmationDialog<class_ConfirmationDialog>` **<** :ref:`AcceptDialog<class_AcceptDialog>` **<** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
A dialog for selecting files or directories in the filesystem.
.. rst-class:: classref-introduction-group
Description
-----------
**FileDialog** is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. **FileDialog** automatically sets its window title according to the :ref:`file_mode<class_FileDialog_property_file_mode>`. If you want to use a custom title, disable this by setting :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` to ``false``.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`Access<enum_FileDialog_Access>` | :ref:`access<class_FileDialog_property_access>` | ``0`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :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_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>`) |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`FileMode<enum_FileDialog_FileMode>` | :ref:`file_mode<class_FileDialog_property_file_mode>` | ``4`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`filters<class_FileDialog_property_filters>` | ``PackedStringArray()`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` | ``true`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`option_count<class_FileDialog_property_option_count>` | ``0`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`root_subfolder<class_FileDialog_property_root_subfolder>` | ``""`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`show_hidden_files<class_FileDialog_property_show_hidden_files>` | ``false`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | title | ``"Save a File"`` (overrides :ref:`Window<class_Window_property_title>`) |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_native_dialog<class_FileDialog_property_use_native_dialog>` | ``false`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_filter<class_FileDialog_method_add_filter>`\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_option<class_FileDialog_method_add_option>`\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, index\: :ref:`int<class_int>`\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_filters<class_FileDialog_method_clear_filters>`\ (\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`deselect_all<class_FileDialog_method_deselect_all>`\ (\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_FileDialog_method_get_line_edit>`\ (\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_option_default<class_FileDialog_method_get_option_default>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_option_name<class_FileDialog_method_get_option_name>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_option_values<class_FileDialog_method_get_option_values>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_selected_options<class_FileDialog_method_get_selected_options>`\ (\ ) |const| |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_FileDialog_method_get_vbox>`\ (\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`invalidate<class_FileDialog_method_invalidate>`\ (\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_option_default<class_FileDialog_method_set_option_default>`\ (\ option\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_option_name<class_FileDialog_method_set_option_name>`\ (\ option\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_option_values<class_FileDialog_method_set_option_values>`\ (\ option\: :ref:`int<class_int>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Theme Properties
----------------
.. table::
:widths: auto
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`file_disabled_color<class_FileDialog_theme_color_file_disabled_color>` | ``Color(1, 1, 1, 0.25)`` |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`file_icon_color<class_FileDialog_theme_color_file_icon_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`folder_icon_color<class_FileDialog_theme_color_folder_icon_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`back_folder<class_FileDialog_theme_icon_back_folder>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`create_folder<class_FileDialog_theme_icon_create_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>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signals
-------
.. _class_FileDialog_signal_dir_selected:
.. rst-class:: classref-signal
**dir_selected**\ (\ dir\: :ref:`String<class_String>`\ )
Emitted when the user selects a directory.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_signal_file_selected:
.. rst-class:: classref-signal
**file_selected**\ (\ path\: :ref:`String<class_String>`\ )
Emitted when the user selects a file by double-clicking it or pressing the **OK** button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_signal_files_selected:
.. rst-class:: classref-signal
**files_selected**\ (\ paths\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
Emitted when the user selects multiple files.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_FileDialog_FileMode:
.. rst-class:: classref-enumeration
enum **FileMode**:
.. _class_FileDialog_constant_FILE_MODE_OPEN_FILE:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_OPEN_FILE** = ``0``
The dialog allows selecting one, and only one file.
.. _class_FileDialog_constant_FILE_MODE_OPEN_FILES:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_OPEN_FILES** = ``1``
The dialog allows selecting multiple files.
.. _class_FileDialog_constant_FILE_MODE_OPEN_DIR:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_OPEN_DIR** = ``2``
The dialog only allows selecting a directory, disallowing the selection of any file.
.. _class_FileDialog_constant_FILE_MODE_OPEN_ANY:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_OPEN_ANY** = ``3``
The dialog allows selecting one file or directory.
.. _class_FileDialog_constant_FILE_MODE_SAVE_FILE:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_SAVE_FILE** = ``4``
The dialog will warn when a file exists.
.. rst-class:: classref-item-separator
----
.. _enum_FileDialog_Access:
.. rst-class:: classref-enumeration
enum **Access**:
.. _class_FileDialog_constant_ACCESS_RESOURCES:
.. rst-class:: classref-enumeration-constant
:ref:`Access<enum_FileDialog_Access>` **ACCESS_RESOURCES** = ``0``
The dialog only allows accessing files under the :ref:`Resource<class_Resource>` path (``res://``).
.. _class_FileDialog_constant_ACCESS_USERDATA:
.. rst-class:: classref-enumeration-constant
:ref:`Access<enum_FileDialog_Access>` **ACCESS_USERDATA** = ``1``
The dialog only allows accessing files under user data path (``user://``).
.. _class_FileDialog_constant_ACCESS_FILESYSTEM:
.. rst-class:: classref-enumeration-constant
:ref:`Access<enum_FileDialog_Access>` **ACCESS_FILESYSTEM** = ``2``
The dialog allows accessing files on the whole file system.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_FileDialog_property_access:
.. rst-class:: classref-property
:ref:`Access<enum_FileDialog_Access>` **access** = ``0``
.. rst-class:: classref-property-setget
- |void| **set_access**\ (\ value\: :ref:`Access<enum_FileDialog_Access>`\ )
- :ref:`Access<enum_FileDialog_Access>` **get_access**\ (\ )
The file system access scope. See :ref:`Access<enum_FileDialog_Access>` constants.
\ **Warning:** Currently, in sandboxed environments such as Web builds or sandboxed macOS apps, FileDialog cannot access the host file system. See `godot-proposals#1123 <https://github.com/godotengine/godot-proposals/issues/1123>`__.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_current_dir:
.. rst-class:: classref-property
:ref:`String<class_String>` **current_dir**
.. rst-class:: classref-property-setget
- |void| **set_current_dir**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_current_dir**\ (\ )
The current working directory of the file dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_current_file:
.. rst-class:: classref-property
:ref:`String<class_String>` **current_file**
.. rst-class:: classref-property-setget
- |void| **set_current_file**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_current_file**\ (\ )
The currently selected file of the file dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_current_path:
.. rst-class:: classref-property
:ref:`String<class_String>` **current_path**
.. rst-class:: classref-property-setget
- |void| **set_current_path**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_current_path**\ (\ )
The currently selected file path of the file dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_file_mode:
.. rst-class:: classref-property
:ref:`FileMode<enum_FileDialog_FileMode>` **file_mode** = ``4``
.. rst-class:: classref-property-setget
- |void| **set_file_mode**\ (\ value\: :ref:`FileMode<enum_FileDialog_FileMode>`\ )
- :ref:`FileMode<enum_FileDialog_FileMode>` **get_file_mode**\ (\ )
The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode<enum_FileDialog_FileMode>`.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_filters:
.. rst-class:: classref-property
:ref:`PackedStringArray<class_PackedStringArray>` **filters** = ``PackedStringArray()``
.. rst-class:: classref-property-setget
- |void| **set_filters**\ (\ value\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
- :ref:`PackedStringArray<class_PackedStringArray>` **get_filters**\ (\ )
The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. Multiple file types can also be specified in a single filter. ``"*.png, *.jpg, *.jpeg ; Supported Images"`` will show both PNG and JPEG files when selected.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_mode_overrides_title:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **mode_overrides_title** = ``true``
.. rst-class:: classref-property-setget
- |void| **set_mode_overrides_title**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_mode_overriding_title**\ (\ )
If ``true``, changing the :ref:`file_mode<class_FileDialog_property_file_mode>` property will set the window title accordingly (e.g. setting :ref:`file_mode<class_FileDialog_property_file_mode>` to :ref:`FILE_MODE_OPEN_FILE<class_FileDialog_constant_FILE_MODE_OPEN_FILE>` will change the window title to "Open a File").
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_option_count:
.. rst-class:: classref-property
:ref:`int<class_int>` **option_count** = ``0``
.. rst-class:: classref-property-setget
- |void| **set_option_count**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_option_count**\ (\ )
The number of additional :ref:`OptionButton<class_OptionButton>`\ s and :ref:`CheckBox<class_CheckBox>`\ es in the dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_root_subfolder:
.. rst-class:: classref-property
:ref:`String<class_String>` **root_subfolder** = ``""``
.. rst-class:: classref-property-setget
- |void| **set_root_subfolder**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_root_subfolder**\ (\ )
If non-empty, the given sub-folder will be "root" of this **FileDialog**, i.e. user won't be able to go to its parent directory.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_show_hidden_files:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_hidden_files** = ``false``
.. rst-class:: classref-property-setget
- |void| **set_show_hidden_files**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_showing_hidden_files**\ (\ )
If ``true``, the dialog will show hidden files.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_use_native_dialog:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **use_native_dialog** = ``false``
.. rst-class:: classref-property-setget
- |void| **set_use_native_dialog**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_use_native_dialog**\ (\ )
If ``true``, :ref:`access<class_FileDialog_property_access>` is set to :ref:`ACCESS_FILESYSTEM<class_FileDialog_constant_ACCESS_FILESYSTEM>`, and it is supported by the current :ref:`DisplayServer<class_DisplayServer>`, OS native dialog will be used instead of custom one.
\ **Note:** On macOS, sandboxed apps always use native dialogs to access host filesystem.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_FileDialog_method_add_filter:
.. rst-class:: classref-method
|void| **add_filter**\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ )
Adds a comma-delimited file name ``filter`` option to the **FileDialog** with an optional ``description``, which restricts what files can be picked.
A ``filter`` should be of the form ``"filename.extension"``, where filename and extension can be ``*`` to match any string. Filters starting with ``.`` (i.e. empty filenames) are not allowed.
For example, a ``filter`` of ``"*.png, *.jpg"`` and a ``description`` of ``"Images"`` results in filter text "Images (\*.png, \*.jpg)".
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_add_option:
.. rst-class:: classref-method
|void| **add_option**\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, index\: :ref:`int<class_int>`\ )
Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. If ``values`` is empty, a :ref:`CheckBox<class_CheckBox>` is added instead.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_clear_filters:
.. rst-class:: classref-method
|void| **clear_filters**\ (\ )
Clear all the added filters in the dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_deselect_all:
.. rst-class:: classref-method
|void| **deselect_all**\ (\ )
Clear all currently selected items in the dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_line_edit:
.. rst-class:: classref-method
:ref:`LineEdit<class_LineEdit>` **get_line_edit**\ (\ )
Returns the LineEdit for the selected file.
\ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_option_default:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_option_default**\ (\ option\: :ref:`int<class_int>`\ ) |const|
Returns the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_option_name:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_option_name**\ (\ option\: :ref:`int<class_int>`\ ) |const|
Returns the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_option_values:
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_option_values**\ (\ option\: :ref:`int<class_int>`\ ) |const|
Returns an array of values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_selected_options:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_selected_options**\ (\ ) |const|
Returns a :ref:`Dictionary<class_Dictionary>` with the selected values of the additional :ref:`OptionButton<class_OptionButton>`\ s and/or :ref:`CheckBox<class_CheckBox>`\ es. :ref:`Dictionary<class_Dictionary>` keys are names and values are selected value indices.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_vbox:
.. rst-class:: classref-method
:ref:`VBoxContainer<class_VBoxContainer>` **get_vbox**\ (\ )
Returns the vertical box container of the dialog, custom controls can be added to it.
\ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_invalidate:
.. rst-class:: classref-method
|void| **invalidate**\ (\ )
Invalidate and update the current dialog content list.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_option_default:
.. rst-class:: classref-method
|void| **set_option_default**\ (\ option\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ )
Sets the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_option_name:
.. rst-class:: classref-method
|void| **set_option_name**\ (\ option\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ )
Sets the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_option_values:
.. rst-class:: classref-method
|void| **set_option_values**\ (\ option\: :ref:`int<class_int>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
Sets the option values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Theme Property Descriptions
---------------------------
.. _class_FileDialog_theme_color_file_disabled_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **file_disabled_color** = ``Color(1, 1, 1, 0.25)``
The color tint for disabled files (when the **FileDialog** is used in open folder mode).
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_color_file_icon_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **file_icon_color** = ``Color(1, 1, 1, 1)``
The color modulation applied to the file icon.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_color_folder_icon_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **folder_icon_color** = ``Color(1, 1, 1, 1)``
The color modulation applied to the folder icon.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_back_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **back_folder**
Custom icon for the back arrow.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_create_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **create_folder**
Custom icon for the create folder button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_file:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **file**
Custom icon for files.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folder**
Custom icon for folders.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_forward_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **forward_folder**
Custom icon for the forward arrow.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_parent_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **parent_folder**
Custom icon for the parent folder arrow.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_reload:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **reload**
Custom icon for the reload button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_toggle_hidden:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **toggle_hidden**
Custom icon for the toggle hidden button.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`
Reference in New Issue View Git Blame Copy Permalink