FileChooserDialog

#GtkFileChooserDialog is a dialog box suitable for use with “File/Open” or “File/Save as” commands. This widget works by putting a #GtkFileChooserWidget inside a #GtkDialog. It exposes the #GtkFileChooser interface, so you can use all of the #GtkFileChooser functions on the file chooser dialog as well as those for #GtkDialog.

Note that #GtkFileChooserDialog does not have any methods of its own. Instead, you should use the functions that work on a #GtkFileChooser.

If you want to integrate well with the platform you should use the #GtkFileChooserNative API, which will use a platform-specific dialog if available and fall back to GtkFileChooserDialog otherwise.

Typical usage ## {#gtkfilechooser-typical-usage}

In the simplest of cases, you can the following code to use #GtkFileChooserDialog to select a file for opening:

|[ GtkWidget *dialog; GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN; gint res;

dialog = gtk_file_chooser_dialog_new ("Open File", parent_window, action, _("_Cancel"), GTK_RESPONSE_CANCEL, _("_Open"), GTK_RESPONSE_ACCEPT, NULL);

res = gtk_dialog_run (GTK_DIALOG (dialog)); if (res == GTK_RESPONSE_ACCEPT) { char *filename; GtkFileChooser *chooser = GTK_FILE_CHOOSER (dialog); filename = gtk_file_chooser_get_filename (chooser); open_file (filename); g_free (filename); }

gtk_widget_destroy (dialog); ]|

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

|[ GtkWidget *dialog; GtkFileChooser *chooser; GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_SAVE; gint res;

dialog = gtk_file_chooser_dialog_new ("Save File", parent_window, action, _("_Cancel"), GTK_RESPONSE_CANCEL, _("_Save"), GTK_RESPONSE_ACCEPT, NULL); chooser = GTK_FILE_CHOOSER (dialog);

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_dialog_run (GTK_DIALOG (dialog)); if (res == GTK_RESPONSE_ACCEPT) { char *filename;

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

gtk_widget_destroy (dialog); ]|

Setting up a file chooser dialog ## {#gtkfilechooserdialog-setting-up}

There are various cases in which you may need to use a #GtkFileChooserDialog:

- To select a file for opening. Use #GTK_FILE_CHOOSER_ACTION_OPEN.

- To save a file for the first time. Use #GTK_FILE_CHOOSER_ACTION_SAVE, and suggest a name such as “Untitled” with gtk_file_chooser_set_current_name().

- To save a file under a different name. Use #GTK_FILE_CHOOSER_ACTION_SAVE, and set the existing filename with gtk_file_chooser_set_filename().

- To choose a folder instead of a file. Use #GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.

Note that old versions of the file chooser’s documentation suggested using gtk_file_chooser_set_current_folder() in various situations, with the intention of letting the application suggest a reasonable default folder. This is no longer considered to be a good policy, as now the file chooser is able to make good suggestions on its own. In general, you should only cause the file chooser to show a specific folder when it is appropriate to use gtk_file_chooser_set_filename(), i.e. when you are doing a Save As command and you already have a file saved somewhere.

Response Codes ## {#gtkfilechooserdialog-responses}

#GtkFileChooserDialog inherits from #GtkDialog, so buttons that go in its action area have response codes such as #GTK_RESPONSE_ACCEPT and #GTK_RESPONSE_CANCEL. For example, you could call gtk_file_chooser_dialog_new() as follows:

|[ GtkWidget *dialog; GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;

dialog = gtk_file_chooser_dialog_new ("Open File", parent_window, action, _("_Cancel"), GTK_RESPONSE_CANCEL, _("_Open"), GTK_RESPONSE_ACCEPT, NULL); ]|

This will create buttons for “Cancel” and “Open” that use stock response identifiers from #GtkResponseType. For most dialog boxes you can use your own custom response codes rather than the ones in #GtkResponseType, but #GtkFileChooserDialog assumes that its “accept”-type action, e.g. an “Open” or “Save” button, will have one of the following response codes:

- #GTK_RESPONSE_ACCEPT - #GTK_RESPONSE_OK - #GTK_RESPONSE_YES - #GTK_RESPONSE_APPLY

This is because #GtkFileChooserDialog must intercept responses and switch to folders if appropriate, rather than letting the dialog terminate — the implementation uses these known response codes to know which responses can be blocked if appropriate.

To summarize, make sure you use a [stock response code][gtkfilechooserdialog-responses] when you use #GtkFileChooserDialog to ensure proper operation.

class FileChooserDialog : Dialog , FileChooserIF {

protected

GtkFileChooserDialog* gtkFileChooserDialog;

GtkFileChooserDialog* getFileChooserDialogStruct(bool transferOwnership);

void* getStruct();

void setStruct(GObject* obj);

this(GtkFileChooserDialog* gtkFileChooserDialog, bool ownedRef);

mixin FileChooserT!(GtkFileChooserDialog) ;

this(string title, Window parent, FileChooserAction action, string[] buttonsText, ResponseType[] responses);

static GType getType();

}

Constructors

this this(GtkFileChooserDialog* gtkFileChooserDialog, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string title, Window parent, FileChooserAction action, string[] buttonsText, ResponseType[] responses): Creates a new FileChooserDialog. This function is analogous to gtk_dialog_new_with_buttons().

Members

Functions

getFileChooserDialogStruct GtkFileChooserDialog* getFileChooserDialogStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous mixin FileChooserT!(GtkFileChooserDialog): Undocumented in source.

Static functions

getType GType getType()

Variables

gtkFileChooserDialog GtkFileChooserDialog* gtkFileChooserDialog;: the main Gtk struct

Inherited Members

From Dialog

gtkDialog GtkDialog* gtkDialog;: the main Gtk struct
getDialogStruct GtkDialog* getDialogStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
addButton Button addButton(StockID stockID, int responseId)
addButtons void addButtons(string[] buttonsText, ResponseType[] responses)
addButtons void addButtons(StockID[] stockIDs, ResponseType[] responses)
getActionArea HButtonBox getActionArea(): Returns the action area of dialog.
getContentArea VBox getContentArea(): Returns the content area of dialog.
getType GType getType()
addActionWidget void addActionWidget(Widget child, int responseId): Adds an activatable widget to the action area of a #GtkDialog, connecting a signal handler that will emit the #GtkDialog::response signal on the dialog when the widget is activated. The widget is appended to the end of the dialog’s action area. If you want to add a non-activatable widget, simply pack it into the @action_area field of the #GtkDialog struct.
addButton Widget addButton(string buttonText, int responseId): Adds a button with the given text and sets things up so that clicking the button will emit the #GtkDialog::response signal with the given @response_id. The button is appended to the end of the dialog’s action area. The button widget is returned, but usually you don’t need it.
getHeaderBar Widget getHeaderBar(): Returns the header bar of @dialog. Note that the headerbar is only used by the dialog if the #GtkDialog:use-header-bar property is %TRUE.
getResponseForWidget int getResponseForWidget(Widget widget): Gets the response id of a widget in the action area of a dialog.
getWidgetForResponse Widget getWidgetForResponse(int responseId): Gets the widget button that uses the given response ID in the action area of a dialog.
response void response(int responseId): Emits the #GtkDialog::response signal with the given response ID. Used to indicate that the user has responded to the dialog in some way; typically either you or gtk_dialog_run() will be monitoring the ::response signal and take appropriate action.
run int run(): Blocks in a recursive main loop until the @dialog either emits the #GtkDialog::response signal, or is destroyed. If the dialog is destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the ::response signal emission.
setAlternativeButtonOrder void setAlternativeButtonOrder(int[] newOrder): Sets an alternative button order. If the #GtkSettings:gtk-alternative-button-order setting is set to %TRUE, the dialog buttons are reordered according to the order of the response ids in @new_order.
setDefaultResponse void setDefaultResponse(int responseId): Sets the last widget in the dialog’s action area with the given @response_id as the default widget for the dialog. Pressing “Enter” normally activates the default widget.
setResponseSensitive void setResponseSensitive(int responseId, bool setting): Calls gtk_widget_set_sensitive (widget, @setting) for each widget in the dialog’s action area with the given @response_id. A convenient way to sensitize/desensitize dialog buttons.
OnCloseDelegateWrapper class OnCloseDelegateWrapper: Undocumented in source.
onCloseListeners OnCloseDelegateWrapper[] onCloseListeners;: Undocumented in source.
addOnClose gulong addOnClose(void delegate(Dialog) dlg, ConnectFlags connectFlags): The ::close signal is a [keybinding signal]GtkBindingSignal which gets emitted when the user uses a keybinding to close the dialog.
callBackClose void callBackClose(GtkDialog* dialogStruct, OnCloseDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackCloseDestroy void callBackCloseDestroy(OnCloseDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
OnResponseDelegateWrapper class OnResponseDelegateWrapper: Undocumented in source.
onResponseListeners OnResponseDelegateWrapper[] onResponseListeners;: Undocumented in source.
addOnResponse gulong addOnResponse(void delegate(int, Dialog) dlg, ConnectFlags connectFlags): Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls gtk_dialog_response(). On a delete event, the response ID is #GTK_RESPONSE_DELETE_EVENT. Otherwise, it depends on which action widget was clicked.
callBackResponse void callBackResponse(GtkDialog* dialogStruct, int responseId, OnResponseDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackResponseDestroy void callBackResponseDestroy(OnResponseDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
alternativeDialogButtonOrder bool alternativeDialogButtonOrder(Screen screen): Returns %TRUE if dialogs are expected to use an alternative button order on the screen @screen. See gtk_dialog_set_alternative_button_order() for more details about alternative button order.

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 #GtkFileChooser::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.