.. 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/docs/gdscript/doc/classes/FileDialog.xml. .. _class_FileDialog: FileDialog ========== **Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`Window` **<** :ref:`Viewport` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. 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:`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:`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` **(** :ref:`String` filter, :ref:`String` description="" **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_option` **(** :ref:`String` name, :ref:`PackedStringArray` values, :ref:`int` default_value_index **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_filters` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`deselect_all` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_option_default` **(** :ref:`int` option **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_option_name` **(** :ref:`int` option **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_option_values` **(** :ref:`int` option **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_selected_options` **(** **)** |const| | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`invalidate` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_option_default` **(** :ref:`int` option, :ref:`int` default_value_index **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_option_name` **(** :ref:`int` option, :ref:`String` name **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_option_values` **(** :ref:`int` option, :ref:`PackedStringArray` values **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. 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_hidden` | | +-----------------------------------+------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_FileDialog_signal_dir_selected: .. rst-class:: classref-signal **dir_selected** **(** :ref:`String` dir **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_signal_file_selected: .. rst-class:: classref-signal **file_selected** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_signal_files_selected: .. rst-class:: classref-signal **files_selected** **(** :ref:`PackedStringArray` paths **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_FileDialog_FileMode: .. rst-class:: classref-enumeration enum **FileMode**: .. _class_FileDialog_constant_FILE_MODE_OPEN_FILE: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_OPEN_FILE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FileDialog_constant_FILE_MODE_OPEN_FILES: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_OPEN_FILES** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FileDialog_constant_FILE_MODE_OPEN_DIR: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_OPEN_DIR** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FileDialog_constant_FILE_MODE_OPEN_ANY: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_OPEN_ANY** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FileDialog_constant_FILE_MODE_SAVE_FILE: .. rst-class:: classref-enumeration-constant :ref:`FileMode` **FILE_MODE_SAVE_FILE** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_FileDialog_Access: .. rst-class:: classref-enumeration enum **Access**: .. _class_FileDialog_constant_ACCESS_RESOURCES: .. rst-class:: classref-enumeration-constant :ref:`Access` **ACCESS_RESOURCES** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FileDialog_constant_ACCESS_USERDATA: .. rst-class:: classref-enumeration-constant :ref:`Access` **ACCESS_USERDATA** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FileDialog_constant_ACCESS_FILESYSTEM: .. rst-class:: classref-enumeration-constant :ref:`Access` **ACCESS_FILESYSTEM** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_FileDialog_property_access: .. rst-class:: classref-property :ref:`Access` **access** = ``0`` .. rst-class:: classref-property-setget - void **set_access** **(** :ref:`Access` value **)** - :ref:`Access` **get_access** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_current_dir: .. rst-class:: classref-property :ref:`String` **current_dir** .. rst-class:: classref-property-setget - void **set_current_dir** **(** :ref:`String` value **)** - :ref:`String` **get_current_dir** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_current_file: .. rst-class:: classref-property :ref:`String` **current_file** .. rst-class:: classref-property-setget - void **set_current_file** **(** :ref:`String` value **)** - :ref:`String` **get_current_file** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_current_path: .. rst-class:: classref-property :ref:`String` **current_path** .. rst-class:: classref-property-setget - void **set_current_path** **(** :ref:`String` value **)** - :ref:`String` **get_current_path** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_file_mode: .. rst-class:: classref-property :ref:`FileMode` **file_mode** = ``4`` .. rst-class:: classref-property-setget - void **set_file_mode** **(** :ref:`FileMode` value **)** - :ref:`FileMode` **get_file_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_filters: .. rst-class:: classref-property :ref:`PackedStringArray` **filters** = ``PackedStringArray()`` .. rst-class:: classref-property-setget - void **set_filters** **(** :ref:`PackedStringArray` value **)** - :ref:`PackedStringArray` **get_filters** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_mode_overrides_title: .. rst-class:: classref-property :ref:`bool` **mode_overrides_title** = ``true`` .. rst-class:: classref-property-setget - void **set_mode_overrides_title** **(** :ref:`bool` value **)** - :ref:`bool` **is_mode_overriding_title** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_option_count: .. rst-class:: classref-property :ref:`int` **option_count** = ``0`` .. rst-class:: classref-property-setget - void **set_option_count** **(** :ref:`int` value **)** - :ref:`int` **get_option_count** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_root_subfolder: .. rst-class:: classref-property :ref:`String` **root_subfolder** = ``""`` .. rst-class:: classref-property-setget - void **set_root_subfolder** **(** :ref:`String` value **)** - :ref:`String` **get_root_subfolder** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_show_hidden_files: .. rst-class:: classref-property :ref:`bool` **show_hidden_files** = ``false`` .. rst-class:: classref-property-setget - void **set_show_hidden_files** **(** :ref:`bool` value **)** - :ref:`bool` **is_showing_hidden_files** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_property_use_native_dialog: .. rst-class:: classref-property :ref:`bool` **use_native_dialog** = ``false`` .. rst-class:: classref-property-setget - void **set_use_native_dialog** **(** :ref:`bool` value **)** - :ref:`bool` **get_use_native_dialog** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_FileDialog_method_add_filter: .. rst-class:: classref-method void **add_filter** **(** :ref:`String` filter, :ref:`String` description="" **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_add_option: .. rst-class:: classref-method void **add_option** **(** :ref:`String` name, :ref:`PackedStringArray` values, :ref:`int` default_value_index **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_clear_filters: .. rst-class:: classref-method void **clear_filters** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_deselect_all: .. rst-class:: classref-method void **deselect_all** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_line_edit: .. rst-class:: classref-method :ref:`LineEdit` **get_line_edit** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_option_default: .. rst-class:: classref-method :ref:`int` **get_option_default** **(** :ref:`int` option **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_option_name: .. rst-class:: classref-method :ref:`String` **get_option_name** **(** :ref:`int` option **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_option_values: .. rst-class:: classref-method :ref:`PackedStringArray` **get_option_values** **(** :ref:`int` option **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_selected_options: .. rst-class:: classref-method :ref:`Dictionary` **get_selected_options** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_get_vbox: .. rst-class:: classref-method :ref:`VBoxContainer` **get_vbox** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_invalidate: .. rst-class:: classref-method void **invalidate** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_set_option_default: .. rst-class:: classref-method void **set_option_default** **(** :ref:`int` option, :ref:`int` default_value_index **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_set_option_name: .. rst-class:: classref-method void **set_option_name** **(** :ref:`int` option, :ref:`String` name **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_method_set_option_values: .. rst-class:: classref-method void **set_option_values** **(** :ref:`int` option, :ref:`PackedStringArray` values **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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)`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. 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)`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. 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)`` .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_back_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **back_folder** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_create_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **create_folder** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_file: .. rst-class:: classref-themeproperty :ref:`Texture2D` **file** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **folder** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_forward_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **forward_folder** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_parent_folder: .. rst-class:: classref-themeproperty :ref:`Texture2D` **parent_folder** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_reload: .. rst-class:: classref-themeproperty :ref:`Texture2D` **reload** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FileDialog_theme_icon_toggle_hidden: .. rst-class:: classref-themeproperty :ref:`Texture2D` **toggle_hidden** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. |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.)`