Synopsis#include <gtk/gtk.h> GtkFileChooser; enum GtkFileChooserAction; enum GtkFileChooserConfirmation; #define GTK_FILE_CHOOSER_ERROR enum GtkFileChooserError; void gtk_file_chooser_set_action (GtkFileChooser *chooser, GtkFileChooserAction action); GtkFileChooserAction gtk_file_chooser_get_action (GtkFileChooser *chooser); void gtk_file_chooser_set_local_only (GtkFileChooser *chooser, gboolean local_only); gboolean gtk_file_chooser_get_local_only (GtkFileChooser *chooser); void gtk_file_chooser_set_select_multiple (GtkFileChooser *chooser, gboolean select_multiple); gboolean gtk_file_chooser_get_select_multiple (GtkFileChooser *chooser); void gtk_file_chooser_set_show_hidden (GtkFileChooser *chooser, gboolean show_hidden); gboolean gtk_file_chooser_get_show_hidden (GtkFileChooser *chooser); void gtk_file_chooser_set_do_overwrite_confirmation (GtkFileChooser *chooser, gboolean do_overwrite_confirmation); gboolean gtk_file_chooser_get_do_overwrite_confirmation (GtkFileChooser *chooser); void gtk_file_chooser_set_current_name (GtkFileChooser *chooser, const gchar *name); gchar* gtk_file_chooser_get_filename (GtkFileChooser *chooser); gboolean gtk_file_chooser_set_filename (GtkFileChooser *chooser, const char *filename); gboolean gtk_file_chooser_select_filename (GtkFileChooser *chooser, const char *filename); void gtk_file_chooser_unselect_filename (GtkFileChooser *chooser, const char *filename); void gtk_file_chooser_select_all (GtkFileChooser *chooser); void gtk_file_chooser_unselect_all (GtkFileChooser *chooser); GSList* gtk_file_chooser_get_filenames (GtkFileChooser *chooser); gboolean gtk_file_chooser_set_current_folder (GtkFileChooser *chooser, const gchar *filename); gchar* gtk_file_chooser_get_current_folder (GtkFileChooser *chooser); gchar* gtk_file_chooser_get_uri (GtkFileChooser *chooser); gboolean gtk_file_chooser_set_uri (GtkFileChooser *chooser, const char *uri); gboolean gtk_file_chooser_select_uri (GtkFileChooser *chooser, const char *uri); void gtk_file_chooser_unselect_uri (GtkFileChooser *chooser, const char *uri); GSList* gtk_file_chooser_get_uris (GtkFileChooser *chooser); gboolean gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser, const gchar *uri); gchar* gtk_file_chooser_get_current_folder_uri (GtkFileChooser *chooser); void gtk_file_chooser_set_preview_widget (GtkFileChooser *chooser, GtkWidget *preview_widget); GtkWidget* gtk_file_chooser_get_preview_widget (GtkFileChooser *chooser); void gtk_file_chooser_set_preview_widget_active (GtkFileChooser *chooser, gboolean active); gboolean gtk_file_chooser_get_preview_widget_active (GtkFileChooser *chooser); void gtk_file_chooser_set_use_preview_label (GtkFileChooser *chooser, gboolean use_label); gboolean gtk_file_chooser_get_use_preview_label (GtkFileChooser *chooser); char* gtk_file_chooser_get_preview_filename (GtkFileChooser *chooser); char* gtk_file_chooser_get_preview_uri (GtkFileChooser *chooser); void gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser, GtkWidget *extra_widget); GtkWidget* gtk_file_chooser_get_extra_widget (GtkFileChooser *chooser); void gtk_file_chooser_add_filter (GtkFileChooser *chooser, GtkFileFilter *filter); void gtk_file_chooser_remove_filter (GtkFileChooser *chooser, GtkFileFilter *filter); GSList* gtk_file_chooser_list_filters (GtkFileChooser *chooser); void gtk_file_chooser_set_filter (GtkFileChooser *chooser, GtkFileFilter *filter); GtkFileFilter* gtk_file_chooser_get_filter (GtkFileChooser *chooser); gboolean gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser, const char *folder, GError **error); gboolean gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser, const char *folder, GError **error); GSList* gtk_file_chooser_list_shortcut_folders (GtkFileChooser *chooser); gboolean gtk_file_chooser_add_shortcut_folder_uri (GtkFileChooser *chooser, const char *uri, GError **error); gboolean gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser, const char *uri, GError **error); GSList* gtk_file_chooser_list_shortcut_folder_uris (GtkFileChooser *chooser); GFile* gtk_file_chooser_get_current_folder_file (GtkFileChooser *chooser); GFile* gtk_file_chooser_get_file (GtkFileChooser *chooser); GSList* gtk_file_chooser_get_files (GtkFileChooser *chooser); GFile* gtk_file_chooser_get_preview_file (GtkFileChooser *chooser); gboolean gtk_file_chooser_select_file (GtkFileChooser *chooser, GFile *file, GError **error); gboolean gtk_file_chooser_set_current_folder_file (GtkFileChooser *chooser, GFile *file, GError **error); gboolean gtk_file_chooser_set_file (GtkFileChooser *chooser, GFile *file, GError **error); void gtk_file_chooser_unselect_file (GtkFileChooser *chooser, GFile *file); Known ImplementationsGtkFileChooser is implemented by GtkFileChooserButton, GtkFileChooserWidget and GtkFileChooserDialog. Properties"action" GtkFileChooserAction : Read / Write "do-overwrite-confirmation" gboolean : Read / Write "extra-widget" GtkWidget* : Read / Write "file-system-backend" gchar* : Write / Construct Only "filter" GtkFileFilter* : Read / Write "local-only" gboolean : Read / Write "preview-widget" GtkWidget* : Read / Write "preview-widget-active" gboolean : Read / Write "select-multiple" gboolean : Read / Write "show-hidden" gboolean : Read / Write "use-preview-label" gboolean : Read / Write Signals"confirm-overwrite" : Run Last "current-folder-changed" : Run Last "file-activated" : Run Last "selection-changed" : Run Last "update-preview" : Run Last DescriptionGtkFileChooser 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 taht these shortcuts come from various sources and in various flavours, so lets explain the terminology here:
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
Important
This means that while you can pass the result of
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
Your callback should use
Example 32. Sample Usage { GtkImage *preview; ... preview = gtk_image_new (); gtk_file_chooser_set_preview_widget (my_file_chooser, preview); g_signal_connect (my_file_chooser, "update-preview", G_CALLBACK (update_preview_cb), preview); } static void update_preview_cb (GtkFileChooser *file_chooser, gpointer data) { GtkWidget *preview; char *filename; GdkPixbuf *pixbuf; gboolean have_preview; preview = GTK_WIDGET (data); filename = gtk_file_chooser_get_preview_filename (file_chooser); pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 128, 128, NULL); have_preview = (pixbuf != NULL); g_free (filename); gtk_image_set_from_pixbuf (GTK_IMAGE (preview), pixbuf); if (pixbuf) gobject_unref (pixbuf); gtk_file_chooser_set_preview_widget_active (file_chooser, have_preview); } 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
Example 33. Sample Usage { GtkWidget *toggle; ... toggle = gtk_check_button_new_with_label ("Open file read-only"); gtk_widget_show (toggle); gtk_file_chooser_set_extra_widget (my_file_chooser, toggle); } NoteIf you want to set more than one extra widget in the file chooser, you can a container such as a GtkVBox or a GtkTable and include your widgets in it. Then, set the container as the whole extra widget. Key Bindings
Internally, GTK+ implements a file chooser's graphical user
interface with the private
Example 34. GtkFileChooser key binding example
The default keys that activate the key-binding signals in
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 binding "my-own-gtkfilechooser-bindings" { bind "<Alt><Shift>Up" { "up-folder" () } bind "<Alt><Shift>Down" { "down-folder" () } bind "<Alt><Shift>Home" { "home-folder" () } } class "GtkFileChooserDefault" binding "my-own-gtkfilechooser-bindings" The "GtkFileChooserDefault::location-popup" signalvoid 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
Tip
You can create your own bindings for the
location-popup signal with custom
binding "misc-shortcut" { bind "<Alt>M" { "location-popup" ("/home/username/misc") } } class "GtkFileChooserDefault" binding "misc-shortcut" The "GtkFileChooserDefault::up-folder" signalvoid 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).
The "GtkFileChooserDefault::down-folder" signalvoid 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).
The "GtkFileChooserDefault::home-folder" signalvoid 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).
The "GtkFileChooserDefault::desktop-folder" signalvoid 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.
The "GtkFileChooserDefault::quick-bookmark" signalvoid 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
Detailsenum GtkFileChooserActiontypedef enum { GTK_FILE_CHOOSER_ACTION_OPEN, GTK_FILE_CHOOSER_ACTION_SAVE, GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER, GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER } GtkFileChooserAction; Describes whether a GtkFileChooser is being used to open existing files or to save to a possibly new file.
enum GtkFileChooserConfirmationtypedef enum { GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM, GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME, GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN } GtkFileChooserConfirmation;
Used as a return value of handlers for the confirm-overwrite
signal of a
GTK_FILE_CHOOSER_ERROR#define GTK_FILE_CHOOSER_ERROR (gtk_file_chooser_error_quark ()) Used to get the GError quark for GtkFileChooser errors. enum GtkFileChooserErrortypedef enum { GTK_FILE_CHOOSER_ERROR_NONEXISTENT, GTK_FILE_CHOOSER_ERROR_BAD_FILENAME, GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS } GtkFileChooserError; These identify the various errors that can occur while calling GtkFileChooser functions. gtk_file_chooser_set_action ()void gtk_file_chooser_set_action (GtkFileChooser *chooser, 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
Since 2.4 gtk_file_chooser_get_action ()GtkFileChooserAction gtk_file_chooser_get_action (GtkFileChooser *chooser);
Gets the type of operation that the file chooser is performing; see
Since 2.4 gtk_file_chooser_set_local_only ()void gtk_file_chooser_set_local_only (GtkFileChooser *chooser, gboolean local_only);
Sets whether only local files can be selected in the
file selector. If
Since 2.4 gtk_file_chooser_get_local_only ()gboolean gtk_file_chooser_get_local_only (GtkFileChooser *chooser);
Gets whether only local files can be selected in the
file selector. See
Since 2.4 gtk_file_chooser_set_select_multiple ()void gtk_file_chooser_set_select_multiple (GtkFileChooser *chooser, gboolean select_multiple); 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 gtk_file_chooser_get_select_multiple ()gboolean gtk_file_chooser_get_select_multiple (GtkFileChooser *chooser);
Gets whether multiple files can be selected in the file
selector. See
Since 2.4 gtk_file_chooser_set_show_hidden ()void gtk_file_chooser_set_show_hidden (GtkFileChooser *chooser, gboolean show_hidden); Sets whether hidden files and folders are displayed in the file selector.
Since 2.6 gtk_file_chooser_get_show_hidden ()gboolean gtk_file_chooser_get_show_hidden (GtkFileChooser *chooser);
Gets whether hidden files and folders are displayed in the file selector.
See
Since 2.6 gtk_file_chooser_set_do_overwrite_confirmation ()void gtk_file_chooser_set_do_overwrite_confirmation (GtkFileChooser *chooser, gboolean do_overwrite_confirmation);
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
Regardless of this setting, the
If all you need is the stock confirmation dialog, set this property to
Since 2.8 gtk_file_chooser_get_do_overwrite_confirmation ()gboolean gtk_file_chooser_get_do_overwrite_confirmation (GtkFileChooser *chooser); Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.
Since 2.8 gtk_file_chooser_set_current_name ()void gtk_file_chooser_set_current_name (GtkFileChooser *chooser, const gchar *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.
If you want to preselect a particular existing file, you should use
Since 2.4 gtk_file_chooser_get_filename ()gchar* gtk_file_chooser_get_filename (GtkFileChooser *chooser); Gets the filename 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 gtk_file_chooser_set_filename ()gboolean gtk_file_chooser_set_filename (GtkFileChooser *chooser, const char *filename);
Sets
If the file name isn't in the current folder of Note that the file must exist, or nothing will be done except for the directory change. If you are implementing a 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 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. Instead, use something similar to this:if (document_is_new) { /* the user just created a new document */ gtk_file_chooser_set_current_folder (chooser, default_folder_for_saving); gtk_file_chooser_set_current_name (chooser, "Untitled document"); } else { /* the user edited an existing document */ gtk_file_chooser_set_filename (chooser, existing_filename); }
Since 2.4 gtk_file_chooser_select_filename ()gboolean gtk_file_chooser_select_filename (GtkFileChooser *chooser, const char *filename);
Selects a filename. If the file name isn't in the current
folder of
Since 2.4 gtk_file_chooser_unselect_filename ()void gtk_file_chooser_unselect_filename (GtkFileChooser *chooser, const char *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 gtk_file_chooser_select_all ()void gtk_file_chooser_select_all (GtkFileChooser *chooser); Selects all the files in the current folder of a file chooser.
Since 2.4 gtk_file_chooser_unselect_all ()void gtk_file_chooser_unselect_all (GtkFileChooser *chooser); Unselects all the files in the current folder of a file chooser.
Since 2.4 gtk_file_chooser_get_filenames ()GSList* gtk_file_chooser_get_filenames (GtkFileChooser *chooser);
Lists all the selected files and subfolders in the current folder of
Since 2.4 gtk_file_chooser_set_current_folder ()gboolean gtk_file_chooser_set_current_folder (GtkFileChooser *chooser, const gchar *filename);
Sets the current folder for
Since 2.4 gtk_file_chooser_get_current_folder ()gchar* gtk_file_chooser_get_current_folder (GtkFileChooser *chooser);
Gets the current folder of
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_SELECT_FOLDER mode
(e.g. "/home/username/Documents/selected-folder/". To get the
currently-selected folder in that mode, use
Since 2.4 gtk_file_chooser_get_uri ()gchar* gtk_file_chooser_get_uri (GtkFileChooser *chooser); 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 gtk_file_chooser_set_uri ()gboolean gtk_file_chooser_set_uri (GtkFileChooser *chooser, const char *uri);
Sets the file referred to by
If the URI isn't in the current folder of Note that the URI must exist, or nothing will be done except for the directory change. If you are implementing a 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 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. Instead, use something similar to this:if (document_is_new) { /* the user just created a new document */ gtk_file_chooser_set_current_folder_uri (chooser, default_folder_for_saving); gtk_file_chooser_set_current_name (chooser, "Untitled document"); } else { /* the user edited an existing document */ gtk_file_chooser_set_uri (chooser, existing_uri); }
Since 2.4 gtk_file_chooser_select_uri ()gboolean gtk_file_chooser_select_uri (GtkFileChooser *chooser, const char *uri);
Selects the file to by
Since 2.4 gtk_file_chooser_unselect_uri ()void gtk_file_chooser_unselect_uri (GtkFileChooser *chooser, const char *uri);
Unselects the file referred to by
Since 2.4 gtk_file_chooser_get_uris ()GSList* gtk_file_chooser_get_uris (GtkFileChooser *chooser);
Lists all the selected files and subfolders in the current folder of
Since 2.4 gtk_file_chooser_set_current_folder_uri ()gboolean gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser, const gchar *uri);
Sets the current folder for
Since 2.4 gtk_file_chooser_get_current_folder_uri ()gchar* gtk_file_chooser_get_current_folder_uri (GtkFileChooser *chooser);
Gets the current folder of
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_SELECT_FOLDER mode
(e.g. "file:///home/username/Documents/selected-folder/". To get the
currently-selected folder in that mode, use
Since 2.4 gtk_file_chooser_set_preview_widget ()void gtk_file_chooser_set_preview_widget (GtkFileChooser *chooser, GtkWidget *preview_widget);
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 When there is no application-supplied preview widget, or the application-supplied preview widget is not active, the file chooser may display an internally generated preview of the current file or it may display no preview at all.
Since 2.4 gtk_file_chooser_get_preview_widget ()GtkWidget* gtk_file_chooser_get_preview_widget (GtkFileChooser *chooser);
Gets the current preview widget; see
Since 2.4 gtk_file_chooser_set_preview_widget_active ()void gtk_file_chooser_set_preview_widget_active (GtkFileChooser *chooser, gboolean active);
Sets whether the preview widget set by
Since 2.4 gtk_file_chooser_get_preview_widget_active ()gboolean gtk_file_chooser_get_preview_widget_active (GtkFileChooser *chooser);
Gets whether the preview widget set by
Since 2.4 gtk_file_chooser_set_use_preview_label ()void gtk_file_chooser_set_use_preview_label (GtkFileChooser *chooser, gboolean use_label);
Sets whether the file chooser should display a stock label with the name of
the file that is being previewed; the default is
See also:
Since 2.4 gtk_file_chooser_get_use_preview_label ()gboolean gtk_file_chooser_get_use_preview_label (GtkFileChooser *chooser);
Gets whether a stock label should be drawn with the name of the previewed
file. See
gtk_file_chooser_get_preview_filename ()char* gtk_file_chooser_get_preview_filename (GtkFileChooser *chooser);
Gets the filename that should be previewed in a custom preview
widget. See
Since 2.4 gtk_file_chooser_get_preview_uri ()char* gtk_file_chooser_get_preview_uri (GtkFileChooser *chooser);
Gets the URI that should be previewed in a custom preview
widget. See
Since 2.4 gtk_file_chooser_set_extra_widget ()void gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser, GtkWidget *extra_widget); Sets an application-supplied widget to provide extra options to the user.
Since 2.4 gtk_file_chooser_get_extra_widget ()GtkWidget* gtk_file_chooser_get_extra_widget (GtkFileChooser *chooser);
Gets the current preview widget; see
Since 2.4 gtk_file_chooser_add_filter ()void gtk_file_chooser_add_filter (GtkFileChooser *chooser, GtkFileFilter *filter);
Adds
Note that the
Since 2.4 gtk_file_chooser_remove_filter ()void gtk_file_chooser_remove_filter (GtkFileChooser *chooser, GtkFileFilter *filter);
Removes
Since 2.4 gtk_file_chooser_list_filters ()GSList* gtk_file_chooser_list_filters (GtkFileChooser *chooser);
Lists the current set of user-selectable filters; see
Since 2.4 gtk_file_chooser_set_filter ()void gtk_file_chooser_set_filter (GtkFileChooser *chooser, GtkFileFilter *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 gtk_file_chooser_get_filter ()GtkFileFilter* gtk_file_chooser_get_filter (GtkFileChooser *chooser);
Gets the current filter; see
Since 2.4 gtk_file_chooser_add_shortcut_folder ()gboolean gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser, const char *folder, GError **error); 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 gtk_file_chooser_remove_shortcut_folder ()gboolean gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser, const char *folder, GError **error); Removes a folder from a file chooser's list of shortcut folders.
Since 2.4 gtk_file_chooser_list_shortcut_folders ()GSList* gtk_file_chooser_list_shortcut_folders (GtkFileChooser *chooser);
Queries the list of shortcut folders in the file chooser, as set by
Since 2.4 gtk_file_chooser_add_shortcut_folder_uri ()gboolean gtk_file_chooser_add_shortcut_folder_uri (GtkFileChooser *chooser, const char *uri, GError **error); 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 gtk_file_chooser_remove_shortcut_folder_uri ()gboolean gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser, const char *uri, GError **error); Removes a folder URI from a file chooser's list of shortcut folders.
Since 2.4 gtk_file_chooser_list_shortcut_folder_uris ()GSList* gtk_file_chooser_list_shortcut_folder_uris (GtkFileChooser *chooser);
Queries the list of shortcut folders in the file chooser, as set by
Since 2.4 gtk_file_chooser_get_current_folder_file ()GFile* gtk_file_chooser_get_current_folder_file (GtkFileChooser *chooser);
Gets the current folder of
Since 2.14 gtk_file_chooser_get_file ()GFile* gtk_file_chooser_get_file (GtkFileChooser *chooser); 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 gtk_file_chooser_get_files ()GSList* gtk_file_chooser_get_files (GtkFileChooser *chooser);
Lists all the selected files and subfolders in the current folder of
Since 2.14 gtk_file_chooser_get_preview_file ()GFile* gtk_file_chooser_get_preview_file (GtkFileChooser *chooser);
Gets the GFile that should be previewed in a custom preview
Internal function, see
Since 2.14 gtk_file_chooser_select_file ()gboolean gtk_file_chooser_select_file (GtkFileChooser *chooser, GFile *file, GError **error);
Selects the file referred to by
Since 2.14 gtk_file_chooser_set_current_folder_file ()gboolean gtk_file_chooser_set_current_folder_file (GtkFileChooser *chooser, GFile *file, GError **error);
Sets the current folder for
Since 2.14 gtk_file_chooser_set_file ()gboolean gtk_file_chooser_set_file (GtkFileChooser *chooser, GFile *file, GError **error);
Sets
If the file name isn't in the current folder of Note that the file must exist, or nothing will be done except for the directory change. If you are implementing a 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 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. Instead, use something similar to this:if (document_is_new) { /* the user just created a new document */ gtk_file_chooser_set_current_folder_file (chooser, default_file_for_saving); gtk_file_chooser_set_current_name (chooser, "Untitled document"); } else { /* the user edited an existing document */ gtk_file_chooser_set_file (chooser, existing_file); }
Since 2.14 gtk_file_chooser_unselect_file ()void gtk_file_chooser_unselect_file (GtkFileChooser *chooser, GFile *file);
Unselects the file referred to by
Since 2.14 Property DetailsThe
|
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
Returns : |
GtkFileChooserConfirmation value that indicates which
action to take after emitting the signal.
Since 2.8 |
"current-folder-changed"
signalvoid user_function (GtkFileChooser *chooser, gpointer user_data) : Run Last
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()
.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"file-activated"
signalvoid user_function (GtkFileChooser *chooser, gpointer user_data) : Run Last
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()
.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"selection-changed"
signalvoid user_function (GtkFileChooser *chooser, gpointer user_data) : Run Last
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()
.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"update-preview"
signalvoid user_function (GtkFileChooser *chooser, gpointer user_data) : Run Last
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()
.
|
the object which received the signal. |
|
user data set when the signal handler was connected. |