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.

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

Setting up a file chooser dialog

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

To select a file for opening, as for a File/Open command. Use GTK_FILE_CHOOSER_ACTION_OPEN.

To save a file for the first time, as for a File/Save command. 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, as for a File/Save As command. 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

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 File/Save As command and you already have a file saved somewhere.

Response Codes

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:

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.

Note

To summarize, make sure you use a stock response code when you use GtkFileChooserDialog to ensure proper operation.

class FileChooserDialog : Dialog , FileChooserIF {

protected

GtkFileChooserDialog* gtkFileChooserDialog;

GtkFileChooserDialog* getFileChooserDialogStruct();

void* getStruct();

this(GtkFileChooserDialog* gtkFileChooserDialog);

void setStruct(GObject* obj);

mixin FileChooserT!(GtkFileChooserDialog) ;

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

}

Constructors

this this(GtkFileChooserDialog* gtkFileChooserDialog): 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 GtkFileChooserDialog. This function is analogous to gtk_dialog_new_with_buttons(). Since 2.4

Members

Functions

getFileChooserDialogStruct GtkFileChooserDialog* getFileChooserDialogStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
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.

Variables

gtkFileChooserDialog GtkFileChooserDialog* gtkFileChooserDialog;: the main Gtk struct

Inherited Members

From Dialog

gtkDialog GtkDialog* gtkDialog;: the main Gtk struct
getDialogStruct GtkDialog* getDialogStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
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. Since 2.14
getContentArea VBox getContentArea(): Returns the content area of dialog. Since 2.14
connectedSignals int[string] connectedSignals;
onCloseListeners void delegate(Dialog)[] onCloseListeners;: Undocumented in source.
addOnClose void addOnClose(void delegate(Dialog) dlg, ConnectFlags connectFlags): The ::close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the dialog. The default binding for this signal is the Escape key.
callBackClose void callBackClose(GtkDialog* arg0Struct, Dialog _dialog): Undocumented in source. Be warned that the author may not have intended to support it.
onResponseListeners void delegate(gint, Dialog)[] onResponseListeners;: Undocumented in source.
addOnResponse void addOnResponse(void delegate(gint, 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. See Also GtkVBox, GtkWindow, GtkButton
callBackResponse void callBackResponse(GtkDialog* dialogStruct, gint responseId, Dialog _dialog): Undocumented in source. Be warned that the author may not have intended to support it.
run int run(): Blocks in a recursive main loop until the dialog either emits the "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. Before entering the recursive main loop, gtk_dialog_run() calls gtk_widget_show() on the dialog for you. Note that you still need to show any children of the dialog yourself. During gtk_dialog_run(), the default behavior of "delete-event" is disabled; if the dialog receives ::delete_event, it will not be destroyed as windows usually are, and gtk_dialog_run() will return GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be modal. You can force gtk_dialog_run() to return at any time by calling gtk_dialog_response() to emit the ::response signal. Destroying the dialog during gtk_dialog_run() is a very bad idea, because your post-run code won't know whether the dialog was destroyed or not. After gtk_dialog_run() returns, you are responsible for hiding or destroying the dialog if you wish to do so.
response void response(int responseId): Emits the "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.
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 "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.
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 "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.
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, int 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.
getResponseForWidget int getResponseForWidget(Widget widget): Gets the response id of a widget in the action area of a dialog. Since 2.8
getWidgetForResponse Widget getWidgetForResponse(int responseId): Gets the widget button that uses the given response ID in the action area of a dialog. Since 2.20
alternativeDialogButtonOrder int 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. If you need to use this function, you should probably connect to the ::notify:gtk-alternative-button-order signal on the GtkSettings object associated to screen, in order to be notified if the button order setting changes. Since 2.6
setAlternativeButtonOrder void setAlternativeButtonOrder(int[] newOrder): Sets an alternative button order. If the "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. See gtk_dialog_set_alternative_button_order() for more information. This function is for use by language bindings. Since 2.6 Style Property Details The "action-area-border" style property "action-area-border" gint : Read Width of border around the button area at the bottom of the dialog. Allowed values: >= 0 Default value: 5

From FileChooserIF

getFileChooserTStruct GtkFileChooser* getFileChooserTStruct(): Undocumented in source.
getStruct void* getStruct(): the main Gtk struct as a void*
onConfirmOverwriteListeners GtkFileChooserConfirmation delegate(FileChooserIF)[] onConfirmOverwriteListeners [@property getter]
addOnConfirmOverwrite void 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. Most applications just need to turn on the "do-overwrite-confirmation" property (or call the gtk_file_chooser_set_do_overwrite_confirmation() function), and they will automatically get a stock confirmation dialog. Applications which need to customize this behavior should do that, and also connect to the "confirm-overwrite" signal. A signal handler for this signal must return a GtkFileChooserConfirmation value, which indicates the action to take. If the handler determines that the user wants to select a different filename, it should return GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN. If it determines that the user is satisfied with his choice of file name, it should return GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME. On the other hand, if it determines that the stock confirmation dialog should be used, it should return GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM. The following example illustrates this.
onCurrentFolderChangedListeners void delegate(FileChooserIF)[] onCurrentFolderChangedListeners [@property getter]: Undocumented in source.
addOnCurrentFolderChanged void 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. Normally you do not need to connect to this signal, unless you need to keep track of which folder a file chooser is showing. See also: gtk_file_chooser_set_current_folder(), gtk_file_chooser_get_current_folder(), gtk_file_chooser_set_current_folder_uri(), gtk_file_chooser_get_current_folder_uri().
onFileActivatedListeners void delegate(FileChooserIF)[] onFileActivatedListeners [@property getter]: Undocumented in source.
addOnFileActivated void 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. Normally you do not need to connect to this signal. It is used internally by GtkFileChooserDialog to know when to activate the default button in the dialog. See also: gtk_file_chooser_get_filename(), gtk_file_chooser_get_filenames(), gtk_file_chooser_get_uri(), gtk_file_chooser_get_uris().
onSelectionChangedListeners void delegate(FileChooserIF)[] onSelectionChangedListeners [@property getter]: Undocumented in source.
addOnSelectionChanged void 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. Normally you do not need to connect to this signal, as it is easier to wait for the file chooser to finish running, and then to get the list of selected files using the functions mentioned below. See also: gtk_file_chooser_select_filename(), gtk_file_chooser_unselect_filename(), gtk_file_chooser_get_filename(), gtk_file_chooser_get_filenames(), gtk_file_chooser_select_uri(), gtk_file_chooser_unselect_uri(), gtk_file_chooser_get_uri(), gtk_file_chooser_get_uris().
onUpdatePreviewListeners void delegate(FileChooserIF)[] onUpdatePreviewListeners [@property getter]: Undocumented in source.
addOnUpdatePreview void 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. Once you have installed a preview widget with gtk_file_chooser_set_preview_widget(), you should update it when this signal is emitted. You can use the functions gtk_file_chooser_get_preview_filename() or gtk_file_chooser_get_preview_uri() to get the name of the file to preview. Your widget may not be able to preview all kinds of files; your callback must call gtk_file_chooser_set_preview_widget_active() to inform the file chooser about whether the preview was generated successfully or not. Please see the example code in the section called “Adding a Preview Widget”. See also: gtk_file_chooser_set_preview_widget(), gtk_file_chooser_set_preview_widget_active(), gtk_file_chooser_set_use_preview_label(), gtk_file_chooser_get_preview_filename(), gtk_file_chooser_get_preview_uri(). See Also GtkFileChooserDialog, GtkFileChooserWidget, GtkFileChooserButton
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. Since 2.4
getFileChooserAction GtkFileChooserAction getFileChooserAction(): Gets the type of operation that the file chooser is performing; see gtk_file_chooser_set_action(). Since 2.4
setLocalOnly void setLocalOnly(int localOnly): Sets whether only local files can be selected in the file selector. If local_only is TRUE (the default), then the selected file are files are guaranteed to be accessible through the operating systems native file 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(), On some systems non-native files may still be available using the native filesystem via a userspace filesystem (FUSE). Since 2.4
getLocalOnly int getLocalOnly(): Gets whether only local files can be selected in the file selector. See gtk_file_chooser_set_local_only() Since 2.4
setSelectMultiple void setSelectMultiple(int 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. Since 2.4
getSelectMultiple int getSelectMultiple(): Gets whether multiple files can be selected in the file selector. See gtk_file_chooser_set_select_multiple(). Since 2.4
setShowHidden void setShowHidden(int showHidden): Sets whether hidden files and folders are displayed in the file selector. Since 2.6
getShowHidden int getShowHidden(): Gets whether hidden files and folders are displayed in the file selector. See gtk_file_chooser_set_show_hidden(). Since 2.6
setDoOverwriteConfirmation void setDoOverwriteConfirmation(int 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. If set to TRUE, the chooser will emit the "confirm-overwrite" signal when appropriate. If all you need is the stock confirmation dialog, set this property to TRUE. You can override the way confirmation is done by actually handling the "confirm-overwrite" signal; please refer to its documentation for the details. Since 2.8
getDoOverwriteConfirmation int getDoOverwriteConfirmation(): Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists. Since 2.8
setCreateFolders void setCreateFolders(int 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. Since 2.18
getCreateFolders int getCreateFolders(): Gets whether file choser will offer to create new folders. See gtk_file_chooser_set_create_folders(). Since 2.18
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. If you want to preselect a particular existing file, you should use gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead. Please see the documentation for those functions for an example of using gtk_file_chooser_set_current_name() as well. Since 2.4
getCurrentName string getCurrentName(): Gets the current name in the file selector, as entered by the user in the text entry for "Name". This is meant to be used in save dialogs, to get the currently typed filename when the file itself does not exist yet. For example, an application that adds a custom extra widget to the file chooser for "file format" may want to change the extension of the typed filename based on the chosen format, say, from ".jpg" to ".png".
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. If the file chooser is in folder mode, this function returns the selected folder. Since 2.4
setFilename int 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. Note that the file must exist, or nothing will be done except for the directory change. You should use this function only when implementing a File/Save As... dialog for which you already have a file name to which the user may save. For example, when the user opens an existing file and then does File/Save As... on it to save a copy or a modified version. If you don't have a file name already — for example, if the user just created a new file and is saving it for the first Since 2.4
selectFilename int 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. Since 2.4
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. Since 2.4
selectAll void selectAll(): Selects all the files in the current folder of a file chooser. Since 2.4
unselectAll void unselectAll(): Unselects all the files in the current folder of a file chooser. Since 2.4
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()) Since 2.4
setCurrentFolder int 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. In general, you should not use this function. See the section on setting up a file chooser dialog for the rationale behind this. Since 2.4
getCurrentFolder string getCurrentFolder(): Gets the current folder of chooser as a local filename. See gtk_file_chooser_set_current_folder(). Note that this is the folder that the file chooser is currently displaying (e.g. "/home/username/Documents"), which is not the same as the currently-selected folder if the chooser is in GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER mode (e.g. "/home/username/Documents/selected-folder/". To get the currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the usual way to get the selection. Since 2.4
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. If the file chooser is in folder mode, this function returns the selected folder. Since 2.4
setUri int 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. Note that the URI must exist, or nothing will be done except for the directory change. You should use this function only when implementing a File/Save As... dialog for which you already have a file name to which the user may save. For example, whenthe user opens an existing file and then does File/Save As... on it to save a copy or a modified version. If you don't have a file name already — for example, if the user just created a new file and is saving it for the first time, do Since 2.4
selectUri int 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. Since 2.4
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. Since 2.4
getUris ListSG getUris(): Lists all the selected files and subfolders in the current folder of chooser. The returned names are full absolute URIs. Since 2.4
setCurrentFolderUri int 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. In general, you should not use this function. See the section on setting up a file chooser dialog for the rationale behind this. Since 2.4
getCurrentFolderUri string getCurrentFolderUri(): Gets the current folder of chooser as an URI. See gtk_file_chooser_set_current_folder_uri(). Note that this is the folder that the file chooser is currently displaying (e.g. "file:///home/username/Documents"), which is not the same as the currently-selected folder if the chooser is in GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER mode (e.g. "file:///home/username/Documents/selected-folder/". To get the currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the usual way to get the selection. Since 2.4
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. When there is no application-supplied preview widget, or the application-supplied preview widget is not active, the file chooser will display no preview at all. Since 2.4
getPreviewWidget Widget getPreviewWidget(): Gets the current preview widget; see gtk_file_chooser_set_preview_widget(). Since 2.4
setPreviewWidgetActive void setPreviewWidgetActive(int 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. Since 2.4
getPreviewWidgetActive int 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(). Since 2.4
setUsePreviewLabel void setUsePreviewLabel(int 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. See also: gtk_file_chooser_set_preview_widget() Since 2.4
getUsePreviewLabel int getUsePreviewLabel(): Gets whether a stock label should be drawn with the name of the previewed file. See gtk_file_chooser_set_use_preview_label().
getPreviewFilename string getPreviewFilename(): Gets the filename that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget(). Since 2.4
getPreviewUri string getPreviewUri(): Gets the URI that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget(). Since 2.4
setExtraWidget void setExtraWidget(Widget extraWidget): Sets an application-supplied widget to provide extra options to the user. Since 2.4
getExtraWidget Widget getExtraWidget(): Gets the current preview widget; see gtk_file_chooser_set_extra_widget(). Since 2.4
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. Note that the chooser takes ownership of the filter, so you have to ref and sink it if you want to keep a reference. Since 2.4
removeFilter void removeFilter(FileFilter filter): Removes filter from the list of filters that the user can select between. Since 2.4
listFilters ListSG listFilters(): Lists the current set of user-selectable filters; see gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter(). Since 2.4
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. Since 2.4
getFilter FileFilter getFilter(): Gets the current filter; see gtk_file_chooser_set_filter(). Since 2.4
addShortcutFolder int 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. Since 2.4
removeShortcutFolder int removeShortcutFolder(string folder): Removes a folder from a file chooser's list of shortcut folders. Since 2.4
listShortcutFolders ListSG listShortcutFolders(): Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder(). Since 2.4
addShortcutFolderUri int 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. Since 2.4
removeShortcutFolderUri int removeShortcutFolderUri(string uri): Removes a folder URI from a file chooser's list of shortcut folders. Since 2.4
listShortcutFolderUris ListSG listShortcutFolderUris(): Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder_uri(). Since 2.4
getCurrentFolderFile File getCurrentFolderFile(): Gets the current folder of chooser as GFile. See gtk_file_chooser_get_current_folder_uri(). Since 2.14
getFile File 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. If the file chooser is in folder mode, this function returns the selected folder. Since 2.14
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(). Since 2.14
getPreviewFile File getPreviewFile(): Gets the GFile that should be previewed in a custom preview Internal function, see gtk_file_chooser_get_preview_uri(). Since 2.14
selectFile int selectFile(File file): Selects the file referred to by file. An internal function. See gtk_file_chooser_select_uri(). Since 2.14
setCurrentFolderFile int setCurrentFolderFile(File file): Sets the current folder for chooser from a GFile. Internal function, see gtk_file_chooser_set_current_folder_uri(). Since 2.14
setFile int setFile(File 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. 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. This is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by gtk_file_chooser_select_filename(). Note that the file must exist, or nothing will be done except for the directory change. If you are implementing a File/Save As... dialog, you should use this function if you already have a file name to which the user may save; for example, when the user opens an existing file and then does File/Save As... on it. If you don't have a file name already — for example, if the user just created a new file and is saving it for the first time, do not call this function. Since 2.14
unselectFile void unselectFile(File 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. Since 2.14