Next: , Previous: GtkFileSelection, Up: Top

81 GtkFileChooser

File chooser interface used by GtkFileChooserWidget and GtkFileChooserDialog

81.1 Overview

<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 taht these shortcuts come from various sources and in various flavours, so lets explain the terminology here:

Shortcuts

Volumes

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.

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.

are provided by the underlying filesystem abstraction. They are the "roots" of the filesystem.

81.2 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.

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 <gtk-label> 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.

81.3 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 <gtk-file-chooser::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. 

     
     {
       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);
     }

81.4 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. 

     
     {
       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);
     }

If 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.

81.5 Key Bindings

Internally, GTK+ implements a file chooser's graphical user interface with the private . This widget has several key bindings and their associated signals. This section describes the available key binding signals.

The default keys that activate the key-binding signals in are as follows:

Both the individual key and the numeric keypad's "divide" key are supported.

Both the individual Up key and the numeric keypad's Up key are supported.

You can change these defaults to something else. For example, to add a modifier to a few of the default bindings, you can include the following fragment in your .gtkrc-2.0 file: 

     
     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"

81.5.1 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 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.

You can create your own bindings for the 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 shortcut by including the following in your .gtkrc-2.0: 

     
     binding "misc-shortcut" {
     	bind "<Alt>M" {
     		"location-popup" ("/home/username/misc")
     	}
     }
     
     class "GtkFileChooserDefault" binding "misc-shortcut"

81.5.2 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 and (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.

81.5.3 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 (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.

81.5.4 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 (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.

81.5.5 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 .

chooser
the object which received the signal.
user-data
user data set when the signal handler was connected.

81.5.6 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 , , etc. until . Note that in the default binding, that is actually defined to switch to the bookmark at index 0, and so on successively; 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.

81.6 Usage

— Class: <gtk-file-chooser>

Derives from <ginterface>.

This class defines the following slots:

filter
The current filter for selecting which files are displayed
local-only
Whether the selected file(s) should be limited to local file: URLs
use-preview-label
Whether to display a stock label with the name of the previewed file.
preview-widget-active
Whether the application supplied widget for custom previews should be shown.
preview-widget
Application supplied widget for custom previews.
show-hidden
Whether the hidden files and folders should be displayed
do-overwrite-confirmation
Whether a file chooser in save mode will present an overwrite confirmation dialog if necessary.
extra-widget
Application supplied widget for extra options.
file-system-backend
Name of file system backend to use
action
The type of operation that the file selector is performing
select-multiple
Whether to allow multiple files to be selected
— Signal on <gtk-file-chooser>: current-folder-changed

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

— Signal on <gtk-file-chooser>: selection-changed

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

— Signal on <gtk-file-chooser>: update-preview

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-wiget-active to inform the file chooser about whether the preview was generated successfully or not.

Please see the example code in (the missing figure, gtkfilechooser-preview.

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.

— Signal on <gtk-file-chooser>: file-activated

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 (keycap "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: gtk-file-chooser-get-filename, gtk-file-chooser-get-filenames, gtk-file-chooser-get-uri, gtk-file-chooser-get-uris.

— Signal on <gtk-file-chooser>: confirm-overwrite ⇒ <gtk-file-chooser-confirmation>

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 <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 <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.

— Function: gtk-file-chooser-set-action (self <gtk-file-chooser>) (action <gtk-file-chooser-action>)
— Method: set-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’.

chooser
a <gtk-file-chooser>
action
the action that the file selector is performing

Since 2.4

— Function: gtk-file-chooser-get-action (self <gtk-file-chooser>) ⇒  (ret <gtk-file-chooser-action>)
— Method: get-action

Gets the type of operation that the file chooser is performing; see gtk-file-chooser-set-action.

chooser
a <gtk-file-chooser>
ret
the action that the file selector is performing

Since 2.4

— Function: gtk-file-chooser-set-local-only (self <gtk-file-chooser>) (local_only bool)
— Method: set-local-only

Sets whether only local files can be selected in the file selector. If local-only is ‘#t’ (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 <gtk-file-chooser>, like gtk-file-chooser-get-filename, rather than the URI functions like gtk-file-chooser-get-uri,

chooser
a <gtk-file-chooser>
local-only
‘#t’ if only local files can be selected

Since 2.4

— Function: gtk-file-chooser-get-local-only (self <gtk-file-chooser>) ⇒  (ret bool)
— Method: get-local-only

Gets whether only local files can be selected in the file selector. See gtk-file-chooser-set-local-only

chooser
a <gtk-file-choosre>
ret
‘#t’ if only local files can be selected.

Since 2.4

— Function: gtk-file-chooser-set-show-hidden (self <gtk-file-chooser>) (show_hidden bool)
— Method: set-show-hidden

Sets whether hidden files and folders are displayed in the file selector.

chooser
a <gtk-file-chooser>
show-hidden
‘#t’ if hidden files and folders should be displayed.

Since 2.6

— Function: gtk-file-chooser-get-show-hidden (self <gtk-file-chooser>) ⇒  (ret bool)
— Method: get-show-hidden

Gets whether hidden files and folders are displayed in the file selector. See gtk-file-chooser-set-show-hidden.

chooser
a <gtk-file-chooser>
ret
‘#t’ if hidden files and folders are displayed.

Since 2.6

— Function: gtk-file-chooser-set-current-name (self <gtk-file-chooser>) (name mchars)
— Method: set-current-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 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.

chooser
a <gtk-file-chooser>
name
the filename to use, as a UTF-8 string

Since 2.4

— Function: gtk-file-chooser-get-filename (self <gtk-file-chooser>) ⇒  (ret mchars)
— Method: get-filename

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.

chooser
a <gtk-file-chooser>
ret
The currently selected filename, or ‘#f’ if no file is selected, or the selected file can't be represented with a local filename. Free with g-free.

Since 2.4

— Function: gtk-file-chooser-set-filename (self <gtk-file-chooser>) (filename mchars) ⇒  (ret bool)
— Method: set-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. 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 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 &#x2014; 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);
            }
chooser
a <gtk-file-chooser>
filename
the filename to set as current
ret
‘#t’ if both the folder could be changed and the file was selected successfully, ‘#f’ otherwise.

Since 2.4

— Function: gtk-file-chooser-select-filename (self <gtk-file-chooser>) (filename mchars) ⇒  (ret bool)
— Method: select-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.

chooser
a <gtk-file-chooser>
filename
the filename to select
ret
‘#t’ if both the folder could be changed and the file was selected successfully, ‘#f’ otherwise.

Since 2.4

— Function: gtk-file-chooser-unselect-filename (self <gtk-file-chooser>) (filename mchars)
— Method: unselect-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.

chooser
a <gtk-file-chooser>
filename
the filename to unselect

Since 2.4

— Function: gtk-file-chooser-select-all (self <gtk-file-chooser>)
— Method: select-all

Selects all the files in the current folder of a file chooser.

chooser
a <gtk-file-chooser>

Since 2.4

— Function: gtk-file-chooser-unselect-all (self <gtk-file-chooser>)
— Method: unselect-all

Unselects all the files in the current folder of a file chooser.

chooser
a <gtk-file-chooser>

Since 2.4

— Function: gtk-file-chooser-get-filenames (self <gtk-file-chooser>) ⇒  (ret gslist-of)
— Method: get-filenames

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)

chooser
a <gtk-file-chooser>
ret
a <gs-list> containing the filenames of all selected files and subfolders in the current folder. Free the returned list with g-slist-free, and the filenames with g-free.

Since 2.4

— Function: gtk-file-chooser-set-current-folder (self <gtk-file-chooser>) (filename mchars) ⇒  (ret bool)
— Method: set-current-folder

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.

chooser
a <gtk-file-chooser>
filename
the full path of the new current folder
ret
‘#t’ if the folder could be changed successfully, ‘#f’ otherwise.

Since 2.4

— Function: gtk-file-chooser-get-current-folder (self <gtk-file-chooser>) ⇒  (ret mchars)
— Method: get-current-folder

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-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.

chooser
a <gtk-file-chooser>
ret
the full path of the current folder, or ‘#f’ if the current path cannot be represented as a local filename. Free with g-free. This function will also return ‘#f’ if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling gtk-file-chooser-set-current-folder on a nonexistent folder.

Since 2.4

— Function: gtk-file-chooser-get-uri (self <gtk-file-chooser>) ⇒  (ret mchars)
— Method: get-uri

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.

chooser
a <gtk-file-chooser>
ret
The currently selected URI, or ‘#f’ if no file is selected. Free with g-free

Since 2.4

— Function: gtk-file-chooser-set-uri (self <gtk-file-chooser>) (uri mchars) ⇒  (ret bool)
— Method: set-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.

If the URI isn't in the current folder of chooser, then the current folder of chooser will be changed to the folder containing uri. This is equivalent to a sequence of gtk-file-chooser-unselect-all followed by gtk-file-chooser-select-uri.

Note that the URI must exist, or nothing will be done except for the directory change. If you are implementing a 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 (guimenuitem "File/Save As...") on it. If you don't have a file name already &#x2014; 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);
            }
chooser
a <gtk-file-chooser>
uri
the URI to set as current
ret
‘#t’ if both the folder could be changed and the URI was selected successfully, ‘#f’ otherwise.

Since 2.4

— Function: gtk-file-chooser-select-uri (self <gtk-file-chooser>) (uri mchars) ⇒  (ret bool)
— Method: select-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.

chooser
a <gtk-file-chooser>
uri
the URI to select
ret
‘#t’ if both the folder could be changed and the URI was selected successfully, ‘#f’ otherwise.

Since 2.4

— Function: gtk-file-chooser-unselect-uri (self <gtk-file-chooser>) (uri mchars)
— Method: unselect-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.

chooser
a <gtk-file-chooser>
uri
the URI to unselect

Since 2.4

— Function: gtk-file-chooser-get-uris (self <gtk-file-chooser>) ⇒  (ret gslist-of)
— Method: get-uris

Lists all the selected files and subfolders in the current folder of chooser. The returned names are full absolute URIs.

chooser
a <gtk-file-chooser>
ret
a <gs-list> containing the URIs of all selected files and subfolders in the current folder. Free the returned list with g-slist-free, and the filenames with g-free.

Since 2.4

— Function: gtk-file-chooser-set-preview-widget (self <gtk-file-chooser>) (preview_widget <gtk-widget>)
— Method: set-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 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 may display an internally generated preview of the current file or it may display no preview at all.

chooser
a <gtk-file-chooser>
preview-widget
widget for displaying preview.

Since 2.4

— Function: gtk-file-chooser-get-preview-widget (self <gtk-file-chooser>) ⇒  (ret <gtk-widget>)
— Method: get-preview-widget

Gets the current preview widget; see gtk-file-chooser-set-preview-widget.

chooser
a <gtk-file-chooser>
ret
the current preview widget, or ‘#f’

Since 2.4

— Function: gtk-file-chooser-get-preview-uri (self <gtk-file-chooser>) ⇒  (ret mchars)
— Method: get-preview-uri

Gets the URI that should be previewed in a custom preview widget. See gtk-file-chooser-set-preview-widget.

chooser
a <gtk-file-chooser>
ret
the URI for the file to preview, or ‘#f’ if no file is selected. Free with g-free.

Since 2.4

— Function: gtk-file-chooser-set-extra-widget (self <gtk-file-chooser>) (extra_widget <gtk-widget>)
— Method: set-extra-widget

Sets an application-supplied widget to provide extra options to the user.

chooser
a <gtk-file-chooser>
extra-widget
widget for extra options

Since 2.4

— Function: gtk-file-chooser-get-extra-widget (self <gtk-file-chooser>) ⇒  (ret <gtk-widget>)
— Method: get-extra-widget

Gets the current preview widget; see gtk-file-chooser-set-extra-widget.

chooser
a <gtk-file-chooser>
ret
the current extra widget, or ‘#f’

Since 2.4

— Function: gtk-file-chooser-add-filter (self <gtk-file-chooser>) (filter <gtk-file-filter>)
— Method: add-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.

chooser
a <gtk-file-chooser>
filter
a <gtk-file-filter>

Since 2.4

— Function: gtk-file-chooser-remove-filter (self <gtk-file-chooser>) (filter <gtk-file-filter>)
— Method: remove-filter

Removes filter from the list of filters that the user can select between.

chooser
a <gtk-file-chooser>
filter
a <gtk-file-filter>

Since 2.4

— Function: gtk-file-chooser-list-filters (self <gtk-file-chooser>) ⇒  (ret gslist-of)
— Method: list-filters

Lists the current set of user-selectable filters; see gtk-file-chooser-add-filter, gtk-file-chooser-remove-filter.

chooser
a <gtk-file-chooser>
ret
a <gs-list> containing the current set of user selectable filters. The contents of the list are owned by GTK+, but you must free the list itself with g-slist-free when you are done with it.

Since 2.4

— Function: gtk-file-chooser-set-filter (self <gtk-file-chooser>) (filter <gtk-file-filter>)
— Method: set-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.

chooser
a <gtk-file-chooser>
filter
a <gtk-file-filter>

Since 2.4

— Function: gtk-file-chooser-get-filter (self <gtk-file-chooser>) ⇒  (ret <gtk-file-filter>)
— Method: get-filter

Gets the current filter; see gtk-file-chooser-set-filter.

chooser
a <gtk-file-chooser>
ret
the current filter, or ‘#f’

Since 2.4