FileChooserNative

gtk.FileChooserNative is an abstraction of a dialog box suitable for use with “File/Open” or “File/Save as” commands. By default, this just uses a gtk.FileChooserDialog to implement the actual dialog. However, on certain platforms, such as Windows and macOS, the native platform file chooser is used instead. When the application is running in a sandboxed environment without direct filesystem access (such as Flatpak), gtk.FileChooserNative may call the proper APIs (portals) to let the user choose a file and make it available to the application.

While the API of gtk.FileChooserNative closely mirrors gtk.FileChooserDialog, the main difference is that there is no access to any gtk.Window or gtk.Widget for the dialog. This is required, as there may not be one in the case of a platform native dialog. Showing, hiding and running the dialog is handled by the gtk.NativeDialog functions.

Typical usage

In the simplest of cases, you can the following code to use gtk.FileChooserDialog to select a file for opening:

|[ GtkFileChooserNative *native; GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN; gint res;

native = gtk_file_chooser_native_new ("Open File", parent_window, action, "_Open", "_Cancel");

res = gtk_native_dialog_run (GTK_NATIVE_DIALOG (native)); if (res == GTK_RESPONSE_ACCEPT) { char *filename; GtkFileChooser *chooser = GTK_FILE_CHOOSER (native); filename = gtk_file_chooser_get_filename (chooser); open_file (filename); g_free (filename); }

g_object_unref (native);

To use a dialog for saving, you can use this:

|[
GtkFileChooserNative *native;
GtkFileChooser *chooser;
GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_SAVE;
gint res;

native = gtk_file_chooser_native_new ("Save File",
parent_window,
action,
"_Save",
"_Cancel");
chooser = GTK_FILE_CHOOSER (native);

gtk_file_chooser_set_do_overwrite_confirmation (chooser, TRUE);

if (user_edited_a_new_document)
gtk_file_chooser_set_current_name (chooser,
_("Untitled document"));
else
gtk_file_chooser_set_filename (chooser,
existing_filename);

res = gtk_native_dialog_run (GTK_NATIVE_DIALOG (native));
if (res == GTK_RESPONSE_ACCEPT)
{
char *filename;

filename = gtk_file_chooser_get_filename (chooser);
save_to_file (filename);
g_free (filename);
}

g_object_unref (native);

For more information on how to best set up a file dialog, see gtk.FileChooserDialog

Response Codes

gtk.FileChooserNative inherits from gtk.NativeDialog, which means it will return GTK_RESPONSE_ACCEPT if the user accepted, and GTK_RESPONSE_CANCEL if he pressed cancel. It can also return GTK_RESPONSE_DELETE_EVENT if the window was unexpectedly closed.

Differences from gtk.FileChooserDialog ## {[gtkfilechooserdialognative-difference|gtkfilechooserdialognative-differences]}

There are a few things in the GtkFileChooser API that are not possible to use with gtk.FileChooserNative, as such use would prohibit the use of a native dialog.

There is no support for the signals that are emitted when the user navigates in the dialog, including: * current-folder-changed * selection-changed * file-activated * confirm-overwrite

You can also not use the methods that directly control user navigation: * gtk_file_chooser_unselect_filename() * gtk_file_chooser_select_all() * gtk_file_chooser_unselect_all()

If you need any of the above you will have to use gtk.FileChooserDialog directly.

No operations that change the the dialog work while the dialog is visible. Set all the properties that are required before showing the dialog.

Win32 details

On windows the IFileDialog implementation (added in Windows Vista) is used. It supports many of the features that gtk.FileChooserDialog does, but there are some things it does not handle:

* Extra widgets added with gtk_file_chooser_set_extra_widget().

* Use of custom previews by connecting to update-preview.

* Any gtk.FileFilter added using a mimetype or custom filter.

If any of these features are used the regular gtk.FileChooserDialog will be used in place of the native one.

Portal details

When the org.freedesktop.portal.FileChooser portal is available on the session bus, it is used to bring up an out-of-process file chooser. Depending on the kind of session the application is running in, this may or may not be a GTK+ file chooser. In this situation, the following things are not supported and will be silently ignored:

* Extra widgets added with gtk_file_chooser_set_extra_widget().

* Use of custom previews by connecting to update-preview.

* Any gtk.FileFilter added with a custom filter.

macOS details

On macOS the NSSavePanel and NSOpenPanel classes are used to provide native file chooser dialogs. Some features provided by gtk.FileChooserDialog are not supported:

* Extra widgets added with gtk_file_chooser_set_extra_widget(), unless the widget is an instance of GtkLabel, in which case the label text will be used to set the NSSavePanel message instance property.

* Use of custom previews by connecting to update-preview.

* Any gtk.FileFilter added with a custom filter.

* Shortcut folders.

class FileChooserNative : NativeDialog , FileChooserIF {

protected

GtkFileChooserNative* gtkFileChooserNative;

GtkFileChooserNative* getFileChooserNativeStruct(bool transferOwnership);

void* getStruct();

this(GtkFileChooserNative* gtkFileChooserNative, bool ownedRef);

static GType getType();

this(string title, Window parent, GtkFileChooserAction action, string acceptLabel, string cancelLabel);

string getAcceptLabel();

string getCancelLabel();

void setAcceptLabel(string acceptLabel);

void setCancelLabel(string cancelLabel);

}

Constructors

this this(GtkFileChooserNative* gtkFileChooserNative, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string title, Window parent, GtkFileChooserAction action, string acceptLabel, string cancelLabel): Creates a new gtk.FileChooserNative

Members

Functions

getAcceptLabel string getAcceptLabel(): Retrieves the custom label text for the accept button.
getCancelLabel string getCancelLabel(): Retrieves the custom label text for the cancel button.
getFileChooserNativeStruct GtkFileChooserNative* getFileChooserNativeStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setAcceptLabel void setAcceptLabel(string acceptLabel): Sets the custom label text for the accept button.
setCancelLabel void setCancelLabel(string cancelLabel): Sets the custom label text for the cancel button.

Static functions

getType GType getType()

Variables

gtkFileChooserNative GtkFileChooserNative* gtkFileChooserNative;: the main Gtk struct

Inherited Members

From NativeDialog

gtkNativeDialog GtkNativeDialog* gtkNativeDialog;: the main Gtk struct
getNativeDialogStruct GtkNativeDialog* getNativeDialogStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
destroy void destroy(): Destroys a dialog.
getModal bool getModal(): Returns whether the dialog is modal. See NativeDialog.setModal.
getTitle string getTitle(): Gets the title of the gtk.NativeDialog
getTransientFor Window getTransientFor(): Fetches the transient parent for this window. See NativeDialog.setTransientFor.
getVisible bool getVisible(): Determines whether the dialog is visible.
hide void hide(): Hides the dialog if it is visilbe, aborting any interaction. Once this is called the response signal will not be emitted until after the next call to NativeDialog.show.
run int run(): Blocks in a recursive main loop until self emits the response signal. It then returns the response ID from the ::response signal emission.
setModal void setModal(bool modal): Sets a dialog modal or non-modal. Modal dialogs prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use NativeDialog.setTransientFor to make the dialog transient for the parent; most [window managers][gtk-X11-arch] will then disallow lowering the dialog below the parent.
setTitle void setTitle(string title): Sets the title of the gtk.NativeDialog
setTransientFor void setTransientFor(Window parent): Dialog windows should be set transient for the main application window they were spawned from. This allows [window managers][gtk-X11-arch] to e.g. keep the dialog on top of the main window, or center the dialog over the main window.
show void show(): Shows the dialog on the display, allowing the user to interact with it. When the user accepts the state of the dialog the dialog will be automatically hidden and the response signal will be emitted.
addOnResponse gulong addOnResponse(void delegate(int, NativeDialog) dlg, ConnectFlags connectFlags): Emitted when the user responds to the dialog.

From FileChooserIF

getFileChooserStruct GtkFileChooser* getFileChooserStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
addChoice void addChoice(string id, string label, string[] options, string[] optionLabels): Adds a 'choice' to the file chooser. This is typically implemented as a combobox or, for boolean choices, as a checkbutton. You can select a value using gtk_file_chooser_set_choice() before the dialog is shown, and you can obtain the user-selected value in the ::response signal handler using gtk_file_chooser_get_choice().
addFilter void addFilter(FileFilter filter): Adds filter to the list of filters that the user can select between. When a filter is selected, only files that are passed by that filter are displayed.
addShortcutFolder bool addShortcutFolder(string folder): Adds a folder to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a “/usr/share/mydrawprogram/Clipart” folder to the volume list.
addShortcutFolderUri bool addShortcutFolderUri(string uri): Adds a folder URI to be displayed with the shortcut folders in a file chooser. Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a “file:///usr/share/mydrawprogram/Clipart” folder to the volume list.
getFileChooserAction GtkFileChooserAction getFileChooserAction(): Gets the type of operation that the file chooser is performing; see gtk_file_chooser_set_action().
getChoice string getChoice(string id): Gets the currently selected option in the 'choice' with the given ID.
getCreateFolders bool getCreateFolders(): Gets whether file choser will offer to create new folders. See gtk_file_chooser_set_create_folders().
getCurrentFolder string getCurrentFolder(): Gets the current folder of chooser as a local filename. See gtk_file_chooser_set_current_folder().
getCurrentFolderFile FileIF getCurrentFolderFile(): Gets the current folder of chooser as GFile See gtk_file_chooser_get_current_folder_uri().
getCurrentFolderUri string getCurrentFolderUri(): Gets the current folder of chooser as an URI. See gtk_file_chooser_set_current_folder_uri().
getCurrentName string getCurrentName(): Gets the current name in the file selector, as entered by the user in the text entry for “Name”.
getDoOverwriteConfirmation bool getDoOverwriteConfirmation(): Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.
getExtraWidget Widget getExtraWidget(): Gets the current extra widget; see gtk_file_chooser_set_extra_widget().
getFile FileIF getFile(): Gets the GFile for the currently selected file in the file selector. If multiple files are selected, one of the files will be returned at random.
getFilename string getFilename(): Gets the filename for the currently selected file in the file selector. The filename is returned as an absolute path. If multiple files are selected, one of the filenames will be returned at random.
getFilenames ListSG getFilenames(): Lists all the selected files and subfolders in the current folder of chooser. The returned names are full absolute paths. If files in the current folder cannot be represented as local filenames they will be ignored. (See gtk_file_chooser_get_uris())
getFiles ListSG getFiles(): Lists all the selected files and subfolders in the current folder of chooser as GFile An internal function, see gtk_file_chooser_get_uris().
getFilter FileFilter getFilter(): Gets the current filter; see gtk_file_chooser_set_filter().
getLocalOnly bool getLocalOnly(): Gets whether only local files can be selected in the file selector. See gtk_file_chooser_set_local_only()
getPreviewFile FileIF getPreviewFile(): Gets the GFile that should be previewed in a custom preview Internal function, see gtk_file_chooser_get_preview_uri().
getPreviewFilename string getPreviewFilename(): Gets the filename that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget().
getPreviewUri string getPreviewUri(): Gets the URI that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget().
getPreviewWidget Widget getPreviewWidget(): Gets the current preview widget; see gtk_file_chooser_set_preview_widget().
getPreviewWidgetActive bool getPreviewWidgetActive(): Gets whether the preview widget set by gtk_file_chooser_set_preview_widget() should be shown for the current filename. See gtk_file_chooser_set_preview_widget_active().
getSelectMultiple bool getSelectMultiple(): Gets whether multiple files can be selected in the file selector. See gtk_file_chooser_set_select_multiple().
getShowHidden bool getShowHidden(): Gets whether hidden files and folders are displayed in the file selector. See gtk_file_chooser_set_show_hidden().
getUri string getUri(): Gets the URI for the currently selected file in the file selector. If multiple files are selected, one of the filenames will be returned at random.
getUris ListSG getUris(): Lists all the selected files and subfolders in the current folder of chooser. The returned names are full absolute URIs.
getUsePreviewLabel bool getUsePreviewLabel(): Gets whether a stock label should be drawn with the name of the previewed file. See gtk_file_chooser_set_use_preview_label().
listFilters ListSG listFilters(): Lists the current set of user-selectable filters; see gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
listShortcutFolderUris ListSG listShortcutFolderUris(): Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder_uri().
listShortcutFolders ListSG listShortcutFolders(): Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder().
removeChoice void removeChoice(string id): Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
removeFilter void removeFilter(FileFilter filter): Removes filter from the list of filters that the user can select between.
removeShortcutFolder bool removeShortcutFolder(string folder): Removes a folder from a file chooser’s list of shortcut folders.
removeShortcutFolderUri bool removeShortcutFolderUri(string uri): Removes a folder URI from a file chooser’s list of shortcut folders.
selectAll void selectAll(): Selects all the files in the current folder of a file chooser.
selectFile bool selectFile(FileIF file): Selects the file referred to by file. An internal function. See _gtk_file_chooser_select_uri().
selectFilename bool selectFilename(string filename): Selects a filename. If the file name isn’t in the current folder of chooser, then the current folder of chooser will be changed to the folder containing filename.
selectUri bool selectUri(string uri): Selects the file to by uri. If the URI doesn’t refer to a file in the current folder of chooser, then the current folder of chooser will be changed to the folder containing filename.
setFileChooserAction void setFileChooserAction(GtkFileChooserAction action): Sets the type of operation that the chooser is performing; the user interface is adapted to suit the selected action. For example, an option to create a new folder might be shown if the action is GTK_FILE_CHOOSER_ACTION_SAVE but not if the action is GTK_FILE_CHOOSER_ACTION_OPEN.
setChoice void setChoice(string id, string option): Selects an option in a 'choice' that has been added with gtk_file_chooser_add_choice(). For a boolean choice, the possible options are "true" and "false".
setCreateFolders void setCreateFolders(bool createFolders): Sets whether file choser will offer to create new folders. This is only relevant if the action is not set to be GTK_FILE_CHOOSER_ACTION_OPEN.
setCurrentFolder bool setCurrentFolder(string filename): Sets the current folder for chooser from a local filename. The user will be shown the full contents of the current folder, plus user interface elements for navigating to other folders.
setCurrentFolderFile bool setCurrentFolderFile(FileIF file): Sets the current folder for chooser from a GFile Internal function, see gtk_file_chooser_set_current_folder_uri().
setCurrentFolderUri bool setCurrentFolderUri(string uri): Sets the current folder for chooser from an URI. The user will be shown the full contents of the current folder, plus user interface elements for navigating to other folders.
setCurrentName void setCurrentName(string name): Sets the current name in the file selector, as if entered by the user. Note that the name passed in here is a UTF-8 string rather than a filename. This function is meant for such uses as a suggested name in a “Save As...” dialog. You can pass “Untitled.doc” or a similarly suitable suggestion for the name.
setDoOverwriteConfirmation void setDoOverwriteConfirmation(bool doOverwriteConfirmation): Sets whether a file chooser in GTK_FILE_CHOOSER_ACTION_SAVE mode will present a confirmation dialog if the user types a file name that already exists. This is FALSE by default.
setExtraWidget void setExtraWidget(Widget extraWidget): Sets an application-supplied widget to provide extra options to the user.
setFile bool setFile(FileIF file): Sets file as the current filename for the file chooser, by changing to the file’s parent folder and actually selecting the file in list. If the chooser is in GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name will also appear in the dialog’s file name entry.
setFilename bool setFilename(string filename): Sets filename as the current filename for the file chooser, by changing to the file’s parent folder and actually selecting the file in list; all other files will be unselected. If the chooser is in GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name will also appear in the dialog’s file name entry.
setFilter void setFilter(FileFilter filter): Sets the current filter; only the files that pass the filter will be displayed. If the user-selectable list of filters is non-empty, then the filter should be one of the filters in that list. Setting the current filter when the list of filters is empty is useful if you want to restrict the displayed set of files without letting the user change it.
setLocalOnly void setLocalOnly(bool localOnly): Sets whether only local files can be selected in the file selector. If local_only is TRUE (the default), then the selected file or files are guaranteed to be accessible through the operating systems native file system and therefore the application only needs to worry about the filename functions in GtkFileChooser, like gtk_file_chooser_get_filename(), rather than the URI functions like gtk_file_chooser_get_uri(),
setPreviewWidget void setPreviewWidget(Widget previewWidget): Sets an application-supplied widget to use to display a custom preview of the currently selected file. To implement a preview, after setting the preview widget, you connect to the update-preview signal, and call gtk_file_chooser_get_preview_filename() or gtk_file_chooser_get_preview_uri() on each change. If you can display a preview of the new file, update your widget and set the preview active using gtk_file_chooser_set_preview_widget_active(). Otherwise, set the preview inactive.
setPreviewWidgetActive void setPreviewWidgetActive(bool active): Sets whether the preview widget set by gtk_file_chooser_set_preview_widget() should be shown for the current filename. When active is set to false, the file chooser may display an internally generated preview of the current file or it may display no preview at all. See gtk_file_chooser_set_preview_widget() for more details.
setSelectMultiple void setSelectMultiple(bool selectMultiple): Sets whether multiple files can be selected in the file selector. This is only relevant if the action is set to be GTK_FILE_CHOOSER_ACTION_OPEN or GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
setShowHidden void setShowHidden(bool showHidden): Sets whether hidden files and folders are displayed in the file selector.
setUri bool setUri(string uri): Sets the file referred to by uri as the current file for the file chooser, by changing to the URI’s parent folder and actually selecting the URI in the list. If the chooser is GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI’s base name will also appear in the dialog’s file name entry.
setUsePreviewLabel void setUsePreviewLabel(bool useLabel): Sets whether the file chooser should display a stock label with the name of the file that is being previewed; the default is TRUE. Applications that want to draw the whole preview area themselves should set this to FALSE and display the name themselves in their preview widget.
unselectAll void unselectAll(): Unselects all the files in the current folder of a file chooser.
unselectFile void unselectFile(FileIF file): Unselects the file referred to by file. If the file is not in the current directory, does not exist, or is otherwise not currently selected, does nothing.
unselectFilename void unselectFilename(string filename): Unselects a currently selected filename. If the filename is not in the current directory, does not exist, or is otherwise not currently selected, does nothing.
unselectUri void unselectUri(string uri): Unselects the file referred to by uri. If the file is not in the current directory, does not exist, or is otherwise not currently selected, does nothing.
addOnConfirmOverwrite gulong addOnConfirmOverwrite(GtkFileChooserConfirmation delegate(FileChooserIF) dlg, ConnectFlags connectFlags): This signal gets emitted whenever it is appropriate to present a confirmation dialog when the user has selected a file name that already exists. The signal only gets emitted when the file chooser is in GTK_FILE_CHOOSER_ACTION_SAVE mode.
addOnCurrentFolderChanged gulong addOnCurrentFolderChanged(void delegate(FileChooserIF) dlg, ConnectFlags connectFlags): This signal is emitted when the current folder in a GtkFileChooser changes. This can happen due to the user performing some action that changes folders, such as selecting a bookmark or visiting a folder on the file list. It can also happen as a result of calling a function to explicitly change the current folder in a file chooser.
addOnFileActivated gulong addOnFileActivated(void delegate(FileChooserIF) dlg, ConnectFlags connectFlags): This signal is emitted when the user "activates" a file in the file chooser. This can happen by double-clicking on a file in the file list, or by pressing Enter.
addOnSelectionChanged gulong addOnSelectionChanged(void delegate(FileChooserIF) dlg, ConnectFlags connectFlags): This signal is emitted when there is a change in the set of selected files in a GtkFileChooser This can happen when the user modifies the selection with the mouse or the keyboard, or when explicitly calling functions to change the selection.
addOnUpdatePreview gulong addOnUpdatePreview(void delegate(FileChooserIF) dlg, ConnectFlags connectFlags): This signal is emitted when the preview in a file chooser should be regenerated. For example, this can happen when the currently selected file changes. You should use this signal if you want your file chooser to have a preview widget.

gtk FileChooserNative classes

FileChooserNative