跳转至

FileDialog

继承

ConfirmationDialog

简要描述

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

描述

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

成员

类型 属性名 默认值
int access 0
String current_dir "res://"
String current_file ""
String current_path "res://"
bool dialog_hide_on_ok false
PoolStringArray filters PoolStringArray( )
int mode 4
bool mode_overrides_title true
bool show_hidden_files false
String window_title "Save a File"

方法

返回值类型 方法名称
void add_filter(filter: String)
void clear_filters()
void deselect_items()
LineEdit get_line_edit()
VBoxContainer get_vbox()
void invalidate()

信号

  • 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
Default 0
setter set_access(value)
getter get_access
  • String current_dir
Default "res://"
setter set_current_dir(value)
getter get_current_dir
  • String current_file
Default ""
setter set_current_file(value)
getter get_current_file
  • String current_path
Default "res://"
setter set_current_path(value)
getter get_current_path
  • bool dialog_hide_on_ok
Default false
setter set_hide_on_ok(value)
getter get_hide_on_ok
  • PoolStringArray filters
Default PoolStringArray( )
setter set_filters(value)
getter get_filters
  • int mode
Default 4
setter set_mode(value)
getter get_mode
  • bool mode_overrides_title
Default true
setter set_mode_overrides_title(value)
getter is_mode_overriding_title
  • bool show_hidden_files
Default false
setter set_show_hidden_files(value)
getter is_showing_hidden_files
  • String window_title
Default "Save a File"
setter set_title(value)
getter get_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()

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