FileChooser

gtk.file_chooser.FileChooser is an interface that can be implemented by file selection widgets.

In GTK, the main objects that implement this interface are gtk.file_chooser_widget.FileChooserWidget and gtk.file_chooser_dialog.FileChooserDialog.

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

gtk.file_chooser.FileChooser 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 gtk.file_chooser.FileChooser, your program can get the selected filenames as gio.file.Files.

Adding options

You can add extra widgets to a file chooser to provide options that are not present in the default design, by using gtk.file_chooser.FileChooser.addChoice. 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.

More...

interface FileChooser {

void addChoice(string id, string label, string[] options, string[] optionLabels);

void addFilter(gtk.file_filter.FileFilter filter);

bool addShortcutFolder(gio.file.File folder);

gtk.types.FileChooserAction getAction();

string getChoice(string id);

bool getCreateFolders();

gio.file.File getCurrentFolder();

string getCurrentName();

gio.file.File getFile();

gio.list_model.ListModel getFiles();

gtk.file_filter.FileFilter getFilter();

gio.list_model.ListModel getFilters();

bool getSelectMultiple();

gio.list_model.ListModel getShortcutFolders();

void removeChoice(string id);

void removeFilter(gtk.file_filter.FileFilter filter);

bool removeShortcutFolder(gio.file.File folder);

void setAction(gtk.types.FileChooserAction action);

void setChoice(string id, string option);

void setCreateFolders(bool createFolders);

bool setCurrentFolder(gio.file.File file);

void setCurrentName(string name);

bool setFile(gio.file.File file);

void setFilter(gtk.file_filter.FileFilter filter);

void setSelectMultiple(bool selectMultiple);

}

Members

Functions

addChoice void addChoice(string id, string label, string[] options, string[] optionLabels): Adds a 'choice' to the file chooser.
addFilter void addFilter(gtk.file_filter.FileFilter filter): Adds filter to the list of filters that the user can select between.
addShortcutFolder bool addShortcutFolder(gio.file.File folder): Adds a folder to be displayed with the shortcut folders in a file chooser.
getAction gtk.types.FileChooserAction getAction(): Gets the type of operation that the file chooser is performing.
getChoice string getChoice(string id): Gets the currently selected option in the 'choice' with the given ID.
getCreateFolders bool getCreateFolders(): Gets whether file chooser will offer to create new folders.
getCurrentFolder gio.file.File getCurrentFolder(): Gets the current folder of chooser as gio.file.File.
getCurrentName string getCurrentName(): Gets the current name in the file selector, as entered by the user.
getFile gio.file.File getFile(): Gets the gio.file.File for the currently selected file in the file selector.
getFiles gio.list_model.ListModel getFiles(): Lists all the selected files and subfolders in the current folder of chooser as gio.file.File.
getFilter gtk.file_filter.FileFilter getFilter(): Gets the current filter.
getFilters gio.list_model.ListModel getFilters(): Gets the current set of user-selectable filters, as a list model.
getSelectMultiple bool getSelectMultiple(): Gets whether multiple files can be selected in the file chooser.
getShortcutFolders gio.list_model.ListModel getShortcutFolders(): Queries the list of shortcut folders in the file chooser.
removeChoice void removeChoice(string id): Removes a 'choice' that has been added with gtk.file_chooser.FileChooser.addChoice.
removeFilter void removeFilter(gtk.file_filter.FileFilter filter): Removes filter from the list of filters that the user can select between.
removeShortcutFolder bool removeShortcutFolder(gio.file.File folder): Removes a folder from the shortcut folders in a file chooser.
setAction void setAction(gtk.types.FileChooserAction action): Sets the type of operation that the chooser is performing.
setChoice void setChoice(string id, string option): Selects an option in a 'choice' that has been added with gtk.file_chooser.FileChooser.addChoice.
setCreateFolders void setCreateFolders(bool createFolders): Sets whether file chooser will offer to create new folders.
setCurrentFolder bool setCurrentFolder(gio.file.File file): Sets the current folder for chooser from a gio.file.File.
setCurrentName void setCurrentName(string name): Sets the current name in the file selector, as if entered by the user.
setFile bool setFile(gio.file.File file): Sets file as the current filename for the file chooser.
setFilter void setFilter(gtk.file_filter.FileFilter filter): Sets the current filter.
setSelectMultiple void setSelectMultiple(bool selectMultiple): Sets whether multiple files can be selected in the file chooser.

Detailed Description

Deprecated: Use gtk.file_dialog.FileDialog instead

gtk file_chooser interfaces

FileChooser