gtk4/org.gtkkn.bindings.gtk/FileDialog

FileDialog

open class FileDialog(pointer: <Error class: unknown class><<Error class: unknown class>>)

A GtkFileDialog object collects the arguments that are needed to present a file chooser dialog to the user, such as a title for the dialog and whether it should be modal.

The dialog is shown with method@Gtk.FileDialog.open, method@Gtk.FileDialog.save, etc.

Since

4.10

Constructors

FileDialog

constructor()

Creates a new GtkFileDialog object.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

acceptLabel

open var acceptLabel: String?

Label for the file chooser's accept button.

defaultFilter

open var defaultFilter: FileFilter?

The default filter, that is, the filter that is initially active in the file chooser dialog.

filters

open var filters: <Error class: unknown class>?

The list of filters.

gtkFileDialogPointer

val gtkFileDialogPointer: <Error class: unknown class><<Error class: unknown class>>

initialFile

open var initialFile: <Error class: unknown class>?

The initial file, that is, the file that is initially selected in the file chooser dialog

initialFolder

open var initialFolder: <Error class: unknown class>?

The initial folder, that is, the directory that is initially opened in the file chooser dialog

initialName

open var initialName: String?

The initial name, that is, the filename that is initially selected in the file chooser dialog.

modal

open var modal: Boolean

Whether the file chooser dialog is modal.

title

open var title: String

A title that may be shown on the file chooser dialog.

Functions

getAcceptLabel

open fun getAcceptLabel(): String?

Retrieves the text used by the dialog on its accept button.

getDefaultFilter

open fun getDefaultFilter(): FileFilter?

Gets the filter that will be selected by default in the file chooser dialog.

getFilters

open fun getFilters(): <Error class: unknown class>?

Gets the filters that will be offered to the user in the file chooser dialog.

getInitialFile

open fun getInitialFile(): <Error class: unknown class>?

Gets the file that will be initially selected in the file chooser dialog.

getInitialFolder

open fun getInitialFolder(): <Error class: unknown class>?

Gets the folder that will be set as the initial folder in the file chooser dialog.

getInitialName

open fun getInitialName(): String?

Gets the name for the file that should be initially set.

getModal

open fun getModal(): Boolean

Returns whether the file chooser dialog blocks interaction with the parent window while it is presented.

getTitle

open fun getTitle(): String

Returns the title that will be shown on the file chooser dialog.

open

open fun open(parent: Window? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>)

This function initiates a file selection operation by presenting a file chooser dialog to the user.

openFinish

open fun openFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>?>

Finishes the method@Gtk.FileDialog.open call and returns the resulting file.

openMultiple

open fun openMultiple(parent: Window? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>)

This function initiates a multi-file selection operation by presenting a file chooser dialog to the user.

openMultipleFinish

open fun openMultipleFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>?>

Finishes the method@Gtk.FileDialog.open call and returns the resulting files in a GListModel.

save

open fun save(parent: Window? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>)

This function initiates a file save operation by presenting a file chooser dialog to the user.

saveFinish

open fun saveFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>?>

Finishes the method@Gtk.FileDialog.save call and returns the resulting file.

selectFolder

open fun selectFolder(parent: Window? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>)

This function initiates a directory selection operation by presenting a file chooser dialog to the user.

selectFolderFinish

open fun selectFolderFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>?>

Finishes the method@Gtk.FileDialog.select_folder call and returns the resulting file.

selectMultipleFolders

open fun selectMultipleFolders(parent: Window? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>)

This function initiates a multi-directory selection operation by presenting a file chooser dialog to the user.

selectMultipleFoldersFinish

open fun selectMultipleFoldersFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>?>

Finishes the method@Gtk.FileDialog.select_multiple_folders call and returns the resulting files in a GListModel.

setAcceptLabel

open fun setAcceptLabel(acceptLabel: String? = null)

Sets the label shown on the file chooser's accept button.

setDefaultFilter

open fun setDefaultFilter(filter: FileFilter? = null)

Sets the filter that will be selected by default in the file chooser dialog.

setFilters

open fun setFilters(filters: <Error class: unknown class>? = null)

Sets the filters that will be offered to the user in the file chooser dialog.

setInitialFile

open fun setInitialFile(file: <Error class: unknown class>? = null)

Sets the file that will be initially selected in the file chooser dialog.

setInitialFolder

open fun setInitialFolder(folder: <Error class: unknown class>? = null)

Sets the folder that will be set as the initial folder in the file chooser dialog.

setInitialName

open fun setInitialName(name: String? = null)

Sets the name for the file that should be initially set. For saving dialogs, this will usually be pre-entered into the name field.

setModal

open fun setModal(modal: Boolean)

Sets whether the file chooser dialog blocks interaction with the parent window while it is presented.

setTitle

open fun setTitle(title: String)

Sets the title that will be shown on the file chooser dialog.