Package: gtk

Interface gtk-file-chooser

Superclasses

g-object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

Direct Slots

action
The "action" property of type gtk-file-chooser-action (Read / Write)
The type of operation that the file selector is performing.
Default value: :action-open
create-folders
The "create-folders" property of type :boolean (Read / Write)
Whether a file chooser not in :action-open mode will offer the user to create new folders.
Default value: true
Since 2.18
do-overwrite-confirmation
The "do-overwrite-confirmation" property of type :boolean (Read / Write)
Whether a file chooser in :action-save mode will present an overwrite confirmation dialog if the user selects a file name that already exists.
Default value: nil
Since 2.8
extra-widget
The "extra-widget" property of type gtk-widget (Read / Write)
Application supplied widget for extra options.
filter
The "filter" property of type gtk-file-filter (Read / Write)
The current filter for selecting which files are displayed.
local-only
The "local-only" property of type :boolean (Read / Write)
Whether the selected file(s) should be limited to local file URLs.
Default value: true
preview-widget
The "preview-widget" property of type gtk-widget (Read / Write)
Application supplied widget for custom previews.
preview-widget-active
The "preview-widget-active" property of type :boolean (Read / Write)
Whether the application supplied widget for custom previews should be shown.
Default value: true
select-multiple
The "select-multiple" property of type :boolean (Read / Write)
Whether to allow multiple files to be selected.
Default value: nil
show-hidden
The "show-hidden" property of type :boolean (Read / Write)
Whether the hidden files and folders should be displayed.
Default value: nil
use-preview-label
The "use-preview-label" property of type :boolean (Read / Write)
Whether to display a stock label with the name of the previewed file.
Default value: true

Details

gtk-file-chooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are gtk-file-chooser-widget, gtk-file-chooser-dialog, and gtk-file-chooser-button. You do not need to write an object that implements the gtk-file-chooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

gtk-file-chooser 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 or by the underlying filesystem abstraction (e. g. both the gnome-vfs and the Windows filesystems provide "Desktop" shortcuts). 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 gtk-file-chooser, 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 the gtk-file-chooser-get-filename function to open(2) or fopen(3), you may not be able to directly set it as the text of a gtk-label widget unless you convert it first to UTF-8, which all GTK+ widgets expect. You should use the g-filename-to-utf8 function to convert filenames into strings that can be passed to GTK+ widgets.

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 the gtk-file-chooser-set-preview-widget function. Then, connect to the "update-preview" signal to get notified when you need to update the contents of the preview.

Your callback should use the gtk-file-chooser-get-preview-filename function to see what needs previewing. Once you have generated the preview for the corresponding file, you must call the gtk-file-chooser-set-preview-widget-active function with a boolean flag that indicates whether your callback could successfully generate a preview.

Example: 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) g_object_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 the gtk-file-chooser-set-extra-widget function to insert additional widgets in a file chooser.

Example: 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); }
Note
If you want to set more than one extra widget in the file chooser, you can a container such as a gtk-box or a gtk-grid 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 GtkFileChooserDefaultClass. This widget has several key bindings and their associated signals. This section describes the available key binding signals.

Example: gtk-file-chooser key binding example

The default keys that activate the key-binding signals in GtkFileChooserDefaultClass are as follows:
Signal name
Default key combinations
location-popup
Control+L (empty path); / (path of "/") [a]; ~ (path of "~")
up-folder
Alt+Up; Alt+Shift+Up [b]; Backspace
down-folder
Alt+Down; Alt+Shift+Down [c]
home-folder
Alt+Home
desktop-folder
Alt+D
quick-bookmark
Alt+1 through Alt+0
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
 lambda (chooser path)    
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.
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
 lambda (chooser)    
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.
The "GtkFileChooserDefault::down-folder" signal
 lambda (chooser)    
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.
The "GtkFileChooserDefault::home-folder" signal
 lambda (chooser)    
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.
The "GtkFileChooserDefault::desktop-folder" signal
 lambda (chooser)    
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.
The "GtkFileChooserDefault::quick-bookmark" signal
 lambda (chooser bookmark-index)    
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-index
Index of the bookmark to switch to; the indices start at 0.

Signal Details

The "confirm-overwrite" signal
 lambda (chooser)   : Run Last      
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 :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 gtk-file-chooser-confirmation value, which indicates the action to take. If the handler determines that the user wants to select a different filename, it should return :select-again. If it determines that the user is satisfied with his choice of file name, it should return :accept-filename. On the other hand, if it determines that the stock confirmation dialog should be used, it should return :confirm. The following example illustrates this.

Example: Custom confirmation
   static GtkFileChooserConfirmation
   confirm_overwrite_callback (GtkFileChooser *chooser, gpointer data)
   {
     char *uri;
     uri = gtk_file_chooser_get_uri (chooser);

if (is_uri_read_only (uri)) { if (user_wants_to_replace_read_only_file (uri)) return GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME; else return GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN; } else // fall back to the default dialog return GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM; }

...

chooser = gtk_file_chooser_dialog_new (...);

gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog), TRUE); g_signal_connect (chooser, "confirm-overwrite", G_CALLBACK (confirm_overwrite_callback), NULL);

if (gtk_dialog_run (chooser) == GTK_RESPONSE_ACCEPT) save_to_file (gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (chooser));

gtk_widget_destroy (chooser);
chooser
The object which received the signal.
Returns
A gtk-file-chooser-confirmation value that indicates which action to take after emitting the signal.
Since 2.8

The "current-folder-changed" signal
 lambda (chooser)   : Run Last      
This signal is emitted when the current folder in a gtk-file-chooser 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 the functions: 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.
chooser
The object which received the signal.
The "file-activated" signal
 lambda (chooser)   : 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 gtk-file-chooser-dialog to know when to activate the default button in the dialog.

See also the functions: gtk-file-chooser-get-filename, gtk-file-chooser-get-filenames, gtk-file-chooser-get-uri, gtk-file-chooser-get-uris.
chooser
The object which received the signal.
The "selection-changed" signal
 lambda (chooser)   : Run Last      
This signal is emitted when there is a change in the set of selected files in a gtk-file-chooser. 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 the functions: 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.
chooser
The object which received the signal.
The "update-preview" signal
 lambda (chooser)   : 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 the gtk-file-chooser-set-preview-widget function, 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 the 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 the function: 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.
chooser
The object which received the signal.
 

Slot Access Functions

Inherited Slot Access Functions

2013-6-18