Module: Gtk::FileChooser

Defined in:
(unknown)

Overview

Gtk::FileChooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are Gtk::FileChooserWidget, #GtkFileChooserDialog, and Gtk::FileChooserButton. You do not need to write an object that implements the Gtk::FileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

Gtk::FileChooser allows for shortcuts to various places in the filesystem. In the default implementation these are displayed in the left pane. It may be a bit confusing at first that these shortcuts come from various sources and in various flavours, so lets explain the terminology here:

  • Bookmarks: are created by the user, by dragging folders from the right pane to the left pane, or by using the “Add”. Bookmarks can be renamed and deleted by the user.

  • Shortcuts: can be provided by the application. For example, a Paint program may want to add a shortcut for a Clipart folder. Shortcuts cannot be modified by the user.

  • Volumes: are provided by the underlying filesystem abstraction. They are the “roots” of the filesystem.

# File Names and Encodings

When the user is finished selecting files in a Gtk::FileChooser, 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() or fopen(), 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.

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

## Example: Using a Preview Widget ## #gtkfilechooser-preview

  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 Gtk::Box or a #GtkGrid and include your widgets in it. Then, set the container as the whole extra widget.

Instance Method Summary collapse

Instance Method Details

#action ⇒ Gtk::FileChooserAction

Gets the type of operation that the file chooser is performing; see gtk_file_chooser_set_action().

Returns:

#action=(action) ⇒ nil

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.

Parameters:

Returns:

  • (nil)

#add_choice(id, label, options, option_labels) ⇒ nil

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 gtk_file_chooser_set_choice() before the dialog is shown, and you can obtain the user-selected value in the ::response signal handler using gtk_file_chooser_get_choice().

Compare gtk_file_chooser_set_extra_widget().

Parameters:

  • id (String) —

    id for the added choice

  • label (String) —

    user-visible label for the added choice

  • options (Array<String>) —

    ids for the options of the choice, or nil for a boolean choice

  • option_labels (Array<String>) —

    user-visible labels for the options, must be the same length as options

Returns:

  • (nil)

#add_filter(filter) ⇒ nil

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.

Parameters:

Returns:

  • (nil)

#add_shortcut_folder(folder) ⇒ TrueClass

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. otherwise. In the latter case, the error will be set as appropriate.

Parameters:

  • folder (Gtk::filename) —

    filename of the folder to add

Returns:

  • (TrueClass) —

    true if the folder could be added successfully, false

#add_shortcut_folder_uri(uri) ⇒ TrueClass

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. otherwise. In the latter case, the error will be set as appropriate.

Parameters:

  • uri (String) —

    URI of the folder to add

Returns:

  • (TrueClass) —

    true if the folder could be added successfully, false

#create_folders ⇒ TrueClass

Gets whether file choser will offer to create new folders. See gtk_file_chooser_set_create_folders().

Returns:

  • (TrueClass) —

    true if the Create Folder button should be displayed.

#create_folders=(create_folders) ⇒ nil

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

Parameters:

  • create_folders (TrueClass) —

    true if the Create Folder button should be displayed

Returns:

  • (nil)

#current_folder ⇒ Gtk::filename

Gets the current folder of chooser as a local filename. See gtk_file_chooser_set_current_folder().

Note that this is the folder that the file chooser is currently displaying (e.g. “/home/username/Documents”), which is not the same as the currently-selected folder if the chooser is in %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER mode (e.g. “/home/username/Documents/selected-folder/”. To get the currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the usual way to get the selection. folder, or nil if the current path cannot be represented as a local filename. Free with g_free(). This function will also return nil 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.

Returns:

  • (Gtk::filename) —

    the full path of the current

#current_folder=(filename) ⇒ TrueClass

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.

Parameters:

  • filename (Gtk::filename) —

    the full path of the new current folder

Returns:

  • (TrueClass) —

    Not useful.

#current_folder_file ⇒ Gio::File

Gets the current folder of chooser as #GFile. See gtk_file_chooser_get_current_folder_uri().

Returns:

  • (Gio::File) —

    the #GFile for the current folder.

#current_folder_file=(file) ⇒ TrueClass

Sets the current folder for chooser from a #GFile. Internal function, see gtk_file_chooser_set_current_folder_uri(). otherwise.

Parameters:

  • file (Gio::File) —

    the #GFile for the new folder

Returns:

  • (TrueClass) —

    true if the folder could be changed successfully, false

#current_folder_uri ⇒ String

Gets the current folder of chooser as an URI. See gtk_file_chooser_set_current_folder_uri().

Note that this is the folder that the file chooser is currently displaying (e.g. “file:///home/username/Documents”), which is not the same as the currently-selected folder if the chooser is in %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER mode (e.g. “file:///home/username/Documents/selected-folder/”. To get the currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the usual way to get the selection. Free with g_free(). This function will also return nil 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_uri() on a nonexistent folder.

Returns:

  • (String) —

    the URI for the current folder.

#current_folder_uri=(uri) ⇒ TrueClass

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

Parameters:

  • uri (String) —

    the URI for the new current folder

Returns:

  • (TrueClass) —

    true if the folder could be changed successfully, false

#current_name ⇒ String

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”. g_free(). Note that this string is not a full pathname or URI; it is whatever the contents of the entry are. Note also that this string is in UTF-8 encoding, which is not necessarily the system’s encoding for filenames.

Returns:

  • (String) —

    The raw text from the file chooser’s “Name” entry. Free this with

#current_name=(name) ⇒ nil

Sets the current name in the file selector, as if entered by the user. Note that the name passed in here is a UTF-8 string rather than a filename. This function is meant for such uses as a suggested name in a “Save As…” dialog. You can pass “Untitled.doc” or a similarly suitable suggestion for the name.

If you want to preselect a particular existing file, you should use gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead. Please see the documentation for those functions for an example of using gtk_file_chooser_set_current_name() as well.

Parameters:

  • name (Gtk::filename) —

    the filename to use, as a UTF-8 string

Returns:

  • (nil)

#do_overwrite_confirmation ⇒ TrueClass

Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists. false otherwise.

Returns:

  • (TrueClass) —

    true if the file chooser will present a confirmation dialog;

#do_overwrite_confirmation=(do_overwrite_confirmation) ⇒ nil

Sets whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode will present a confirmation dialog if the user types a file name that already exists. This is false by default.

If set to true, the chooser will emit the Gtk::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 Gtk::FileChooser::confirm-overwrite signal; please refer to its documentation for the details.

Parameters:

  • do_overwrite_confirmation (TrueClass) —

    whether to confirm overwriting in save mode

Returns:

  • (nil)

#extra_widget ⇒ Gtk::Widget

Gets the current extra widget; see gtk_file_chooser_set_extra_widget().

Returns:

#extra_widget=(extra_widget) ⇒ nil

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

Parameters:

  • extra_widget (Gtk::Widget) —

    widget for extra options

Returns:

  • (nil)

#file ⇒ Gio::File

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.

Returns:

  • (Gio::File) —

    a selected #GFile. You own the returned file; use g_object_unref() to release it.

#file=(file) ⇒ TrueClass

Sets file as the current filename for the file chooser, by changing to the file’s parent folder and actually selecting the file in list. If the chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name will also appear in the dialog’s file name entry.

If the file name isn’t in the current folder of chooser, then the current folder of chooser will be changed to the folder containing filename. This is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by gtk_file_chooser_select_filename().

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

If you are implementing a 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:

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

Parameters:

  • file (Gio::File) —

    the #GFile to set as current

Returns:

  • (TrueClass) —

    Not useful.

#filename ⇒ Gtk::filename

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.

Returns:

  • (Gtk::filename) —

    The currently selected filename, or nil if no file is selected, or the selected file can’t be represented with a local filename. Free with g_free().

#filename=(filename) ⇒ TrueClass

Sets filename as the current filename for the file chooser, by changing to the file’s parent folder and actually selecting the file in list; all other files will be unselected. If the chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name will also appear in the dialog’s file name entry.

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

You should use this function only when implementing a 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:

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.

Parameters:

  • filename (Gtk::filename) —

    the filename to set as current

Returns:

  • (TrueClass) —

    Not useful.

#filenames ⇒ GLib::SList

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

Returns:

  • (GLib::SList) —

    a #GSList 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().

#files ⇒ GLib::SList

Lists all the selected files and subfolders in the current folder of chooser as #GFile. An internal function, see gtk_file_chooser_get_uris().

Returns:

  • (GLib::SList) —

    a #GSList containing a #GFile for each selected file and subfolder in the current folder. Free the returned list with g_slist_free(), and the files with g_object_unref().

#filter ⇒ Gtk::FileFilter

Gets the current filter; see gtk_file_chooser_set_filter().

Returns:

#filter=(filter) ⇒ nil

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.

Parameters:

Returns:

  • (nil)

#get_choice(id) ⇒ String

Gets the currently selected option in the ‘choice’ with the given ID.

Parameters:

  • id (String) —

    the ID of the choice to get

Returns:

  • (String) —

    the ID of the currenly selected option

#list_filters ⇒ GLib::SList

Lists the current set of user-selectable filters; see gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().

Returns:

  • (GLib::SList) —

    a #GSList 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.

#list_shortcut_folder_uris ⇒ GLib::SList

Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder_uri(). folder URIs, or nil if there are no shortcut folders. Free the returned list with g_slist_free(), and the URIs with g_free().

Returns:

  • (GLib::SList) —

    A list of

#list_shortcut_folders ⇒ GLib::SList

Queries the list of shortcut folders in the file chooser, as set by gtk_file_chooser_add_shortcut_folder(). of folder filenames, or nil if there are no shortcut folders. Free the returned list with g_slist_free(), and the filenames with g_free().

Returns:

  • (GLib::SList) —

    A list

#local_only ⇒ TrueClass

Gets whether only local files can be selected in the file selector. See gtk_file_chooser_set_local_only()

Returns:

  • (TrueClass) —

    true if only local files can be selected.

#local_only=(local_only) ⇒ nil

Sets whether only local files can be selected in the file selector. If local_only 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 Gtk::FileChooser, like gtk_file_chooser_get_filename(), rather than the URI functions like gtk_file_chooser_get_uri(),

On some systems non-native files may still be available using the native filesystem via a userspace filesystem (FUSE).

Parameters:

  • local_only (TrueClass) —

    true if only local files can be selected

Returns:

  • (nil)

#preview_file ⇒ Gio::File

Gets the #GFile that should be previewed in a custom preview Internal function, see gtk_file_chooser_get_preview_uri().

Returns:

  • (Gio::File) —

    the #GFile for the file to preview, or nil if no file is selected. Free with g_object_unref().

#preview_filename ⇒ Gtk::filename

Gets the filename that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget().

Returns:

  • (Gtk::filename) —

    the filename to preview, or nil if no file is selected, or if the selected file cannot be represented as a local filename. Free with g_free()

#preview_uri ⇒ String

Gets the URI that should be previewed in a custom preview widget. See gtk_file_chooser_set_preview_widget().

Returns:

  • (String) —

    the URI for the file to preview, or nil if no file is selected. Free with g_free().

#preview_widget ⇒ Gtk::Widget

Gets the current preview widget; see gtk_file_chooser_set_preview_widget().

Returns:

#preview_widget=(preview_widget) ⇒ nil

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 Gtk::FileChooser::update-preview signal, and call gtk_file_chooser_get_preview_filename() or gtk_file_chooser_get_preview_uri() on each change. If you can display a preview of the new file, update your widget and set the preview active using gtk_file_chooser_set_preview_widget_active(). Otherwise, set the preview inactive.

When there is no application-supplied preview widget, or the application-supplied preview widget is not active, the file chooser will display no preview at all.

Parameters:

  • preview_widget (Gtk::Widget) —

    widget for displaying preview.

Returns:

  • (nil)

#preview_widget_active ⇒ TrueClass

Gets whether the preview widget set by gtk_file_chooser_set_preview_widget() should be shown for the current filename. See gtk_file_chooser_set_preview_widget_active().

Returns:

  • (TrueClass) —

    true if the preview widget is active for the current filename.

#preview_widget_active=(active) ⇒ nil

Sets whether the preview widget set by gtk_file_chooser_set_preview_widget() should be shown for the current filename. When active is set to false, the file chooser may display an internally generated preview of the current file or it may display no preview at all. See gtk_file_chooser_set_preview_widget() for more details.

Parameters:

  • active (TrueClass) —

    whether to display the user-specified preview widget

Returns:

  • (nil)

#remove_choice(id) ⇒ nil

Removes a ‘choice’ that has been added with gtk_file_chooser_add_choice().

Parameters:

  • id (String) —

    the ID of the choice to remove

Returns:

  • (nil)

#remove_filter(filter) ⇒ nil

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

Parameters:

Returns:

  • (nil)

#remove_shortcut_folder(folder) ⇒ TrueClass

Removes a folder from a file chooser’s list of shortcut folders. In the latter case, the error will be set as appropriate.

See also: gtk_file_chooser_add_shortcut_folder()

Parameters:

  • folder (Gtk::filename) —

    filename of the folder to remove

Returns:

  • (TrueClass) —

    true if the operation succeeds, false otherwise.

#remove_shortcut_folder_uri(uri) ⇒ TrueClass

Removes a folder URI from a file chooser’s list of shortcut folders. In the latter case, the error will be set as appropriate.

See also: gtk_file_chooser_add_shortcut_folder_uri()

Parameters:

  • uri (String) —

    URI of the folder to remove

Returns:

  • (TrueClass) —

    true if the operation succeeds, false otherwise.

#select_all ⇒ nil

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

Returns:

  • (nil)

#select_file(file) ⇒ TrueClass

Selects the file referred to by file. An internal function. See _gtk_file_chooser_select_uri().

Parameters:

Returns:

  • (TrueClass) —

    Not useful.

#select_filename(filename) ⇒ TrueClass

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. See also: gtk_file_chooser_set_filename()

Parameters:

  • filename (Gtk::filename) —

    the filename to select

Returns:

  • (TrueClass) —

    Not useful.

#select_multiple ⇒ TrueClass

Gets whether multiple files can be selected in the file selector. See gtk_file_chooser_set_select_multiple().

Returns:

  • (TrueClass) —

    true if multiple files can be selected.

#select_multiple=(select_multiple) ⇒ nil

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.

Parameters:

  • select_multiple (TrueClass) —

    true if multiple files can be selected.

Returns:

  • (nil)

#select_uri(uri) ⇒ TrueClass

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.

Parameters:

  • uri (String) —

    the URI to select

Returns:

  • (TrueClass) —

    Not useful.

#set_choice(id, option) ⇒ nil

Selects an option in a ‘choice’ that has been added with gtk_file_chooser_add_choice(). For a boolean choice, the possible options are “true” and “false”.

Parameters:

  • id (String) —

    the ID of the choice to set

  • option (String) —

    the ID of the option to select

Returns:

  • (nil)

#show_hidden ⇒ TrueClass

Gets whether hidden files and folders are displayed in the file selector. See gtk_file_chooser_set_show_hidden().

Returns:

  • (TrueClass) —

    true if hidden files and folders are displayed.

#show_hidden=(show_hidden) ⇒ nil

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

Parameters:

  • show_hidden (TrueClass) —

    true if hidden files and folders should be displayed.

Returns:

  • (nil)

#unselect_all ⇒ nil

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

Returns:

  • (nil)

#unselect_file(file) ⇒ nil

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.

Parameters:

Returns:

  • (nil)

#unselect_filename(filename) ⇒ nil

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.

Parameters:

  • filename (Gtk::filename) —

    the filename to unselect

Returns:

  • (nil)

#unselect_uri(uri) ⇒ nil

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.

Parameters:

  • uri (String) —

    the URI to unselect

Returns:

  • (nil)

#uri ⇒ String

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.

Returns:

  • (String) —

    The currently selected URI, or nil if no file is selected. If gtk_file_chooser_set_local_only() is set to true (the default) a local URI will be returned for any FUSE locations. Free with g_free()

#uri=(uri) ⇒ TrueClass

Sets the file referred to by uri as the current file for the file chooser, by changing to the URI’s parent folder and actually selecting the URI in the list. If the chooser is %GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI’s base name will also appear in the dialog’s file name entry.

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

You should use this function only when implementing a 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:

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.

Parameters:

  • uri (String) —

    the URI to set as current

Returns:

  • (TrueClass) —

    Not useful.

#uris ⇒ GLib::SList

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

Returns:

  • (GLib::SList) —

    a #GSList 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().

#use_preview_label ⇒ TrueClass

Gets whether a stock label should be drawn with the name of the previewed file. See gtk_file_chooser_set_use_preview_label(). name of the previewed file, false otherwise.

Returns:

  • (TrueClass) —

    true if the file chooser is set to display a label with the

#use_preview_label=(use_label) ⇒ nil

Sets whether the file chooser should display a stock label with the name of the file that is being previewed; the default is true. Applications that want to draw the whole preview area themselves should set this to false and display the name themselves in their preview widget.

See also: gtk_file_chooser_set_preview_widget()

Parameters:

  • use_label (TrueClass) —

    whether to display a stock label with the name of the previewed file

Returns:

  • (nil)