godotengine/godot-docs-l10n
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs-l10n.git synced 2026-01-04 10:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
36d0439ca5be178d7e6b4f9b6bffbcf4f90209f5
godot-docs-l10n/classes/zh_CN/class_filedialog.rst

800 lines
38 KiB
ReStructuredText
Raw Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FileDialog.xml.
.. _class_FileDialog:
FileDialog
==========
**继承：** :ref:`ConfirmationDialog<class_ConfirmationDialog>` **<** :ref:`AcceptDialog<class_AcceptDialog>` **<** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
用于选择文件系统中的文件或目录的对话框。
.. rst-class:: classref-introduction-group
描述
----
**FileDialog** 是用来选择文件系统中文件和目录的预设对话框。支持过滤器掩码。\ **FileDialog** 会根据 :ref:`file_mode<class_FileDialog_property_file_mode>` 自动设置窗口的标题。如果你想使用自定义标题，请将 :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` 设置为 ``false``\ ，禁用此功能。
.. rst-class:: classref-reftable-group
属性
----
.. table::
:widths: auto
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`Access<enum_FileDialog_Access>` | :ref:`access<class_FileDialog_property_access>` | ``0`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_dir<class_FileDialog_property_current_dir>` | |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_file<class_FileDialog_property_current_file>` | |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_path<class_FileDialog_property_current_path>` | |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog<class_AcceptDialog_property_dialog_hide_on_ok>`) |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`FileMode<enum_FileDialog_FileMode>` | :ref:`file_mode<class_FileDialog_property_file_mode>` | ``4`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`filters<class_FileDialog_property_filters>` | ``PackedStringArray()`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` | ``true`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`option_count<class_FileDialog_property_option_count>` | ``0`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`root_subfolder<class_FileDialog_property_root_subfolder>` | ``""`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`show_hidden_files<class_FileDialog_property_show_hidden_files>` | ``false`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | title | ``"Save a File"`` (overrides :ref:`Window<class_Window_property_title>`) |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_native_dialog<class_FileDialog_property_use_native_dialog>` | ``false`` |
+---------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
方法
----
.. table::
:widths: auto
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_filter<class_FileDialog_method_add_filter>`\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_option<class_FileDialog_method_add_option>`\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, default_value_index\: :ref:`int<class_int>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_filters<class_FileDialog_method_clear_filters>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`deselect_all<class_FileDialog_method_deselect_all>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_FileDialog_method_get_line_edit>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_option_default<class_FileDialog_method_get_option_default>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_option_name<class_FileDialog_method_get_option_name>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_option_values<class_FileDialog_method_get_option_values>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_selected_options<class_FileDialog_method_get_selected_options>`\ (\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_FileDialog_method_get_vbox>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`invalidate<class_FileDialog_method_invalidate>`\ (\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_option_default<class_FileDialog_method_set_option_default>`\ (\ option\: :ref:`int<class_int>`, 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>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
主题属性
--------
.. table::
:widths: auto
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`file_disabled_color<class_FileDialog_theme_color_file_disabled_color>` | ``Color(1, 1, 1, 0.25)`` |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`file_icon_color<class_FileDialog_theme_color_file_icon_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`folder_icon_color<class_FileDialog_theme_color_folder_icon_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`back_folder<class_FileDialog_theme_icon_back_folder>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`create_folder<class_FileDialog_theme_icon_create_folder>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`file<class_FileDialog_theme_icon_file>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folder<class_FileDialog_theme_icon_folder>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`forward_folder<class_FileDialog_theme_icon_forward_folder>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`parent_folder<class_FileDialog_theme_icon_parent_folder>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`reload<class_FileDialog_theme_icon_reload>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`toggle_hidden<class_FileDialog_theme_icon_toggle_hidden>` | |
+-----------------------------------+------------------------------------------------------------------------------+--------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
信号
----
.. _class_FileDialog_signal_dir_selected:
.. rst-class:: classref-signal
**dir_selected**\ (\ dir\: :ref:`String<class_String>`\ ) :ref:`🔗<class_FileDialog_signal_dir_selected>`
当用户选择一个目录时触发的。
.. 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>`
当用户通过双击文件或按\ **确定**\ 按钮选择一个文件时触发。
.. 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>`
当用户选择多个文件时触发。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
枚举
----
.. _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``
该对话框只允许选择一个文件。
.. _class_FileDialog_constant_FILE_MODE_OPEN_FILES:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_OPEN_FILES** = ``1``
该对话框允许选择多个文件。
.. _class_FileDialog_constant_FILE_MODE_OPEN_DIR:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_OPEN_DIR** = ``2``
该对话框只允许选择一个目录，不允许选择任何文件。
.. _class_FileDialog_constant_FILE_MODE_OPEN_ANY:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_OPEN_ANY** = ``3``
该对话框允许选择一个文件或目录。
.. _class_FileDialog_constant_FILE_MODE_SAVE_FILE:
.. rst-class:: classref-enumeration-constant
:ref:`FileMode<enum_FileDialog_FileMode>` **FILE_MODE_SAVE_FILE** = ``4``
当文件存在时，对话框会发出警告。
.. 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``
该对话框只允许访问 :ref:`Resource<class_Resource>` 路径下的文件（\ ``res://``\ ）。
.. _class_FileDialog_constant_ACCESS_USERDATA:
.. rst-class:: classref-enumeration-constant
:ref:`Access<enum_FileDialog_Access>` **ACCESS_USERDATA** = ``1``
该对话框只允许访问用户数据路径（\ ``user://``\ ）下的文件。
.. _class_FileDialog_constant_ACCESS_FILESYSTEM:
.. rst-class:: classref-enumeration-constant
:ref:`Access<enum_FileDialog_Access>` **ACCESS_FILESYSTEM** = ``2``
该对话框允许访问文件系统上的文件。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
属性说明
--------
.. _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. See :ref:`Access<enum_FileDialog_Access>` constants.
\ **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**\ (\ )
文件对话框的当前选定的文件。
.. 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**\ (\ )
当前选择的文件对话框的文件路径。
.. 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**\ (\ )
对话框的打开或保存模式，会影响选择行为。见 :ref:`FileMode<enum_FileDialog_FileMode>`\ 。
.. 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**\ (\ )
可用文件类型过滤器。数组中的每个过滤器都应该使用类似 ``*.txt,*.doc;文本文件`` 的格式。过滤器的描述文本不是必填项，可以省略。
**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_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**\ (\ )
如果为 ``true``\ ，更改 :ref:`file_mode<class_FileDialog_property_file_mode>` 属性将相应地设置窗口标题（例如，将 :ref:`file_mode<class_FileDialog_property_file_mode>` 设置为 :ref:`FILE_MODE_OPEN_FILE<class_FileDialog_constant_FILE_MODE_OPEN_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**\ (\ )
对话框中附加的 :ref:`OptionButton<class_OptionButton>` 和 :ref:`CheckBox<class_CheckBox>` 的数量。
.. 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 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``, :ref:`access<class_FileDialog_property_access>` is set to :ref:`ACCESS_FILESYSTEM<class_FileDialog_constant_ACCESS_FILESYSTEM>`, and it is supported by the current :ref:`DisplayServer<class_DisplayServer>`, OS native dialog will be used instead of custom one.
\ **Note:** On 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.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
方法说明
--------
.. _class_FileDialog_method_add_filter:
.. rst-class:: classref-method
|void| **add_filter**\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ ) :ref:`🔗<class_FileDialog_method_add_filter>`
将一个逗号分隔的文件名 ``filter`` 且带有可选 ``description`` 的选项添加到的 **FileDialog**\ ，这限制了可以选择的文件。
\ ``filter`` 的格式应为 ``"文件名.扩展名"``\ ，其中文件名和扩展名可以是 ``*``\ ，以匹配任意字符串。不允许使用以 ``.`` 开头的过滤器（即空文件名）。
例如，\ ``"*.png, *.jpg"`` 的 ``filter`` 和 ``"图像"`` 的 ``description`` 会产生过滤器文本“图像 (\* .png, \*.jpg)”。
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_add_option:
.. rst-class:: classref-method
|void| **add_option**\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, default_value_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_FileDialog_method_add_option>`
向文件对话框添加额外的 :ref:`OptionButton<class_OptionButton>`\ 。如果 ``values`` 为空，则添加的是 :ref:`CheckBox<class_CheckBox>`\ 。
\ ``default_value_index`` 应该是 ``values`` 的索引号。如果 ``values`` 为空，则应该是 ``1``\ （选中）或 ``0``\ （未选中）。
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_clear_filters:
.. rst-class:: classref-method
|void| **clear_filters**\ (\ ) :ref:`🔗<class_FileDialog_method_clear_filters>`
清除对话框中所有添加的过滤器。
.. rst-class:: classref-item-separator
----
.. _class_FileDialog_method_deselect_all:
.. rst-class:: classref-method
|void| **deselect_all**\ (\ ) :ref:`🔗<class_FileDialog_method_deselect_all>`
清除对话框中所有当前选定的项目。
.. 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>`
返回所选文件的 LineEdit。
\ **警告：**\ 这是一个必需的内部节点，删除和释放它可能会导致崩溃。如果你希望隐藏它或其任何子项，请使用它们的 :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` 属性。
.. 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>`
返回索引为 ``option`` 的 :ref:`OptionButton<class_OptionButton>` 或 :ref:`CheckBox<class_CheckBox>` 的默认值索引。
.. 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>`
返回索引为 ``option`` 的 :ref:`OptionButton<class_OptionButton>` 或 :ref:`CheckBox<class_CheckBox>` 的名称。
.. 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>`
返回索引为 ``option`` 的 :ref:`OptionButton<class_OptionButton>` 值的数组。
.. 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>`
返回一个 :ref:`Dictionary<class_Dictionary>`\ ，其中包含附加 :ref:`OptionButton<class_OptionButton>` 和/或 :ref:`CheckBox<class_CheckBox>` 的选定值。\ :ref:`Dictionary<class_Dictionary>` 的键是名称，而值是选定的值索引。
.. 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>`
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<class_int>`, default_value_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_FileDialog_method_set_option_default>`
设置索引为 ``option`` 的 :ref:`OptionButton<class_OptionButton>` 或 :ref:`CheckBox<class_CheckBox>` 的默认值索引。
.. 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>`
设置索引为 ``option`` 的 :ref:`OptionButton<class_OptionButton>` 或 :ref:`CheckBox<class_CheckBox>` 的名称。
.. 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>`
设置索引为 ``option`` 的 :ref:`OptionButton<class_OptionButton>` 的选项值。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
主题属性说明
------------
.. _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>`
禁用文件的色调（当 **FileDialog** 在打开文件夹模式下使用时）。
.. 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>`
应用于文件图标的颜色调制。
.. 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>`
应用于文件夹图标的颜色调制。
.. 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>`
向后箭头的自定义图标。
.. 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>`
用于创建文件夹按钮的自定义图标。
.. 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>`
文件的自定义图标。
.. 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>`
文件夹的自定义图标。
.. 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>`
向前箭头的自定义图标。
.. 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>`
父文件夹箭头的自定义图标。
.. 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>`
重新加载按钮的自定义图标。
.. 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>`
切换隐藏按钮的自定义图标。
.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)`
.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)`
.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)`
.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)`
.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)`
.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)`
.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)`
.. |void| replace:: :abbr:`void (无返回值。)`
Reference in New Issue View Git Blame Copy Permalink