: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` **<** :ref:`AcceptDialog` **<** :ref:`Window` **<** :ref:`Viewport` **<** :ref:`Node` **<** :ref:`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`. If you want to use a custom title, disable this by setting :ref:`mode_overrides_title` to ``false``. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`Access` | :ref:`access` | ``0`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`current_dir` | | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`current_file` | | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`current_path` | | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog`) | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`FileMode` | :ref:`file_mode` | ``4`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`filename_filter` | ``""`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`filters` | ``PackedStringArray()`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`mode_overrides_title` | ``true`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`option_count` | ``0`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`root_subfolder` | ``""`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`show_hidden_files` | ``false`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | size | ``Vector2i(640, 360)`` (overrides :ref:`Window`) | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`String` | title | ``"Save a File"`` (overrides :ref:`Window`) | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`use_native_dialog` | ``false`` | +---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_filter`\ (\ filter\: :ref:`String`, description\: :ref:`String` = ""\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_option`\ (\ name\: :ref:`String`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_filename_filter`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_filters`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`deselect_all`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`LineEdit` | :ref:`get_line_edit`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_option_default`\ (\ option\: :ref:`int`\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_option_name`\ (\ option\: :ref:`int`\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_option_values`\ (\ option\: :ref:`int`\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_selected_options`\ (\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VBoxContainer` | :ref:`get_vbox`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`invalidate`\ (\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_option_default`\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_option_name`\ (\ option\: :ref:`int`, name\: :ref:`String`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_option_values`\ (\ option\: :ref:`int`, values\: :ref:`PackedStringArray`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Color` | :ref:`file_disabled_color` | ``Color(1, 1, 1, 0.25)`` | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Color` | :ref:`file_icon_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Color` | :ref:`folder_icon_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`back_folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`create_folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`file` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`forward_folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`parent_folder` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`reload` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`toggle_filename_filter` | | +-----------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture2D` | :ref:`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`\ ) :ref:`🔗` 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`\ ) :ref:`🔗` 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`\ ) :ref:`🔗` 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`\ ) :ref:`🔗` 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:`🔗` .. _class_FileDialog_constant_FILE_MODE_OPEN_FILE: .. rst-class:: classref-enumeration-constant :ref:`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` **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` **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` **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` **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:`🔗` .. _class_FileDialog_constant_ACCESS_RESOURCES: .. rst-class:: classref-enumeration-constant :ref:`Access` **ACCESS_RESOURCES** = ``0`` The dialog only allows accessing files under the :ref:`Resource` path (``res://``). .. _class_FileDialog_constant_ACCESS_USERDATA: .. rst-class:: classref-enumeration-constant :ref:`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` **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` **access** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_access**\ (\ value\: :ref:`Access`\ ) - :ref:`Access` **get_access**\ (\ ) The file system access scope. See :ref:`Access` constants. \ **Warning:** In Web builds, FileDialog cannot access the host file system. In sandboxed Linux and macOS environments, :ref:`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` **current_dir** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_current_dir**\ (\ value\: :ref:`String`\ ) - :ref:`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` **current_file** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_current_file**\ (\ value\: :ref:`String`\ ) - :ref:`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` **current_path** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_current_path**\ (\ value\: :ref:`String`\ ) - :ref:`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` **file_mode** = ``4`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_file_mode**\ (\ value\: :ref:`FileMode`\ ) - :ref:`FileMode` **get_file_mode**\ (\ ) The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode`. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_filename_filter: .. rst-class:: classref-property :ref:`String` **filename_filter** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_filename_filter**\ (\ value\: :ref:`String`\ ) - :ref:`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` can be edited by the user with the filter button at the top of the file dialog. See also :ref:`filters`, which should be used to restrict the file types that can be selected instead of :ref:`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` **filters** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_filters**\ (\ value\: :ref:`PackedStringArray`\ ) - :ref:`PackedStringArray` **get_filters**\ (\ ) The available file type filters. Each filter string in the array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. \ **Note:** For android native dialog, MIME types are used like this: ``image/*, application/pdf``. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_mode_overrides_title: .. rst-class:: classref-property :ref:`bool` **mode_overrides_title** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_mode_overrides_title**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_mode_overriding_title**\ (\ ) If ``true``, changing the :ref:`file_mode` property will set the window title accordingly (e.g. setting :ref:`file_mode` to :ref:`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` **option_count** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_option_count**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_option_count**\ (\ ) The number of additional :ref:`OptionButton`\ s and :ref:`CheckBox`\ es in the dialog. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_root_subfolder: .. rst-class:: classref-property :ref:`String` **root_subfolder** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_root_subfolder**\ (\ value\: :ref:`String`\ ) - :ref:`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` **show_hidden_files** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_show_hidden_files**\ (\ value\: :ref:`bool`\ ) - :ref:`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` **use_native_dialog** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_use_native_dialog**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_use_native_dialog**\ (\ ) If ``true``, and if supported by the current :ref:`DisplayServer`, OS native dialog will be used instead of custom one. \ **Note:** On Android, it is only supported when using :ref:`ACCESS_FILESYSTEM`. For access mode :ref:`ACCESS_RESOURCES` and :ref:`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` 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. .. 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`, description\: :ref:`String` = ""\ ) :ref:`🔗` 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`, values\: :ref:`PackedStringArray`, default_value_index\: :ref:`int`\ ) :ref:`🔗` Adds an additional :ref:`OptionButton` to the file dialog. If ``values`` is empty, a :ref:`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:`🔗` Clear the filter for file names. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_clear_filters: .. rst-class:: classref-method |void| **clear_filters**\ (\ ) :ref:`🔗` 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:`🔗` 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` **get_line_edit**\ (\ ) :ref:`🔗` 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` property. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_option_default: .. rst-class:: classref-method :ref:`int` **get_option_default**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the default value index of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_option_name: .. rst-class:: classref-method :ref:`String` **get_option_name**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the :ref:`OptionButton` or :ref:`CheckBox` with index ``option``. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_option_values: .. rst-class:: classref-method :ref:`PackedStringArray` **get_option_values**\ (\ option\: :ref:`int`\ ) |const| :ref:`🔗` Returns an array of values of the :ref:`OptionButton` with index ``option``. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_selected_options: .. rst-class:: classref-method :ref:`Dictionary` **get_selected_options**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Dictionary` with the selected values of the additional :ref:`OptionButton`\ s and/or :ref:`CheckBox`\ es. :ref:`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` **get_vbox**\ (\ ) :ref:`🔗` 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` property. \ **Note:** Changes to this node are ignored by native file dialogs, use :ref:`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:`🔗` Invalidate and update the current dialog content list. \ **Note:** This method does nothing on native file dialogs. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_set_option_default: .. rst-class:: classref-method |void| **set_option_default**\ (\ option\: :ref:`int`, default_value_index\: :ref:`int`\ ) :ref:`🔗` Sets the default value index of the :ref:`OptionButton` or :ref:`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`, name\: :ref:`String`\ ) :ref:`🔗` Sets the name of the :ref:`OptionButton` or :ref:`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`, values\: :ref:`PackedStringArray`\ ) :ref:`🔗` Sets the option values of the :ref:`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` **file_disabled_color** = ``Color(1, 1, 1, 0.25)`` :ref:`🔗` 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` **file_icon_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` 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` **folder_icon_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` 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` **back_folder** :ref:`🔗` Custom icon for the back arrow. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_create_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **create_folder** :ref:`🔗` Custom icon for the create folder button. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_file: .. rst-class:: classref-themeproperty :ref:`Texture2D` **file** :ref:`🔗` Custom icon for files. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **folder** :ref:`🔗` Custom icon for folders. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_forward_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **forward_folder** :ref:`🔗` Custom icon for the forward arrow. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_parent_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **parent_folder** :ref:`🔗` Custom icon for the parent folder arrow. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_reload: .. rst-class:: classref-themeproperty :ref:`Texture2D` **reload** :ref:`🔗` Custom icon for the reload button. .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_toggle_filename_filter: .. rst-class:: classref-themeproperty :ref:`Texture2D` **toggle_filename_filter** :ref:`🔗` 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` **toggle_hidden** :ref:`🔗` 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.)`