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
master
godot-docs/classes/class_filedialog.rst
Godot Organization d45f83bf92 classref: Sync with current master branch (4b6c88d)
2025-12-15 22:19:00 +00:00

1464 lines
75 KiB
ReStructuredText
Raw Permalink 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>`
**Inherited By:** :ref:`EditorFileDialog<class_EditorFileDialog>`
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``.
\ **Note:** **FileDialog** is invisible by default. To make it visible, call one of the ``popup_*`` methods from :ref:`Window<class_Window>` on the node, such as :ref:`Window.popup_centered_clamped()<class_Window_method_popup_centered_clamped>`.
.. 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>` | :ref:`deleting_enabled<class_FileDialog_property_deleting_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog<class_AcceptDialog_property_dialog_hide_on_ok>`) |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`DisplayMode<enum_FileDialog_DisplayMode>` | :ref:`display_mode<class_FileDialog_property_display_mode>` | ``0`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`favorites_enabled<class_FileDialog_property_favorites_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`file_filter_toggle_enabled<class_FileDialog_property_file_filter_toggle_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`FileMode<enum_FileDialog_FileMode>` | :ref:`file_mode<class_FileDialog_property_file_mode>` | ``4`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`file_sort_options_enabled<class_FileDialog_property_file_sort_options_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`filename_filter<class_FileDialog_property_filename_filter>` | ``""`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`filters<class_FileDialog_property_filters>` | ``PackedStringArray()`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`folder_creation_enabled<class_FileDialog_property_folder_creation_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hidden_files_toggle_enabled<class_FileDialog_property_hidden_files_toggle_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`layout_toggle_enabled<class_FileDialog_property_layout_toggle_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :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:`bool<class_bool>` | :ref:`overwrite_warning_enabled<class_FileDialog_property_overwrite_warning_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`recent_list_enabled<class_FileDialog_property_recent_list_enabled>` | ``true`` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :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:`Vector2i<class_Vector2i>` | size | ``Vector2i(640, 360)`` (overrides :ref:`Window<class_Window_property_size>`) |
+---------------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :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>` = "", mime_type\: :ref:`String<class_String>` = ""\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_option<class_FileDialog_method_add_option>`\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, default_value_index\: :ref:`int<class_int>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_filename_filter<class_FileDialog_method_clear_filename_filter>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_filters<class_FileDialog_method_clear_filters>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`deselect_all<class_FileDialog_method_deselect_all>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_favorite_list<class_FileDialog_method_get_favorite_list>`\ (\ ) |static| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`PackedStringArray<class_PackedStringArray>` | :ref:`get_recent_list<class_FileDialog_method_get_recent_list>`\ (\ ) |static| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_customization_flag_enabled<class_FileDialog_method_is_customization_flag_enabled>`\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`popup_file_dialog<class_FileDialog_method_popup_file_dialog>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_customization_flag_enabled<class_FileDialog_method_set_customization_flag_enabled>`\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_favorite_list<class_FileDialog_method_set_favorite_list>`\ (\ favorites\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |static| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_get_icon_callback<class_FileDialog_method_set_get_icon_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`\ ) |static| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_get_thumbnail_callback<class_FileDialog_method_set_get_thumbnail_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`\ ) |static| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_option_default<class_FileDialog_method_set_option_default>`\ (\ option\: :ref:`int<class_int>`, default_value_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>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_recent_list<class_FileDialog_method_set_recent_list>`\ (\ recents\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |static| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. 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:`int<class_int>` | :ref:`thumbnail_size<class_FileDialog_theme_constant_thumbnail_size>` | ``64`` |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :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:`favorite<class_FileDialog_theme_icon_favorite>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`favorite_down<class_FileDialog_theme_icon_favorite_down>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`favorite_up<class_FileDialog_theme_icon_favorite_up>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`file<class_FileDialog_theme_icon_file>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`file_thumbnail<class_FileDialog_theme_icon_file_thumbnail>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folder<class_FileDialog_theme_icon_folder>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folder_thumbnail<class_FileDialog_theme_icon_folder_thumbnail>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`forward_folder<class_FileDialog_theme_icon_forward_folder>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`list_mode<class_FileDialog_theme_icon_list_mode>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :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:`sort<class_FileDialog_theme_icon_sort>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`thumbnail_mode<class_FileDialog_theme_icon_thumbnail_mode>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`toggle_filename_filter<class_FileDialog_theme_icon_toggle_filename_filter>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+
| :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>`\ ) :ref:`🔗<class_FileDialog_signal_dir_selected>`
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>`\ ) :ref:`🔗<class_FileDialog_signal_file_selected>`
Emitted when the user selects a file by double-clicking it or pressing the **OK** button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_signal_filename_filter_changed:
.. rst-class:: classref-signal
**filename_filter_changed**\ (\ filter\: :ref:`String<class_String>`\ ) :ref:`🔗<class_FileDialog_signal_filename_filter_changed>`
Emitted when the filter for file names changes.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_signal_files_selected:
.. rst-class:: classref-signal
**files_selected**\ (\ paths\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) :ref:`🔗<class_FileDialog_signal_files_selected>`
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**: :ref:`🔗<enum_FileDialog_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**: :ref:`🔗<enum_FileDialog_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-item-separator
----
.. _enum_FileDialog_DisplayMode:
.. rst-class:: classref-enumeration
enum **DisplayMode**: :ref:`🔗<enum_FileDialog_DisplayMode>`
.. _class_FileDialog_constant_DISPLAY_THUMBNAILS:
.. rst-class:: classref-enumeration-constant
:ref:`DisplayMode<enum_FileDialog_DisplayMode>` **DISPLAY_THUMBNAILS** = ``0``
The dialog displays files as a grid of thumbnails. Use :ref:`thumbnail_size<class_FileDialog_theme_constant_thumbnail_size>` to adjust their size.
.. _class_FileDialog_constant_DISPLAY_LIST:
.. rst-class:: classref-enumeration-constant
:ref:`DisplayMode<enum_FileDialog_DisplayMode>` **DISPLAY_LIST** = ``1``
The dialog displays files as a list of filenames.
.. rst-class:: classref-item-separator
----
.. _enum_FileDialog_Customization:
.. rst-class:: classref-enumeration
enum **Customization**: :ref:`🔗<enum_FileDialog_Customization>`
.. _class_FileDialog_constant_CUSTOMIZATION_HIDDEN_FILES:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_HIDDEN_FILES** = ``0``
Toggles visibility of the favorite button, and the favorite list on the left side of the dialog.
Equivalent to :ref:`hidden_files_toggle_enabled<class_FileDialog_property_hidden_files_toggle_enabled>`.
.. _class_FileDialog_constant_CUSTOMIZATION_CREATE_FOLDER:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_CREATE_FOLDER** = ``1``
If enabled, shows the button for creating new directories (when using :ref:`FILE_MODE_OPEN_DIR<class_FileDialog_constant_FILE_MODE_OPEN_DIR>`, :ref:`FILE_MODE_OPEN_ANY<class_FileDialog_constant_FILE_MODE_OPEN_ANY>`, or :ref:`FILE_MODE_SAVE_FILE<class_FileDialog_constant_FILE_MODE_SAVE_FILE>`).
Equivalent to :ref:`folder_creation_enabled<class_FileDialog_property_folder_creation_enabled>`.
.. _class_FileDialog_constant_CUSTOMIZATION_FILE_FILTER:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_FILE_FILTER** = ``2``
If enabled, shows the toggle file filter button.
Equivalent to :ref:`file_filter_toggle_enabled<class_FileDialog_property_file_filter_toggle_enabled>`.
.. _class_FileDialog_constant_CUSTOMIZATION_FILE_SORT:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_FILE_SORT** = ``3``
If enabled, shows the file sorting options button.
Equivalent to :ref:`file_sort_options_enabled<class_FileDialog_property_file_sort_options_enabled>`.
.. _class_FileDialog_constant_CUSTOMIZATION_FAVORITES:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_FAVORITES** = ``4``
If enabled, shows the toggle favorite button and favorite list on the left side of the dialog.
Equivalent to :ref:`favorites_enabled<class_FileDialog_property_favorites_enabled>`.
.. _class_FileDialog_constant_CUSTOMIZATION_RECENT:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_RECENT** = ``5``
If enabled, shows the recent directories list on the left side of the dialog.
Equivalent to :ref:`recent_list_enabled<class_FileDialog_property_recent_list_enabled>`.
.. _class_FileDialog_constant_CUSTOMIZATION_LAYOUT:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_LAYOUT** = ``6``
If enabled, shows the layout switch buttons (list/thumbnails).
Equivalent to :ref:`layout_toggle_enabled<class_FileDialog_property_layout_toggle_enabled>`.
.. _class_FileDialog_constant_CUSTOMIZATION_OVERWRITE_WARNING:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_OVERWRITE_WARNING** = ``7``
If enabled, the **FileDialog** will warn the user before overwriting files in save mode.
Equivalent to :ref:`overwrite_warning_enabled<class_FileDialog_property_overwrite_warning_enabled>`.
.. _class_FileDialog_constant_CUSTOMIZATION_DELETE:
.. rst-class:: classref-enumeration-constant
:ref:`Customization<enum_FileDialog_Customization>` **CUSTOMIZATION_DELETE** = ``8``
If enabled, the context menu will show the "Delete" option, which allows moving files and folders to trash.
Equivalent to :ref:`deleting_enabled<class_FileDialog_property_deleting_enabled>`.
.. 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`` :ref:`🔗<class_FileDialog_property_access>`
.. 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.
\ **Warning:** In Web builds, FileDialog cannot access the host file system. In sandboxed Linux and macOS environments, :ref:`use_native_dialog<class_FileDialog_property_use_native_dialog>` is automatically used to allow limited access to host file system.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_current_dir:
.. rst-class:: classref-property
:ref:`String<class_String>` **current_dir** :ref:`🔗<class_FileDialog_property_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.
\ **Note:** For native file dialogs, this property is only treated as a hint and may not be respected by specific OS implementations.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_current_file:
.. rst-class:: classref-property
:ref:`String<class_String>` **current_file** :ref:`🔗<class_FileDialog_property_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** :ref:`🔗<class_FileDialog_property_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_deleting_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **deleting_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_deleting_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, the context menu will show the "Delete" option, which allows moving files and folders to trash.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_display_mode:
.. rst-class:: classref-property
:ref:`DisplayMode<enum_FileDialog_DisplayMode>` **display_mode** = ``0`` :ref:`🔗<class_FileDialog_property_display_mode>`
.. rst-class:: classref-property-setget
- |void| **set_display_mode**\ (\ value\: :ref:`DisplayMode<enum_FileDialog_DisplayMode>`\ )
- :ref:`DisplayMode<enum_FileDialog_DisplayMode>` **get_display_mode**\ (\ )
Display mode of the dialog's file list.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_favorites_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **favorites_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_favorites_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, shows the toggle favorite button and favorite list on the left side of the dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_file_filter_toggle_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **file_filter_toggle_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_file_filter_toggle_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, shows the toggle file filter button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_file_mode:
.. rst-class:: classref-property
:ref:`FileMode<enum_FileDialog_FileMode>` **file_mode** = ``4`` :ref:`🔗<class_FileDialog_property_file_mode>`
.. 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.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_file_sort_options_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **file_sort_options_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_file_sort_options_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, shows the file sorting options button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_filename_filter:
.. rst-class:: classref-property
:ref:`String<class_String>` **filename_filter** = ``""`` :ref:`🔗<class_FileDialog_property_filename_filter>`
.. rst-class:: classref-property-setget
- |void| **set_filename_filter**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_filename_filter**\ (\ )
The filter for file names (case-insensitive). When set to a non-empty string, only files that contains the substring will be shown. :ref:`filename_filter<class_FileDialog_property_filename_filter>` can be edited by the user with the filter button at the top of the file dialog.
See also :ref:`filters<class_FileDialog_property_filters>`, which should be used to restrict the file types that can be selected instead of :ref:`filename_filter<class_FileDialog_property_filename_filter>` which is meant to be set by the user.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_filters:
.. rst-class:: classref-property
:ref:`PackedStringArray<class_PackedStringArray>` **filters** = ``PackedStringArray()`` :ref:`🔗<class_FileDialog_property_filters>`
.. rst-class:: classref-property-setget
- |void| **set_filters**\ (\ value\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
- :ref:`PackedStringArray<class_PackedStringArray>` **get_filters**\ (\ )
The available file type filters. Each filter string in the array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set.
\ **Note:** Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray<class_PackedStringArray>` for more details.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_folder_creation_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **folder_creation_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_folder_creation_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, shows the button for creating new directories (when using :ref:`FILE_MODE_OPEN_DIR<class_FileDialog_constant_FILE_MODE_OPEN_DIR>`, :ref:`FILE_MODE_OPEN_ANY<class_FileDialog_constant_FILE_MODE_OPEN_ANY>`, or :ref:`FILE_MODE_SAVE_FILE<class_FileDialog_constant_FILE_MODE_SAVE_FILE>`), and the context menu will have the "New Folder..." option.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_hidden_files_toggle_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **hidden_files_toggle_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_hidden_files_toggle_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, shows the toggle hidden files button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_layout_toggle_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **layout_toggle_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_layout_toggle_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, shows the layout switch buttons (list/thumbnails).
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_mode_overrides_title:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **mode_overrides_title** = ``true`` :ref:`🔗<class_FileDialog_property_mode_overrides_title>`
.. 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`` :ref:`🔗<class_FileDialog_property_option_count>`
.. 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_overwrite_warning_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **overwrite_warning_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_overwrite_warning_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, the **FileDialog** will warn the user before overwriting files in save mode.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_recent_list_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **recent_list_enabled** = ``true`` :ref:`🔗<class_FileDialog_property_recent_list_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const|
If ``true``, shows the recent directories list on the left side of the dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_root_subfolder:
.. rst-class:: classref-property
:ref:`String<class_String>` **root_subfolder** = ``""`` :ref:`🔗<class_FileDialog_property_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.
\ **Note:** This property is ignored by native file dialogs.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_show_hidden_files:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_hidden_files** = ``false`` :ref:`🔗<class_FileDialog_property_show_hidden_files>`
.. 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.
\ **Note:** This property is ignored by native file dialogs on Android and Linux.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_property_use_native_dialog:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **use_native_dialog** = ``false`` :ref:`🔗<class_FileDialog_property_use_native_dialog>`
.. 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``, and if supported by the current :ref:`DisplayServer<class_DisplayServer>`, OS native dialog will be used instead of custom one.
\ **Note:** On Android, it is only supported for Android 10+ devices and when using :ref:`ACCESS_FILESYSTEM<class_FileDialog_constant_ACCESS_FILESYSTEM>`. For access mode :ref:`ACCESS_RESOURCES<class_FileDialog_constant_ACCESS_RESOURCES>` and :ref:`ACCESS_USERDATA<class_FileDialog_constant_ACCESS_USERDATA>`, the system will fall back to custom FileDialog.
\ **Note:** On Linux and macOS, sandboxed apps always use native dialogs to access the host file system.
\ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions()<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.
\ **Note:** Native dialogs are isolated from the base process, file dialog properties can't be modified once the dialog is shown.
\ **Note:** This property is ignored in :ref:`EditorFileDialog<class_EditorFileDialog>`.
.. 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>` = "", mime_type\: :ref:`String<class_String>` = ""\ ) :ref:`🔗<class_FileDialog_method_add_filter>`
Adds a comma-separated file extension ``filter`` and comma-separated MIME type ``mime_type`` 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"``, a ``mime_type`` of ``image/png, image/jpeg``, and a ``description`` of ``"Images"`` results in filter text "Images (\*.png, \*.jpg)".
\ **Note:** Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
.. 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>`, default_value_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_FileDialog_method_add_option>`
Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. If ``values`` is empty, a :ref:`CheckBox<class_CheckBox>` is added instead.
\ ``default_value_index`` should be an index of the value in the ``values``. If ``values`` is empty it should be either ``1`` (checked), or ``0`` (unchecked).
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_clear_filename_filter:
.. rst-class:: classref-method
|void| **clear_filename_filter**\ (\ ) :ref:`🔗<class_FileDialog_method_clear_filename_filter>`
Clear the filter for file names.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_clear_filters:
.. rst-class:: classref-method
|void| **clear_filters**\ (\ ) :ref:`🔗<class_FileDialog_method_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**\ (\ ) :ref:`🔗<class_FileDialog_method_deselect_all>`
Clear all currently selected items in the dialog.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_favorite_list:
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_favorite_list**\ (\ ) |static| :ref:`🔗<class_FileDialog_method_get_favorite_list>`
Returns the list of favorite directories, which is shared by all **FileDialog** nodes. Useful to store the list of favorites between project sessions. This method can be called only from the main thread.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_line_edit:
.. rst-class:: classref-method
:ref:`LineEdit<class_LineEdit>` **get_line_edit**\ (\ ) :ref:`🔗<class_FileDialog_method_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| :ref:`🔗<class_FileDialog_method_get_option_default>`
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| :ref:`🔗<class_FileDialog_method_get_option_name>`
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| :ref:`🔗<class_FileDialog_method_get_option_values>`
Returns an array of values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_recent_list:
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_recent_list**\ (\ ) |static| :ref:`🔗<class_FileDialog_method_get_recent_list>`
Returns the list of recent directories, which is shared by all **FileDialog** nodes. Useful to store the list of recents between project sessions. This method can be called only from the main thread.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_get_selected_options:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_selected_options**\ (\ ) |const| :ref:`🔗<class_FileDialog_method_get_selected_options>`
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**\ (\ ) :ref:`🔗<class_FileDialog_method_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.
\ **Note:** Changes to this node are ignored by native file dialogs, use :ref:`add_option()<class_FileDialog_method_add_option>` to add custom elements to the dialog instead.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_invalidate:
.. rst-class:: classref-method
|void| **invalidate**\ (\ ) :ref:`🔗<class_FileDialog_method_invalidate>`
Invalidates and updates this dialog's content list.
\ **Note:** This method does nothing on native file dialogs.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_is_customization_flag_enabled:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`\ ) |const| :ref:`🔗<class_FileDialog_method_is_customization_flag_enabled>`
Returns ``true`` if the provided ``flag`` is enabled.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_popup_file_dialog:
.. rst-class:: classref-method
|void| **popup_file_dialog**\ (\ ) :ref:`🔗<class_FileDialog_method_popup_file_dialog>`
Shows the **FileDialog** using the default size and position for file dialogs, and selects the file name if there is a current file.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_customization_flag_enabled:
.. rst-class:: classref-method
|void| **set_customization_flag_enabled**\ (\ flag\: :ref:`Customization<enum_FileDialog_Customization>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_FileDialog_method_set_customization_flag_enabled>`
Sets the specified customization ``flag``, allowing to customize the features available in this **FileDialog**.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_favorite_list:
.. rst-class:: classref-method
|void| **set_favorite_list**\ (\ favorites\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |static| :ref:`🔗<class_FileDialog_method_set_favorite_list>`
Sets the list of favorite directories, which is shared by all **FileDialog** nodes. Useful to restore the list of favorites saved with :ref:`get_favorite_list()<class_FileDialog_method_get_favorite_list>`. This method can be called only from the main thread.
\ **Note:** **FileDialog** will update its internal :ref:`ItemList<class_ItemList>` of favorites when its visibility changes. Be sure to call this method earlier if you want your changes to have effect.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_get_icon_callback:
.. rst-class:: classref-method
|void| **set_get_icon_callback**\ (\ callback\: :ref:`Callable<class_Callable>`\ ) |static| :ref:`🔗<class_FileDialog_method_set_get_icon_callback>`
Sets the callback used by the **FileDialog** nodes to get a file icon, when :ref:`DISPLAY_LIST<class_FileDialog_constant_DISPLAY_LIST>` mode is used. The callback should take a single :ref:`String<class_String>` argument (file path), and return a :ref:`Texture2D<class_Texture2D>`. If an invalid texture is returned, the :ref:`file<class_FileDialog_theme_icon_file>` icon will be used instead.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_get_thumbnail_callback:
.. rst-class:: classref-method
|void| **set_get_thumbnail_callback**\ (\ callback\: :ref:`Callable<class_Callable>`\ ) |static| :ref:`🔗<class_FileDialog_method_set_get_thumbnail_callback>`
Sets the callback used by the **FileDialog** nodes to get a file icon, when :ref:`DISPLAY_THUMBNAILS<class_FileDialog_constant_DISPLAY_THUMBNAILS>` mode is used. The callback should take a single :ref:`String<class_String>` argument (file path), and return a :ref:`Texture2D<class_Texture2D>`. If an invalid texture is returned, the :ref:`file_thumbnail<class_FileDialog_theme_icon_file_thumbnail>` icon will be used instead.
Thumbnails are usually more complex and may take a while to load. To avoid stalling the application, you can use :ref:`ImageTexture<class_ImageTexture>` to asynchronously create the thumbnail.
::
func _ready():
FileDialog.set_get_thumbnail_callback(thumbnail_method)
func thumbnail_method(path):
var image_texture = ImageTexture.new()
make_thumbnail_async(path, image_texture)
return image_texture
func make_thumbnail_async(path, image_texture):
var thumbnail_texture = await generate_thumbnail(path) # Some method that generates a thumbnail.
image_texture.set_image(thumbnail_texture.get_image())
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_option_default:
.. rst-class:: classref-method
|void| **set_option_default**\ (\ option\: :ref:`int<class_int>`, default_value_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_FileDialog_method_set_option_default>`
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>`\ ) :ref:`🔗<class_FileDialog_method_set_option_name>`
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>`\ ) :ref:`🔗<class_FileDialog_method_set_option_values>`
Sets the option values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_set_recent_list:
.. rst-class:: classref-method
|void| **set_recent_list**\ (\ recents\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |static| :ref:`🔗<class_FileDialog_method_set_recent_list>`
Sets the list of recent directories, which is shared by all **FileDialog** nodes. Useful to restore the list of recents saved with :ref:`set_recent_list()<class_FileDialog_method_set_recent_list>`. This method can be called only from the main thread.
\ **Note:** **FileDialog** will update its internal :ref:`ItemList<class_ItemList>` of recent directories when its visibility changes. Be sure to call this method earlier if you want your changes to have effect.
.. 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)`` :ref:`🔗<class_FileDialog_theme_color_file_disabled_color>`
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)`` :ref:`🔗<class_FileDialog_theme_color_file_icon_color>`
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)`` :ref:`🔗<class_FileDialog_theme_color_folder_icon_color>`
The color modulation applied to the folder icon.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_constant_thumbnail_size:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **thumbnail_size** = ``64`` :ref:`🔗<class_FileDialog_theme_constant_thumbnail_size>`
The size of thumbnail icons when :ref:`DISPLAY_THUMBNAILS<class_FileDialog_constant_DISPLAY_THUMBNAILS>` is enabled.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_back_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **back_folder** :ref:`🔗<class_FileDialog_theme_icon_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** :ref:`🔗<class_FileDialog_theme_icon_create_folder>`
Custom icon for the create folder button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_favorite:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **favorite** :ref:`🔗<class_FileDialog_theme_icon_favorite>`
Custom icon for favorite folder button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_favorite_down:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **favorite_down** :ref:`🔗<class_FileDialog_theme_icon_favorite_down>`
Custom icon for button to move down a favorite entry.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_favorite_up:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **favorite_up** :ref:`🔗<class_FileDialog_theme_icon_favorite_up>`
Custom icon for button to move up a favorite entry.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_file:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **file** :ref:`🔗<class_FileDialog_theme_icon_file>`
Custom icon for files.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_file_thumbnail:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **file_thumbnail** :ref:`🔗<class_FileDialog_theme_icon_file_thumbnail>`
Icon for files when in thumbnail mode.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folder** :ref:`🔗<class_FileDialog_theme_icon_folder>`
Custom icon for folders.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_folder_thumbnail:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folder_thumbnail** :ref:`🔗<class_FileDialog_theme_icon_folder_thumbnail>`
Icon for folders when in thumbnail mode.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_forward_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **forward_folder** :ref:`🔗<class_FileDialog_theme_icon_forward_folder>`
Custom icon for the forward arrow.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_list_mode:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **list_mode** :ref:`🔗<class_FileDialog_theme_icon_list_mode>`
Icon for the button that enables list mode.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_parent_folder:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **parent_folder** :ref:`🔗<class_FileDialog_theme_icon_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** :ref:`🔗<class_FileDialog_theme_icon_reload>`
Custom icon for the reload button.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_sort:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **sort** :ref:`🔗<class_FileDialog_theme_icon_sort>`
Custom icon for the sorting options menu.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_thumbnail_mode:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **thumbnail_mode** :ref:`🔗<class_FileDialog_theme_icon_thumbnail_mode>`
Icon for the button that enables thumbnail mode.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_toggle_filename_filter:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **toggle_filename_filter** :ref:`🔗<class_FileDialog_theme_icon_toggle_filename_filter>`
Custom icon for the toggle button for the filter for file names.
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_theme_icon_toggle_hidden:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **toggle_hidden** :ref:`🔗<class_FileDialog_theme_icon_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.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |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