Memory-managed wrapper type.

A convenience alias for Nothing :: Maybe FileChooser.

Type class for types which can be safely cast to FileChooser, for instance with toFileChooser.

Cast to FileChooser, for types for which this is known to be safe. For general casts, use castTo.

Adds a 'choice' to the file chooser. This is typically implemented as a combobox or, for boolean choices, as a checkbutton. You can select a value using fileChooserSetChoice before the dialog is shown, and you can obtain the user-selected value in the ::response signal handler using fileChooserGetChoice.

Compare fileChooserSetExtraWidget.

Since: 3.22

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

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 the type of operation that the file chooser is performing; see fileChooserSetAction.

Since: 2.4

Gets the currently selected option in the 'choice' with the given ID.

Since: 3.22

Gets whether file choser will offer to create new folders. See fileChooserSetCreateFolders.

Since: 2.18

Gets the current folder of chooser as a local filename. See fileChooserSetCurrentFolder.

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 FileChooserActionSelectFolder mode (e.g. "/home/username/Documents/selected-folder/". To get the currently-selected folder in that mode, use fileChooserGetUri as the usual way to get the selection.

Since: 2.4

Gets the current folder of chooser as File. See fileChooserGetCurrentFolderUri.

Since: 2.14

Gets the current folder of chooser as an URI. See fileChooserSetCurrentFolderUri.

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 FileChooserActionSelectFolder mode (e.g. "file:///home/username/Documents/selected-folder/". To get the currently-selected folder in that mode, use fileChooserGetUri 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”.

Since: 3.10

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 extra widget; see fileChooserSetExtraWidget.

Since: 2.4

Gets the File 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 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 fileChooserGetUris)

Since: 2.4

Lists all the selected files and subfolders in the current folder of chooser as File. An internal function, see fileChooserGetUris.

Since: 2.14

Gets the current filter; see fileChooserSetFilter.

Since: 2.4

Gets whether only local files can be selected in the file selector. See fileChooserSetLocalOnly

Since: 2.4

Gets the File that should be previewed in a custom preview Internal function, see fileChooserGetPreviewUri.

Since: 2.14

Gets the filename that should be previewed in a custom preview widget. See fileChooserSetPreviewWidget.

Since: 2.4

Gets the URI that should be previewed in a custom preview widget. See fileChooserSetPreviewWidget.

Since: 2.4

Gets the current preview widget; see fileChooserSetPreviewWidget.

Since: 2.4

Gets whether the preview widget set by fileChooserSetPreviewWidget should be shown for the current filename. See fileChooserSetPreviewWidgetActive.

Since: 2.4

Gets whether multiple files can be selected in the file selector. See fileChooserSetSelectMultiple.

Since: 2.4

Gets whether hidden files and folders are displayed in the file selector. See fileChooserSetShowHidden.

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

Lists the current set of user-selectable filters; see fileChooserAddFilter, fileChooserRemoveFilter.

Since: 2.4

Queries the list of shortcut folders in the file chooser, as set by fileChooserAddShortcutFolderUri.

Since: 2.4

Queries the list of shortcut folders in the file chooser, as set by fileChooserAddShortcutFolder.

Since: 2.4

Removes a 'choice' that has been added with fileChooserAddChoice.

Since: 3.22

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 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 FileChooserActionSave but not if the action is FileChooserActionOpen.

Since: 2.4

Selects an option in a 'choice' that has been added with fileChooserAddChoice. For a boolean choice, the possible options are "true" and "false".

Since: 3.22

Sets whether file choser will offer to create new folders. This is only relevant if the action is not set to be FileChooserActionOpen.

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][gtkfilechooserdialog-setting-up] for the rationale behind this.

Since: 2.4

Sets the current folder for chooser from a File. Internal function, see fileChooserSetCurrentFolderUri.

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][gtkfilechooserdialog-setting-up] 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 fileChooserSetFilename or fileChooserSetUri instead. Please see the documentation for those functions for an example of using fileChooserSetCurrentName as well.

Since: 2.4

Sets whether a file chooser in FileChooserActionSave 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 FileChooser::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 FileChooser::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 FileChooserActionSave 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 fileChooserUnselectAll followed by fileChooserSelectFilename.

Note that the file must exist, or nothing will be done except for the directory change.

If you are implementing a save 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 Save As... 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:

C code

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

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 FileChooserActionSave 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 save 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 Save As... 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 not call this function. Instead, use something similar to this:

C code

if (document_is_new)
  {
    // the user just created a new document
    gtk_file_chooser_set_current_name (chooser, "Untitled document");
  }
else
  {
    // the user edited an existing document
    gtk_file_chooser_set_filename (chooser, existing_filename);
  }

In the first case, the file chooser will present the user with useful suggestions as to where to save his new file. In the second case, the file’s existing location is already known, so the file chooser will use it.

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 localOnly is True (the default), then the selected file or files are guaranteed to be accessible through the operating systems native file system and therefore the application only needs to worry about the filename functions in FileChooser, like fileChooserGetFilename, rather than the URI functions like fileChooserGetUri,

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 FileChooser::update-preview signal, and call fileChooserGetPreviewFilename or fileChooserGetPreviewUri on each change. If you can display a preview of the new file, update your widget and set the preview active using fileChooserSetPreviewWidgetActive. 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 fileChooserSetPreviewWidget 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 fileChooserSetPreviewWidget 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 FileChooserActionOpen or FileChooserActionSelectFolder.

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 FileChooserActionSave 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 save 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 Save As... 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 not call this function. Instead, use something similar to this:

C code

if (document_is_new)
  {
    // the user just created a new document
    gtk_file_chooser_set_current_name (chooser, "Untitled document");
  }
else
  {
    // the user edited an existing document
    gtk_file_chooser_set_uri (chooser, existing_uri);
  }

In the first case, the file chooser will present the user with useful suggestions as to where to save his new file. In the second case, the file’s existing location is already known, so the file chooser will use it.

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

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

Construct a GValueConstruct with valid value for the “action” property. This is rarely needed directly, but it is used by new.

Get the value of the “action” property. When overloading is enabled, this is equivalent to

get fileChooser #action

Set the value of the “action” property. When overloading is enabled, this is equivalent to

set fileChooser [ #action := value ]

Construct a GValueConstruct with valid value for the “create-folders” property. This is rarely needed directly, but it is used by new.

Get the value of the “create-folders” property. When overloading is enabled, this is equivalent to

get fileChooser #createFolders

Set the value of the “create-folders” property. When overloading is enabled, this is equivalent to

set fileChooser [ #createFolders := value ]

Construct a GValueConstruct with valid value for the “do-overwrite-confirmation” property. This is rarely needed directly, but it is used by new.

Get the value of the “do-overwrite-confirmation” property. When overloading is enabled, this is equivalent to

get fileChooser #doOverwriteConfirmation

Set the value of the “do-overwrite-confirmation” property. When overloading is enabled, this is equivalent to

set fileChooser [ #doOverwriteConfirmation := value ]

Construct a GValueConstruct with valid value for the “extra-widget” property. This is rarely needed directly, but it is used by new.

Get the value of the “extra-widget” property. When overloading is enabled, this is equivalent to

get fileChooser #extraWidget

Set the value of the “extra-widget” property. When overloading is enabled, this is equivalent to

set fileChooser [ #extraWidget := value ]

Construct a GValueConstruct with valid value for the “filter” property. This is rarely needed directly, but it is used by new.

Get the value of the “filter” property. When overloading is enabled, this is equivalent to

get fileChooser #filter

Set the value of the “filter” property. When overloading is enabled, this is equivalent to

set fileChooser [ #filter := value ]

Construct a GValueConstruct with valid value for the “local-only” property. This is rarely needed directly, but it is used by new.

Get the value of the “local-only” property. When overloading is enabled, this is equivalent to

get fileChooser #localOnly

Set the value of the “local-only” property. When overloading is enabled, this is equivalent to

set fileChooser [ #localOnly := value ]

Construct a GValueConstruct with valid value for the “preview-widget” property. This is rarely needed directly, but it is used by new.

Get the value of the “preview-widget” property. When overloading is enabled, this is equivalent to

get fileChooser #previewWidget

Set the value of the “preview-widget” property. When overloading is enabled, this is equivalent to

set fileChooser [ #previewWidget := value ]

Construct a GValueConstruct with valid value for the “preview-widget-active” property. This is rarely needed directly, but it is used by new.

Get the value of the “preview-widget-active” property. When overloading is enabled, this is equivalent to

get fileChooser #previewWidgetActive

Set the value of the “preview-widget-active” property. When overloading is enabled, this is equivalent to

set fileChooser [ #previewWidgetActive := value ]

Construct a GValueConstruct with valid value for the “select-multiple” property. This is rarely needed directly, but it is used by new.

Get the value of the “select-multiple” property. When overloading is enabled, this is equivalent to

get fileChooser #selectMultiple

Set the value of the “select-multiple” property. When overloading is enabled, this is equivalent to

set fileChooser [ #selectMultiple := value ]

Construct a GValueConstruct with valid value for the “show-hidden” property. This is rarely needed directly, but it is used by new.

Get the value of the “show-hidden” property. When overloading is enabled, this is equivalent to

get fileChooser #showHidden

Set the value of the “show-hidden” property. When overloading is enabled, this is equivalent to

set fileChooser [ #showHidden := value ]

Construct a GValueConstruct with valid value for the “use-preview-label” property. This is rarely needed directly, but it is used by new.

Get the value of the “use-preview-label” property. When overloading is enabled, this is equivalent to

get fileChooser #usePreviewLabel

Set the value of the “use-preview-label” property. When overloading is enabled, this is equivalent to

set fileChooser [ #usePreviewLabel := value ]

Type for the callback on the (unwrapped) C side.

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

Most applications just need to turn on the FileChooser:do-overwrite-confirmation property (or call the fileChooserSetDoOverwriteConfirmation 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 FileChooser::confirm-overwrite signal.

A signal handler for this signal must return a FileChooserConfirmation value, which indicates the action to take. If the handler determines that the user wants to select a different filename, it should return FileChooserConfirmationSelectAgain. If it determines that the user is satisfied with his choice of file name, it should return FileChooserConfirmationAcceptFilename. On the other hand, if it determines that the stock confirmation dialog should be used, it should return FileChooserConfirmationConfirm. The following example illustrates this.

## {gtkfilechooser-confirmation}

C code

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
      return GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM; // fall back to the default dialog
}

...

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

Since: 2.8

Connect a signal handler for the “confirm-overwrite” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fileChooser #confirmOverwrite callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_FileChooserConfirmOverwriteCallback.

A convenience synonym for Nothing :: Maybe FileChooserConfirmOverwriteCallback.

Connect a signal handler for the “confirm-overwrite” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fileChooser #confirmOverwrite callback

Wrap a FileChooserConfirmOverwriteCallback into a C_FileChooserConfirmOverwriteCallback.

Type for the callback on the (unwrapped) C side.

This signal is emitted when the current folder in a FileChooser 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: fileChooserSetCurrentFolder, fileChooserGetCurrentFolder, fileChooserSetCurrentFolderUri, fileChooserGetCurrentFolderUri.

Connect a signal handler for the “current-folder-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fileChooser #currentFolderChanged callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_FileChooserCurrentFolderChangedCallback.

A convenience synonym for Nothing :: Maybe FileChooserCurrentFolderChangedCallback.

Connect a signal handler for the “current-folder-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fileChooser #currentFolderChanged callback

Wrap a FileChooserCurrentFolderChangedCallback into a C_FileChooserCurrentFolderChangedCallback.

Type for the callback on the (unwrapped) C side.

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 FileChooserDialog to know when to activate the default button in the dialog.

See also: fileChooserGetFilename, fileChooserGetFilenames, fileChooserGetUri, fileChooserGetUris.

Connect a signal handler for the “file-activated” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fileChooser #fileActivated callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_FileChooserFileActivatedCallback.

A convenience synonym for Nothing :: Maybe FileChooserFileActivatedCallback.

Connect a signal handler for the “file-activated” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fileChooser #fileActivated callback

Wrap a FileChooserFileActivatedCallback into a C_FileChooserFileActivatedCallback.

Type for the callback on the (unwrapped) C side.

This signal is emitted when there is a change in the set of selected files in a FileChooser. 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: fileChooserSelectFilename, fileChooserUnselectFilename, fileChooserGetFilename, fileChooserGetFilenames, fileChooserSelectUri, fileChooserUnselectUri, fileChooserGetUri, fileChooserGetUris.

Connect a signal handler for the “selection-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fileChooser #selectionChanged callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_FileChooserSelectionChangedCallback.

A convenience synonym for Nothing :: Maybe FileChooserSelectionChangedCallback.

Connect a signal handler for the “selection-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fileChooser #selectionChanged callback

Wrap a FileChooserSelectionChangedCallback into a C_FileChooserSelectionChangedCallback.

Type for the callback on the (unwrapped) C side.

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 fileChooserSetPreviewWidget, you should update it when this signal is emitted. You can use the functions fileChooserGetPreviewFilename or fileChooserGetPreviewUri 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 fileChooserSetPreviewWidgetActive to inform the file chooser about whether the preview was generated successfully or not.

Please see the example code in [Using a Preview Widget][gtkfilechooser-preview].

See also: fileChooserSetPreviewWidget, fileChooserSetPreviewWidgetActive, fileChooserSetUsePreviewLabel, fileChooserGetPreviewFilename, fileChooserGetPreviewUri.

Connect a signal handler for the “update-preview” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after fileChooser #updatePreview callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_FileChooserUpdatePreviewCallback.

A convenience synonym for Nothing :: Maybe FileChooserUpdatePreviewCallback.

Connect a signal handler for the “update-preview” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on fileChooser #updatePreview callback

Wrap a FileChooserUpdatePreviewCallback into a C_FileChooserUpdatePreviewCallback.