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
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.
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().
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().
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().
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
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
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
Gets whether file choser will offer to create new folders. See gtk_file_chooser_set_create_folders(). Since 2.18
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
Gets the current folder of chooser as GFile. See gtk_file_chooser_get_current_folder_uri(). Since 2.14
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
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".
Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists. Since 2.8
Gets the current preview widget; see gtk_file_chooser_set_extra_widget(). Since 2.4
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
Gets the type of operation that the file chooser is performing; see gtk_file_chooser_set_action(). Since 2.4
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
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
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
Gets the current filter; see gtk_file_chooser_set_filter(). Since 2.4
Gets whether only local files can be selected in the file selector. See gtk_file_chooser_set_local_only() Since 2.4
Gets the GFile that should be previewed in a custom preview Internal function, see gtk_file_chooser_get_preview_uri(). Since 2.14
Gets the filename that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget(). Since 2.4
Gets the URI that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget(). Since 2.4
Gets the current preview widget; see gtk_file_chooser_set_preview_widget(). Since 2.4
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
Gets whether multiple files can be selected in the file selector. See gtk_file_chooser_set_select_multiple(). Since 2.4
Gets whether hidden files and folders are displayed in the file selector. See gtk_file_chooser_set_show_hidden(). Since 2.6
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
Lists all the selected files and subfolders in the current folder of chooser. The returned names are full absolute URIs. Since 2.4
Gets whether a stock label should be drawn with the name of the previewed file. See gtk_file_chooser_set_use_preview_label().
Lists the current set of user-selectable filters; see gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter(). Since 2.4
Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder_uri(). Since 2.4
Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder(). Since 2.4
Removes filter from the list of filters that the user can select between. Since 2.4
Removes a folder from a file chooser's list of shortcut folders. Since 2.4
Removes a folder URI from a file chooser's list of shortcut folders. Since 2.4
Selects all the files in the current folder of a file chooser. Since 2.4
Selects the file referred to by file. An internal function. See gtk_file_chooser_select_uri(). Since 2.14
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
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
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
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
Sets the current folder for chooser from a GFile. Internal function, see gtk_file_chooser_set_current_folder_uri(). Since 2.14
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
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
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
Sets an application-supplied widget to provide extra options to the user. Since 2.4
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
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
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
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
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
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
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
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
Sets whether hidden files and folders are displayed in the file selector. Since 2.6
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
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
Unselects all the files in the current folder of a file chooser. Since 2.4
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
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
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
the main Gtk struct
GtkFileChooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are GtkFileChooserWidget, GtkFileChooserDialog, and GtkFileChooserButton. 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 names either as filenames or as URIs. For URIs, the normal escaping rules are applied if the URI contains non-ASCII characters. However, filenames are always returned in the character set specified by the G_FILENAME_ENCODING environment variable. Please see the GLib documentation for more details about this variable.
Note
This means that while you can pass the result of gtk_file_chooser_get_filename() to open(2) or fopen(3), you may not be able to directly set it as the text of a GtkLabel widget unless you convert it first to UTF-8, which all GTK+ widgets expect. You should use g_filename_to_utf8() to convert filenames into strings that can be passed to GTK+ widgets.
<hr>
Adding a Preview Widget
You can add a custom preview widget to a file chooser and then get notification about when the preview needs to be updated. To install a preview widget, use gtk_file_chooser_set_preview_widget(). Then, connect to the "update-preview" signal to get notified when you need to update the contents of the preview.
Your callback should use gtk_file_chooser_get_preview_filename() to see what needs previewing. Once you have generated the preview for the corresponding file, you must call gtk_file_chooser_set_preview_widget_active() with a boolean flag that indicates whether your callback could successfully generate a preview.
<hr>
Adding Extra Widgets
You can add extra widgets to a file chooser to provide options that are not present in the default design. For example, you can add a toggle button to give the user the option to open a file in read-only mode. You can use gtk_file_chooser_set_extra_widget() to insert additional widgets in a file chooser.
Note
If you want to set more than one extra widget in the file chooser, you can a container such as a GtkBox or a GtkGrid and include your widgets in it. Then, set the container as the whole extra widget.
<hr>
Key Bindings
Internally, GTK+ implements a file chooser's graphical user interface with the private GtkFileChooserDefaultClass. This widget has several key bindings and their associated signals. This section describes the available key binding signals.
You can change these defaults to something else. For example, to add a Shift modifier to a few of the default bindings, you can include the following fragment in your .config/gtk-3.0/gtk.css file:
@binding-set MyOwnFilechooserBindings { * bind "<Alt><Shift>Up" { "up-folder" () } * bind "<Alt><Shift>Down" { "down-folder" () } * bind "<Alt><Shift>Home" { "home-folder" () } }
GtkFileChooserDefault { * gtk-key-bindings: MyOwnFilechooserBindings }
The "GtkFileChooserDefault::location-popup" signal
void user_function (GtkFileChooserDefault *chooser, const char *path, gpointer user_data);
This is used to make the file chooser show a "Location" dialog which the user can use to manually type the name of the file he wishes to select. The path argument is a string that gets put in the text entry for the file name. By default this is bound to Control+L with a path string of "" (the empty string). It is also bound to / with a path string of "/" (a slash): this lets you type / and immediately type a path name. On Unix systems, this is bound to ~ (tilde) with a path string of "~" itself for access to home directories.
chooser :
the object which received the signal.
path :
default contents for the text entry for the file name
user_data :
user data set when the signal handler was connected.
Note
You can create your own bindings for the "location-popup" signal with custom path strings, and have a crude form of easily-to-type bookmarks. For example, say you access the path /home/username/misc very frequently. You could then create an Alt+M shortcut by including the following in your .config/gtk-3.0/gtk.css:
@binding-set MiscShortcut { * bind "<Alt>M" { "location-popup" ("/home/username/misc") } }
GtkFileChooserDefault { * gtk-key-bindings: MiscShortcut }
The "GtkFileChooserDefault::up-folder" signal
void user_function (GtkFileChooserDefault *chooser, gpointer user_data);
This is used to make the file chooser go to the parent of the current folder in the file hierarchy. By default this is bound to Backspace and Alt+Up (the Up key in the numeric keypad also works).
chooser :
the object which received the signal.
user_data :
user data set when the signal handler was connected.
The "GtkFileChooserDefault::down-folder" signal
void user_function (GtkFileChooserDefault *chooser, gpointer user_data);
This is used to make the file chooser go to a child of the current folder in the file hierarchy. The subfolder that will be used is displayed in the path bar widget of the file chooser. For example, if the path bar is showing "/foo/bar/baz", then this will cause the file chooser to switch to the "baz" subfolder. By default this is bound to Alt+Down (the Down key in the numeric keypad also works).
chooser :
the object which received the signal.
user_data :
user data set when the signal handler was connected.
The "GtkFileChooserDefault::home-folder" signal
void user_function (GtkFileChooserDefault *chooser, gpointer user_data);
This is used to make the file chooser show the user's home folder in the file list. By default this is bound to Alt+Home (the Home key in the numeric keypad also works).
chooser :
the object which received the signal.
user_data :
user data set when the signal handler was connected.
The "GtkFileChooserDefault::desktop-folder" signal
void user_function (GtkFileChooserDefault *chooser, gpointer user_data);
This is used to make the file chooser show the user's Desktop folder in the file list. By default this is bound to Alt+D.
chooser :
the object which received the signal.
user_data :
user data set when the signal handler was connected.
The "GtkFileChooserDefault::quick-bookmark" signal
void user_function (GtkFileChooserDefault *chooser, gint bookmark_index, gpointer user_data);
This is used to make the file chooser switch to the bookmark specified in the bookmark_index parameter. For example, if you have three bookmarks, you can pass 0, 1, 2 to this signal to switch to each of them, respectively. By default this is bound to Alt+1, Alt+2, etc. until Alt+0. Note that in the default binding, that Alt+1 is actually defined to switch to the bookmark at index 0, and so on successively; Alt+0 is defined to switch to the bookmark at index 10.
chooser :
the object which received the signal.
bookmark_indes :
index of the bookmark to switch to; the indices start at 0.
user_data :
user data set when the signal handler was connected.