跳到主要内容

FileDialog

继承

ConfirmationDialog

简要描述

在文件系统中选择文件或目录的对话框。

描述

FileDialog是一个预设对话框,用于选择文件系统中的文件和目录。它支持过滤掩码。

成员

类型属性名默认值
intaccess0
Stringcurrent_dir"res://"
Stringcurrent_file""
Stringcurrent_path"res://"
booldialog_hide_on_okfalse
PoolStringArrayfiltersPoolStringArray( )
intmode4
boolmode_overrides_titletrue
boolshow_hidden_filesfalse
Stringwindow_title"Save a File"

方法

返回值类型方法名称
voidadd_filter(filter: String)
voidclear_filters()
voiddeselect_items()
LineEditget_line_edit()
VBoxContainerget_vbox()
voidinvalidate()

信号

  • **dir_selected**

当用户选择一个目录时发出。


  • **file_selected**

当用户通过双击文件或按确定按钮选择文件时发出。


  • **files_selected**

当用户选择多个文件时发出。


枚举

enum Mode:

  • **MODE_OPEN_FILE = 0**

该对话框允许选择一个,并且只能选择一个文件。

  • **MODE_OPEN_FILES = 1**

该对话框允许选择多个文件。

  • **MODE_OPEN_DIR = 2**

该对话框仅允许选择目录,不允许选择任何文件。

  • **MODE_OPEN_ANY = 3**

该对话框允许选择一个文件或目录。

  • **MODE_SAVE_FILE = 4**

该对话框将在文件存在时发出警告。


enum Access:

  • **ACCESS_RESOURCES = 0**

该对话框仅允许访问Resource路径(res://)下的文件。

  • **ACCESS_USERDATA = 1**

该对话框仅允许访问用户数据路径(user://)下的文件。

  • **ACCESS_FILESYSTEM = 2**

该对话框允许访问整个文件系统上的文件。


常量

成员说明

  • int access
Default0
setterset_access(value)
getterget_access
  • String current_dir
Default"res://"
setterset_current_dir(value)
getterget_current_dir
  • String current_file
Default""
setterset_current_file(value)
getterget_current_file
  • String current_path
Default"res://"
setterset_current_path(value)
getterget_current_path
  • bool dialog_hide_on_ok
Defaultfalse
setterset_hide_on_ok(value)
getterget_hide_on_ok
  • PoolStringArray filters
DefaultPoolStringArray( )
setterset_filters(value)
getterget_filters
  • int mode
Default4
setterset_mode(value)
getterget_mode
  • bool mode_overrides_title
Defaulttrue
setterset_mode_overrides_title(value)
getteris_mode_overriding_title
  • bool show_hidden_files
Defaultfalse
setterset_show_hidden_files(value)
getteris_showing_hidden_files
  • String window_title
Default"Save a File"
setterset_title(value)
getterget_title

方法说明

  • add_filter add_filter(filter: String)

添加过滤器作为自定义过滤器; filter的形式应该是"filename.extension ; Description"。例如,"*.png ; PNG Images"


  • clear_filters clear_filters()

清除对话框中所有添加的过滤器。


  • deselect_items deselect_items()

清除对话框中当前选择的项目。


  • get_line_edit get_line_edit()

返回所选文件的LineEdit。


  • get_vbox get_vbox()

返回对话框的垂直框容器,可以向其中添加自定义控件。


  • invalidate invalidate()

无效并更新当前对话框内容列表。