mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-07 02:12:07 +03:00
307 lines
16 KiB
ReStructuredText
307 lines
16 KiB
ReStructuredText
: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/EditorFileDialog.xml.
|
|
|
|
.. _class_EditorFileDialog:
|
|
|
|
EditorFileDialog
|
|
================
|
|
|
|
**Inherits:** :ref:`ConfirmationDialog<class_ConfirmationDialog>` **<** :ref:`AcceptDialog<class_AcceptDialog>` **<** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
A modified version of :ref:`FileDialog<class_FileDialog>` used by the editor.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`Access<enum_EditorFileDialog_Access>` | :ref:`access<class_EditorFileDialog_property_access>` | ``0`` |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`current_dir<class_EditorFileDialog_property_current_dir>` | |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`current_file<class_EditorFileDialog_property_current_file>` | |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`current_path<class_EditorFileDialog_property_current_path>` | |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog<class_AcceptDialog_property_dialog_hide_on_ok>`) |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`disable_overwrite_warning<class_EditorFileDialog_property_disable_overwrite_warning>` | ``false`` |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` | :ref:`display_mode<class_EditorFileDialog_property_display_mode>` | ``0`` |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`FileMode<enum_EditorFileDialog_FileMode>` | :ref:`file_mode<class_EditorFileDialog_property_file_mode>` | ``4`` |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`show_hidden_files<class_EditorFileDialog_property_show_hidden_files>` | ``false`` |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | title | ``"Save a File"`` (overrides :ref:`Window<class_Window_property_title>`) |
|
|
+-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_filter<class_EditorFileDialog_method_add_filter>` **(** :ref:`String<class_String>` filter, :ref:`String<class_String>` description="" **)** |
|
|
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`clear_filters<class_EditorFileDialog_method_clear_filters>` **(** **)** |
|
|
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_EditorFileDialog_method_get_vbox>` **(** **)** |
|
|
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`invalidate<class_EditorFileDialog_method_invalidate>` **(** **)** |
|
|
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_EditorFileDialog_signal_dir_selected:
|
|
|
|
- **dir_selected** **(** :ref:`String<class_String>` dir **)**
|
|
|
|
Emitted when a directory is selected.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_signal_file_selected:
|
|
|
|
- **file_selected** **(** :ref:`String<class_String>` path **)**
|
|
|
|
Emitted when a file is selected.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_signal_files_selected:
|
|
|
|
- **files_selected** **(** :ref:`PackedStringArray<class_PackedStringArray>` paths **)**
|
|
|
|
Emitted when multiple files are selected.
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_EditorFileDialog_FileMode:
|
|
|
|
.. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILE:
|
|
|
|
.. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILES:
|
|
|
|
.. _class_EditorFileDialog_constant_FILE_MODE_OPEN_DIR:
|
|
|
|
.. _class_EditorFileDialog_constant_FILE_MODE_OPEN_ANY:
|
|
|
|
.. _class_EditorFileDialog_constant_FILE_MODE_SAVE_FILE:
|
|
|
|
enum **FileMode**:
|
|
|
|
- **FILE_MODE_OPEN_FILE** = **0** --- The ``EditorFileDialog`` can select only one file. Accepting the window will open the file.
|
|
|
|
- **FILE_MODE_OPEN_FILES** = **1** --- The ``EditorFileDialog`` can select multiple files. Accepting the window will open all files.
|
|
|
|
- **FILE_MODE_OPEN_DIR** = **2** --- The ``EditorFileDialog`` can select only one directory. Accepting the window will open the directory.
|
|
|
|
- **FILE_MODE_OPEN_ANY** = **3** --- The ``EditorFileDialog`` can select a file or directory. Accepting the window will open it.
|
|
|
|
- **FILE_MODE_SAVE_FILE** = **4** --- The ``EditorFileDialog`` can select only one file. Accepting the window will save the file.
|
|
|
|
----
|
|
|
|
.. _enum_EditorFileDialog_Access:
|
|
|
|
.. _class_EditorFileDialog_constant_ACCESS_RESOURCES:
|
|
|
|
.. _class_EditorFileDialog_constant_ACCESS_USERDATA:
|
|
|
|
.. _class_EditorFileDialog_constant_ACCESS_FILESYSTEM:
|
|
|
|
enum **Access**:
|
|
|
|
- **ACCESS_RESOURCES** = **0** --- The ``EditorFileDialog`` can only view ``res://`` directory contents.
|
|
|
|
- **ACCESS_USERDATA** = **1** --- The ``EditorFileDialog`` can only view ``user://`` directory contents.
|
|
|
|
- **ACCESS_FILESYSTEM** = **2** --- The ``EditorFileDialog`` can view the entire local file system.
|
|
|
|
----
|
|
|
|
.. _enum_EditorFileDialog_DisplayMode:
|
|
|
|
.. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS:
|
|
|
|
.. _class_EditorFileDialog_constant_DISPLAY_LIST:
|
|
|
|
enum **DisplayMode**:
|
|
|
|
- **DISPLAY_THUMBNAILS** = **0** --- The ``EditorFileDialog`` displays resources as thumbnails.
|
|
|
|
- **DISPLAY_LIST** = **1** --- The ``EditorFileDialog`` displays resources as a list of filenames.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_EditorFileDialog_property_access:
|
|
|
|
- :ref:`Access<enum_EditorFileDialog_Access>` **access**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_access(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_access() |
|
|
+-----------+-------------------+
|
|
|
|
The location from which the user may select a file, including ``res://``, ``user://``, and the local file system.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_property_current_dir:
|
|
|
|
- :ref:`String<class_String>` **current_dir**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_current_dir(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_current_dir() |
|
|
+----------+------------------------+
|
|
|
|
The currently occupied directory.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_property_current_file:
|
|
|
|
- :ref:`String<class_String>` **current_file**
|
|
|
|
+----------+-------------------------+
|
|
| *Setter* | set_current_file(value) |
|
|
+----------+-------------------------+
|
|
| *Getter* | get_current_file() |
|
|
+----------+-------------------------+
|
|
|
|
The currently selected file.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_property_current_path:
|
|
|
|
- :ref:`String<class_String>` **current_path**
|
|
|
|
+----------+-------------------------+
|
|
| *Setter* | set_current_path(value) |
|
|
+----------+-------------------------+
|
|
| *Getter* | get_current_path() |
|
|
+----------+-------------------------+
|
|
|
|
The file system path in the address bar.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_property_disable_overwrite_warning:
|
|
|
|
- :ref:`bool<class_bool>` **disable_overwrite_warning**
|
|
|
|
+-----------+--------------------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------------------------+
|
|
| *Setter* | set_disable_overwrite_warning(value) |
|
|
+-----------+--------------------------------------+
|
|
| *Getter* | is_overwrite_warning_disabled() |
|
|
+-----------+--------------------------------------+
|
|
|
|
If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting files.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_property_display_mode:
|
|
|
|
- :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **display_mode**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+-------------------------+
|
|
| *Setter* | set_display_mode(value) |
|
|
+-----------+-------------------------+
|
|
| *Getter* | get_display_mode() |
|
|
+-----------+-------------------------+
|
|
|
|
The view format in which the ``EditorFileDialog`` displays resources to the user.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_property_file_mode:
|
|
|
|
- :ref:`FileMode<enum_EditorFileDialog_FileMode>` **file_mode**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``4`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_file_mode(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_file_mode() |
|
|
+-----------+----------------------+
|
|
|
|
The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode<enum_EditorFileDialog_FileMode>`
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_property_show_hidden_files:
|
|
|
|
- :ref:`bool<class_bool>` **show_hidden_files**
|
|
|
|
+-----------+------------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+------------------------------+
|
|
| *Setter* | set_show_hidden_files(value) |
|
|
+-----------+------------------------------+
|
|
| *Getter* | is_showing_hidden_files() |
|
|
+-----------+------------------------------+
|
|
|
|
If ``true``, hidden files and directories will be visible in the ``EditorFileDialog``.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_EditorFileDialog_method_add_filter:
|
|
|
|
- void **add_filter** **(** :ref:`String<class_String>` filter, :ref:`String<class_String>` description="" **)**
|
|
|
|
Adds a comma-delimited file name ``filter`` option to the ``EditorFileDialog`` 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 ``"*.tscn, *.scn"`` and a ``description`` of ``"Scenes"`` results in filter text "Scenes (\*.tscn, \*.scn)".
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_method_clear_filters:
|
|
|
|
- void **clear_filters** **(** **)**
|
|
|
|
Removes all filters except for "All Files (\*)".
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_method_get_vbox:
|
|
|
|
- :ref:`VBoxContainer<class_VBoxContainer>` **get_vbox** **(** **)**
|
|
|
|
Returns the ``VBoxContainer`` used to display the file system.
|
|
|
|
\ **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.
|
|
|
|
----
|
|
|
|
.. _class_EditorFileDialog_method_invalidate:
|
|
|
|
- void **invalidate** **(** **)**
|
|
|
|
Notify the ``EditorFileDialog`` that its view of the data is no longer accurate. Updates the view contents on next view update.
|
|
|
|
.. |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.)`
|