FileDialog

package
v0.0.0-...-c858641 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 14, 2025 License: MIT Imports: 29 Imported by: 0

Documentation

Overview

graphics.gd/classdb/FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. graphics.gd/classdb/FileDialog automatically sets its window title according to the Instance.FileMode. If you want to use a custom title, disable this by setting Instance.ModeOverridesTitle to false.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Access 

type Access int //gd:FileDialog.Access

const (
	// The dialog only allows accessing files under the [graphics.gd/classdb/Resource] path (res://).
	AccessResources Access = 0
	// The dialog only allows accessing files under user data path (user://).
	AccessUserdata Access = 1
	// The dialog allows accessing files on the whole file system.
	AccessFilesystem Access = 2
)

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any 

type Any interface {
	gd.IsClass
	AsFileDialog() Instance
}

type Expanded 

type Expanded [1]gdclass.FileDialog

func (Expanded) AddFilter 

func (self Expanded) AddFilter(filter string, description string)

Adds a comma-delimited file name 'filter' option to the graphics.gd/classdb/FileDialog 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 "*.png, *.jpg" and a 'description' of "Images" results in filter text "Images (*.png, *.jpg)".

type Extension 

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsAcceptDialog 

func (self *Extension[T]) AsAcceptDialog() AcceptDialog.Instance

func (*Extension[T]) AsConfirmationDialog 

func (self *Extension[T]) AsConfirmationDialog() ConfirmationDialog.Instance

func (*Extension[T]) AsFileDialog 

func (self *Extension[T]) AsFileDialog() Instance

func (*Extension[T]) AsNode 

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject 

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsViewport 

func (self *Extension[T]) AsViewport() Viewport.Instance

func (*Extension[T]) AsWindow 

func (self *Extension[T]) AsWindow() Window.Instance

type FileMode 

type FileMode int //gd:FileDialog.FileMode

const (
	// The dialog allows selecting one, and only one file.
	FileModeOpenFile FileMode = 0
	// The dialog allows selecting multiple files.
	FileModeOpenFiles FileMode = 1
	// The dialog only allows selecting a directory, disallowing the selection of any file.
	FileModeOpenDir FileMode = 2
	// The dialog allows selecting one file or directory.
	FileModeOpenAny FileMode = 3
	// The dialog will warn when a file exists.
	FileModeSaveFile FileMode = 4
)

type ID 

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance 

func (id ID) Instance() (Instance, bool)

type Instance 

type Instance [1]gdclass.FileDialog

Instance of the class with convieniently typed arguments and results. 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) Access 

func (self Instance) Access() Access

func (Instance) AddFilter 

func (self Instance) AddFilter(filter string)

Adds a comma-delimited file name 'filter' option to the graphics.gd/classdb/FileDialog 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 "*.png, *.jpg" and a 'description' of "Images" results in filter text "Images (*.png, *.jpg)".

func (Instance) AddOption 

func (self Instance) AddOption(name string, values []string, default_value_index int)

Adds an additional graphics.gd/classdb/OptionButton to the file dialog. If 'values' is empty, a graphics.gd/classdb/CheckBox is added instead.

'default_value_index' should be an index of the value in the 'values'. If 'values' is empty it should be either 1 (checked), or 0 (unchecked).

func (Instance) AsAcceptDialog 

func (self Instance) AsAcceptDialog() AcceptDialog.Instance

func (Instance) AsConfirmationDialog 

func (self Instance) AsConfirmationDialog() ConfirmationDialog.Instance

func (Instance) AsFileDialog 

func (self Instance) AsFileDialog() Instance

func (Instance) AsNode 

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsViewport 

func (self Instance) AsViewport() Viewport.Instance

func (Instance) AsWindow 

func (self Instance) AsWindow() Window.Instance

func (Instance) ClearFilenameFilter 

func (self Instance) ClearFilenameFilter()

Clear the filter for file names.

func (Instance) ClearFilters 

func (self Instance) ClearFilters()

Clear all the added filters in the dialog.

func (Instance) CurrentDir 

func (self Instance) CurrentDir() string

func (Instance) CurrentFile 

func (self Instance) CurrentFile() string

func (Instance) CurrentPath 

func (self Instance) CurrentPath() string

func (Instance) DeselectAll 

func (self Instance) DeselectAll()

Clear all currently selected items in the dialog.

func (Instance) FileMode 

func (self Instance) FileMode() FileMode

func (Instance) FilenameFilter 

func (self Instance) FilenameFilter() string

func (Instance) Filters 

func (self Instance) Filters() []string

func (Instance) GetLineEdit 

func (self Instance) GetLineEdit() LineEdit.Instance

Returns the LineEdit for the selected file.

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 graphics.gd/classdb/CanvasItem.Instance.Visible property.

func (Instance) GetOptionDefault 

func (self Instance) GetOptionDefault(option int) int

Returns the default value index of the graphics.gd/classdb/OptionButton or graphics.gd/classdb/CheckBox with index 'option'.

func (Instance) GetOptionName 

func (self Instance) GetOptionName(option int) string

Returns the name of the graphics.gd/classdb/OptionButton or graphics.gd/classdb/CheckBox with index 'option'.

func (Instance) GetOptionValues 

func (self Instance) GetOptionValues(option int) []string

Returns an array of values of the graphics.gd/classdb/OptionButton with index 'option'.

func (Instance) GetSelectedOptions 

func (self Instance) GetSelectedOptions() map[string]int

Returns a data structure with the selected values of the additional [graphics.gd/classdb/OptionButton]s and/or [graphics.gd/classdb/CheckBox]es. data structure keys are names and values are selected value indices.

func (Instance) GetVbox 

func (self Instance) GetVbox() VBoxContainer.Instance

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 graphics.gd/classdb/CanvasItem.Instance.Visible property.

Note: Changes to this node are ignored by native file dialogs, use Instance.AddOption to add custom elements to the dialog instead.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) Invalidate 

func (self Instance) Invalidate()

Invalidate and update the current dialog content list.

Note: This method does nothing on native file dialogs.

func (Instance) ModeOverridesTitle 

func (self Instance) ModeOverridesTitle() bool

func (Instance) OnDirSelected 

func (self Instance) OnDirSelected(cb func(dir string), flags ...Signal.Flags)

func (Instance) OnFileSelected 

func (self Instance) OnFileSelected(cb func(path string), flags ...Signal.Flags)

func (Instance) OnFilenameFilterChanged 

func (self Instance) OnFilenameFilterChanged(cb func(filter string), flags ...Signal.Flags)

func (Instance) OnFilesSelected 

func (self Instance) OnFilesSelected(cb func(paths []string), flags ...Signal.Flags)

func (Instance) OptionCount 

func (self Instance) OptionCount() int

func (Instance) RootSubfolder 

func (self Instance) RootSubfolder() string

func (Instance) SetAccess 

func (self Instance) SetAccess(value Access)

func (Instance) SetCurrentDir 

func (self Instance) SetCurrentDir(value string)

func (Instance) SetCurrentFile 

func (self Instance) SetCurrentFile(value string)

func (Instance) SetCurrentPath 

func (self Instance) SetCurrentPath(value string)

func (Instance) SetFileMode 

func (self Instance) SetFileMode(value FileMode)

func (Instance) SetFilenameFilter 

func (self Instance) SetFilenameFilter(value string)

func (Instance) SetFilters 

func (self Instance) SetFilters(value []string)

func (Instance) SetModeOverridesTitle 

func (self Instance) SetModeOverridesTitle(value bool)

func (*Instance) SetObject 

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetOptionCount 

func (self Instance) SetOptionCount(value int)

func (Instance) SetOptionDefault 

func (self Instance) SetOptionDefault(option int, default_value_index int)

Sets the default value index of the graphics.gd/classdb/OptionButton or graphics.gd/classdb/CheckBox with index 'option'.

func (Instance) SetOptionName 

func (self Instance) SetOptionName(option int, name string)

Sets the name of the graphics.gd/classdb/OptionButton or graphics.gd/classdb/CheckBox with index 'option'.

func (Instance) SetOptionValues 

func (self Instance) SetOptionValues(option int, values []string)

Sets the option values of the graphics.gd/classdb/OptionButton with index 'option'.

func (Instance) SetRootSubfolder 

func (self Instance) SetRootSubfolder(value string)

func (Instance) SetShowHiddenFiles 

func (self Instance) SetShowHiddenFiles(value bool)

func (Instance) SetUseNativeDialog 

func (self Instance) SetUseNativeDialog(value bool)

func (Instance) ShowHiddenFiles 

func (self Instance) ShowHiddenFiles() bool

func (Instance) UseNativeDialog 

func (self Instance) UseNativeDialog() bool

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.