gtk4/org.gtkkn.bindings.gtk/FileChooser

FileChooser

interface FileChooser

GtkFileChooser is an interface that can be implemented by file selection widgets.

In GTK, the main objects that implement this interface are class@Gtk.FileChooserWidget and class@Gtk.FileChooserDialog.

You do not need to write an object that implements the GtkFileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

GtkFileChooser allows for shortcuts to various places in the filesystem. In the default implementation these are displayed in the left pane. It may be a bit confusing at first that these shortcuts come from various sources and in various flavours, so lets explain the terminology here:

Bookmarks: are created by the user, by dragging folders from the right pane to the left pane, or by using the “Add”. Bookmarks can be renamed and deleted by the user.
Shortcuts: can be provided by the application. For example, a Paint program may want to add a shortcut for a Clipart folder. Shortcuts cannot be modified by the user.
Volumes: are provided by the underlying filesystem abstraction. They are the “roots” of the filesystem.

File Names and Encodings

When the user is finished selecting files in a GtkFileChooser, your program can get the selected filenames as GFiles.

Adding options

You can add extra widgets to a file chooser to provide options that are not present in the default design, by using method@Gtk.FileChooser.add_choice. Each choice has an identifier and a user visible label; additionally, each choice can have multiple options. If a choice has no option, it will be rendered as a check button with the given label; if a choice has options, it will be rendered as a combo box.

Skipped during bindings generation

method filter: Property TypeInfo of getter and setter do not match

Inheritors

FileChooserDialog

FileChooserNative

FileChooserWidget

Types

object Companion

Properties

open var action: FileChooserAction

The type of operation that the file chooser is performing.

open var createFolders: Boolean

Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode will offer the user to create new folders.

open val filters: <Error class: unknown class>

A GListModel containing the filters that have been added with gtk_file_chooser_add_filter().

gtkFileChooserPointer

abstract val gtkFileChooserPointer: <Error class: unknown class><<Error class: unknown class>>

open var selectMultiple: Boolean

Whether to allow multiple files to be selected.

shortcutFolders

open val shortcutFolders: <Error class: unknown class>

A GListModel containing the shortcut folders that have been added with gtk_file_chooser_add_shortcut_folder().

Functions

open fun addChoice(id: String, label: String, options: List<String>? = null, optionLabels: List<String>? = null)

Adds a 'choice' to the file chooser.

open fun addFilter(filter: FileFilter)

Adds @filter to the list of filters that the user can select between.

addShortcutFolder

open fun addShortcutFolder(folder: <Error class: unknown class>): <Error class: unknown class><Boolean>

Adds a folder to be displayed with the shortcut folders in a file chooser.

open fun getAction(): FileChooserAction

Gets the type of operation that the file chooser is performing.

open fun getChoice(id: String): String?

Gets the currently selected option in the 'choice' with the given ID.

getCreateFolders

open fun getCreateFolders(): Boolean

Gets whether file chooser will offer to create new folders.

getCurrentFolder

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

Gets the current folder of @chooser as GFile.

open fun getCurrentName(): String?

Gets the current name in the file selector, as entered by the user.

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

Gets the GFile for the currently selected file in the file selector.

open fun getFiles(): <Error class: unknown class>

Lists all the selected files and subfolders in the current folder of @chooser as GFile.

open fun getFilter(): FileFilter?

Gets the current filter.

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

Gets the current set of user-selectable filters, as a list model.

getSelectMultiple

open fun getSelectMultiple(): Boolean

Gets whether multiple files can be selected in the file chooser.

getShortcutFolders

open fun getShortcutFolders(): <Error class: unknown class>

Queries the list of shortcut folders in the file chooser.

open fun removeChoice(id: String)

Removes a 'choice' that has been added with gtk_file_chooser_add_choice().

open fun removeFilter(filter: FileFilter)

Removes @filter from the list of filters that the user can select between.

removeShortcutFolder

open fun removeShortcutFolder(folder: <Error class: unknown class>): <Error class: unknown class><Boolean>

Removes a folder from the shortcut folders in a file chooser.

open fun setAction(action: FileChooserAction)

Sets the type of operation that the chooser is performing.

open fun setChoice(id: String, option: String)

Selects an option in a 'choice' that has been added with gtk_file_chooser_add_choice().

setCreateFolders

open fun setCreateFolders(createFolders: Boolean)

Sets whether file chooser will offer to create new folders.

setCurrentFolder

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

Sets the current folder for @chooser from a GFile.

open fun setCurrentName(name: String)

Sets the current name in the file selector, as if entered by the user.

open fun setFile(file: <Error class: unknown class>): <Error class: unknown class><Boolean>

Sets @file as the current filename for the file chooser.

open fun setFilter(filter: FileFilter)

Sets the current filter.

setSelectMultiple

open fun setSelectMultiple(selectMultiple: Boolean)

Sets whether multiple files can be selected in the file chooser.