FileDialog

Dialog for selecting files or directories in the filesystem.

FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks.

@GodotBaseClass

struct FileDialog {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(FileDialog other);

FileDialog opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static FileDialog _new();

enum Constants;

void _unhandledInput(InputEvent arg0);

void _treeMultiSelected(GodotObject arg0, long arg1, bool arg2);

void _treeSelected();

void _treeItemActivated();

void _dirEntered(StringArg0 arg0);

void _fileEntered(StringArg0 arg0);

void _actionPressed();

void _cancelPressed();

void _filterSelected(long arg0);

void _saveConfirmPressed();

void clearFilters();

void addFilter(StringArg0 filter);

void setFilters(PoolStringArray filters);

PoolStringArray getFilters();

String getCurrentDir();

String getCurrentFile();

String getCurrentPath();

void setCurrentDir(StringArg0 dir);

void setCurrentFile(StringArg0 file);

void setCurrentPath(StringArg0 path);

void setModeOverridesTitle(bool _override);

bool isModeOverridingTitle();

void setMode(long mode);

FileDialog.Mode getMode();

VBoxContainer getVbox();

LineEdit getLineEdit();

void setAccess(long access);

FileDialog.Access getAccess();

void setShowHiddenFiles(bool show);

bool isShowingHiddenFiles();

void _selectDrive(long arg0);

void _makeDir();

void _makeDirConfirm();

void _updateFileList();

void _updateDir();

void _goUp();

void deselectItems();

void invalidate();

bool modeOverridesTitle [@property getter];

bool modeOverridesTitle [@property setter];

FileDialog.Mode mode [@property getter];

long mode [@property setter];

FileDialog.Access access [@property getter];

long access [@property setter];

PoolStringArray filters [@property getter];

PoolStringArray filters [@property setter];

bool showHiddenFiles [@property getter];

bool showHiddenFiles [@property setter];

String currentDir [@property getter];

String currentDir [@property setter];

String currentFile [@property getter];

String currentFile [@property setter];

String currentPath [@property getter];

String currentPath [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Access enum Access
Constants enum Constants
Mode enum Mode

Functions

_actionPressed void _actionPressed()
_cancelPressed void _cancelPressed()
_dirEntered void _dirEntered(StringArg0 arg0)
_fileEntered void _fileEntered(StringArg0 arg0)
_filterSelected void _filterSelected(long arg0)
_goUp void _goUp()
_makeDir void _makeDir()
_makeDirConfirm void _makeDirConfirm()
_saveConfirmPressed void _saveConfirmPressed()
_selectDrive void _selectDrive(long arg0)
_treeItemActivated void _treeItemActivated()
_treeMultiSelected void _treeMultiSelected(GodotObject arg0, long arg1, bool arg2)
_treeSelected void _treeSelected()
_unhandledInput void _unhandledInput(InputEvent arg0)
_updateDir void _updateDir()
_updateFileList void _updateFileList()
addFilter void addFilter(StringArg0 filter): Add a custom filter. Example: add_filter("*.png ; PNG Images")
clearFilters void clearFilters(): Clear all the added filters in the dialog.
deselectItems void deselectItems(): Clear currently selected items in the dialog.
getAccess FileDialog.Access getAccess()
getCurrentDir String getCurrentDir()
getCurrentFile String getCurrentFile()
getCurrentPath String getCurrentPath()
getFilters PoolStringArray getFilters()
getLineEdit LineEdit getLineEdit(): Returns the LineEdit for the selected file.
getMode FileDialog.Mode getMode()
getVbox VBoxContainer getVbox(): Return the vertical box container of the dialog, custom controls can be added to it.
invalidate void invalidate(): Invalidate and update the current dialog content list.
isModeOverridingTitle bool isModeOverridingTitle()
isShowingHiddenFiles bool isShowingHiddenFiles()
opAssign FileDialog opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(FileDialog other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
setAccess void setAccess(long access)
setCurrentDir void setCurrentDir(StringArg0 dir)
setCurrentFile void setCurrentFile(StringArg0 file)
setCurrentPath void setCurrentPath(StringArg0 path)
setFilters void setFilters(PoolStringArray filters)
setMode void setMode(long mode)
setModeOverridesTitle void setModeOverridesTitle(bool _override)
setShowHiddenFiles void setShowHiddenFiles(bool show)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

access FileDialog.Access access [@property getter]
long access [@property setter]: The file system access scope. See enum Access constants.
currentDir String currentDir [@property getter]
String currentDir [@property setter]: The current working directory of the file dialog.
currentFile String currentFile [@property getter]
String currentFile [@property setter]: The currently selected file of the file dialog.
currentPath String currentPath [@property getter]
String currentPath [@property setter]: The currently selected file path of the file dialog.
filters PoolStringArray filters [@property getter]
PoolStringArray filters [@property setter]: Set file type filters. This example shows only .png and .gd files set_filters(PoolStringArray($(D "*.png ; PNG Images","*.gd ; GD Script"))).
mode FileDialog.Mode mode [@property getter]
long mode [@property setter]: Set dialog to open or save mode, changes selection behavior. See enum Mode constants.
modeOverridesTitle bool modeOverridesTitle [@property getter]
bool modeOverridesTitle [@property setter]: If true, changing the Mode property will set the window title accordingly (e. g. setting mode to MODE_OPEN_FILE will change the window title to "Open a File").
showHiddenFiles bool showHiddenFiles [@property getter]
bool showHiddenFiles [@property setter]: If true, the dialog will show hidden files.

Static functions

_new FileDialog _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot filedialog structs

FileDialog