Functions
gtk_file_chooser_set_local_only ()
void
gtk_file_chooser_set_local_only (GtkFileChooser *chooser,
gboolean local_only);
Sets whether only local files can be selected in the
file selector. If 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
GtkFileChooser, 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).
Since: 2.4
gtk_file_chooser_set_show_hidden ()
void
gtk_file_chooser_set_show_hidden (GtkFileChooser *chooser,
gboolean show_hidden);
Sets whether hidden files and folders are displayed in the file selector.
Since: 2.6
gtk_file_chooser_set_do_overwrite_confirmation ()
void
gtk_file_chooser_set_do_overwrite_confirmation
(GtkFileChooser *chooser,
gboolean do_overwrite_confirmation);
Sets whether a file chooser in GTK_FILE_CHOOSER_ACTION_SAVE mode will present
a confirmation dialog if the user types a file name that already exists. This
is FALSE by default.
If set to TRUE, the chooser
will emit the
“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
“confirm-overwrite” signal; please refer to its documentation
for the details.
Since: 2.8
gtk_file_chooser_get_do_overwrite_confirmation ()
gboolean
gtk_file_chooser_get_do_overwrite_confirmation
(GtkFileChooser *chooser);
Queries whether a file chooser is set to confirm for overwriting when the user
types a file name that already exists.
Returns
TRUE if the file chooser will present a confirmation dialog;
FALSE otherwise.
Since: 2.8
gtk_file_chooser_set_create_folders ()
void
gtk_file_chooser_set_create_folders (GtkFileChooser *chooser,
gboolean create_folders);
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.
Since: 2.18
gtk_file_chooser_set_current_name ()
void
gtk_file_chooser_set_current_name (GtkFileChooser *chooser,
const gchar *name);
Sets the current name in the file selector, as if entered
by the user. Note that the name passed in here is a UTF-8
string rather than a filename. This function is meant for
such uses as a suggested name in a “Save As...” dialog. 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.
Since: 2.4
gtk_file_chooser_get_current_name ()
gchar *
gtk_file_chooser_get_current_name (GtkFileChooser *chooser);
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”.
Returns
The raw text from the file chooser’s “Name” entry. Free this with
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.
Since: 3.10
gtk_file_chooser_get_filename ()
gchar *
gtk_file_chooser_get_filename (GtkFileChooser *chooser);
Gets the filename for the currently selected file in
the file selector. 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
The currently selected filename,
or NULL if no file is selected, or the selected file can't
be represented with a local filename. Free with g_free().
[nullable][type filename]
Since: 2.4
gtk_file_chooser_set_filename ()
gboolean
gtk_file_chooser_set_filename (GtkFileChooser *chooser,
const char *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; 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:
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
gtk_file_chooser_select_filename ()
gboolean
gtk_file_chooser_select_filename (GtkFileChooser *chooser,
const char *filename);
Selects a filename. If the file name isn’t in the current
folder of chooser
, then the current folder of chooser
will
be changed to the folder containing filename
.
Since: 2.4
gtk_file_chooser_unselect_filename ()
void
gtk_file_chooser_unselect_filename (GtkFileChooser *chooser,
const char *filename);
Unselects a currently selected filename. If the filename
is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
Since: 2.4
gtk_file_chooser_select_all ()
void
gtk_file_chooser_select_all (GtkFileChooser *chooser);
Selects all the files in the current folder of a file chooser.
Since: 2.4
gtk_file_chooser_unselect_all ()
void
gtk_file_chooser_unselect_all (GtkFileChooser *chooser);
Unselects all the files in the current folder of a file chooser.
Since: 2.4
gtk_file_chooser_get_filenames ()
GSList *
gtk_file_chooser_get_filenames (GtkFileChooser *chooser);
Lists all the selected files and subfolders in the current folder of
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
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().
[element-type filename][transfer full]
Since: 2.4
gtk_file_chooser_set_current_folder ()
gboolean
gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
const gchar *filename);
Sets the current folder for 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
for the rationale behind this.
Since: 2.4
gtk_file_chooser_get_current_folder ()
gchar *
gtk_file_chooser_get_current_folder (GtkFileChooser *chooser);
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.
Returns
the full path of the current
folder, or NULL if the current path cannot be represented as a local
filename. Free with g_free(). This function will also return
NULL 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.
[nullable][type filename]
Since: 2.4
gtk_file_chooser_get_uri ()
gchar *
gtk_file_chooser_get_uri (GtkFileChooser *chooser);
Gets the URI for the currently selected file in
the file selector. If multiple files are selected,
one of the filenames will be returned at random.
If the file chooser is in folder mode, this function returns the selected
folder.
Since: 2.4
gtk_file_chooser_set_uri ()
gboolean
gtk_file_chooser_set_uri (GtkFileChooser *chooser,
const char *uri);
Sets the file referred to by 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:
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
gtk_file_chooser_select_uri ()
gboolean
gtk_file_chooser_select_uri (GtkFileChooser *chooser,
const char *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
.
Since: 2.4
gtk_file_chooser_unselect_uri ()
void
gtk_file_chooser_unselect_uri (GtkFileChooser *chooser,
const char *uri);
Unselects the file referred to by uri
. If the file
is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
Since: 2.4
gtk_file_chooser_get_uris ()
GSList *
gtk_file_chooser_get_uris (GtkFileChooser *chooser);
Lists all the selected files and subfolders in the current folder of
chooser
. The returned names are full absolute URIs.
Returns
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().
[element-type utf8][transfer full]
Since: 2.4
gtk_file_chooser_set_current_folder_uri ()
gboolean
gtk_file_chooser_set_current_folder_uri
(GtkFileChooser *chooser,
const gchar *uri);
Sets the current folder for 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
for the rationale behind this.
Returns
TRUE if the folder could be changed successfully, FALSE
otherwise.
Since: 2.4
gtk_file_chooser_get_current_folder_uri ()
gchar *
gtk_file_chooser_get_current_folder_uri
(GtkFileChooser *chooser);
Gets the current folder of 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.
Returns
the URI for the current folder.
Free with g_free(). This function will also return NULL 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.
[nullable][transfer full]
Since: 2.4
gtk_file_chooser_set_preview_widget ()
void
gtk_file_chooser_set_preview_widget (GtkFileChooser *chooser,
GtkWidget *preview_widget);
Sets an application-supplied widget to use to display a custom preview
of the currently selected file. To implement a preview, after setting the
preview widget, you connect to the “update-preview”
signal, and call 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.
Since: 2.4
gtk_file_chooser_set_use_preview_label ()
void
gtk_file_chooser_set_use_preview_label
(GtkFileChooser *chooser,
gboolean use_label);
Sets whether the file chooser should display a stock label with the name of
the file that is being previewed; the default is 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()
Since: 2.4
gtk_file_chooser_get_use_preview_label ()
gboolean
gtk_file_chooser_get_use_preview_label
(GtkFileChooser *chooser);
Gets whether a stock label should be drawn with the name of the previewed
file. See gtk_file_chooser_set_use_preview_label().
Returns
TRUE if the file chooser is set to display a label with the
name of the previewed file, FALSE otherwise.
gtk_file_chooser_get_preview_filename ()
char *
gtk_file_chooser_get_preview_filename (GtkFileChooser *chooser);
Gets the filename that should be previewed in a custom preview
widget. See gtk_file_chooser_set_preview_widget().
Returns
the filename to preview, or NULL if
no file is selected, or if the selected file cannot be represented
as a local filename. Free with g_free().
[nullable][type filename]
Since: 2.4
gtk_file_chooser_get_preview_uri ()
char *
gtk_file_chooser_get_preview_uri (GtkFileChooser *chooser);
Gets the URI that should be previewed in a custom preview
widget. See gtk_file_chooser_set_preview_widget().
Returns
the URI for the file to preview,
or NULL if no file is selected. Free with g_free().
[nullable][transfer full]
Since: 2.4
gtk_file_chooser_set_extra_widget ()
void
gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser,
GtkWidget *extra_widget);
Sets an application-supplied widget to provide extra options to the user.
Since: 2.4
gtk_file_chooser_add_choice ()
void
gtk_file_chooser_add_choice (GtkFileChooser *chooser,
const char *id,
const char *label,
const char **options,
const char **option_labels);
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().
Since: 3.22
gtk_file_chooser_set_choice ()
void
gtk_file_chooser_set_choice (GtkFileChooser *chooser,
const char *id,
const char *option);
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".
Since: 3.22
gtk_file_chooser_get_choice ()
const char *
gtk_file_chooser_get_choice (GtkFileChooser *chooser,
const char *id);
Gets the currently selected option in the 'choice' with the given ID.
Returns
the ID of the currenly selected option
Since: 3.22
gtk_file_chooser_add_filter ()
void
gtk_file_chooser_add_filter (GtkFileChooser *chooser,
GtkFileFilter *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.
Since: 2.4
gtk_file_chooser_remove_filter ()
void
gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
GtkFileFilter *filter);
Removes filter
from the list of filters that the user can select between.
Since: 2.4
gtk_file_chooser_set_filter ()
void
gtk_file_chooser_set_filter (GtkFileChooser *chooser,
GtkFileFilter *filter);
Sets the current filter; only the files that pass the
filter will be displayed. If the user-selectable list of filters
is non-empty, then the filter should be one of the filters
in that list. Setting the current filter when the list of
filters is empty is useful if you want to restrict the displayed
set of files without letting the user change it.
Since: 2.4
gtk_file_chooser_add_shortcut_folder ()
gboolean
gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser,
const char *folder,
GError **error);
Adds a folder to be displayed with the shortcut folders in a file chooser.
Note that shortcut folders do not get saved, as they are provided by the
application. For example, you can use this to add a
“/usr/share/mydrawprogram/Clipart” folder to the volume list.
Returns
TRUE if the folder could be added successfully, FALSE
otherwise. In the latter case, the error
will be set as appropriate.
Since: 2.4
gtk_file_chooser_remove_shortcut_folder ()
gboolean
gtk_file_chooser_remove_shortcut_folder
(GtkFileChooser *chooser,
const char *folder,
GError **error);
Removes a folder from a file chooser’s list of shortcut folders.
Since: 2.4
gtk_file_chooser_list_shortcut_folders ()
GSList *
gtk_file_chooser_list_shortcut_folders
(GtkFileChooser *chooser);
Queries the list of shortcut folders in the file chooser, as set by
gtk_file_chooser_add_shortcut_folder().
Returns
A list
of folder filenames, or NULL if there are no shortcut folders.
Free the returned list with g_slist_free(), and the filenames with
g_free().
[nullable][element-type filename][transfer full]
Since: 2.4
gtk_file_chooser_add_shortcut_folder_uri ()
gboolean
gtk_file_chooser_add_shortcut_folder_uri
(GtkFileChooser *chooser,
const char *uri,
GError **error);
Adds a folder URI to be displayed with the shortcut folders in a file
chooser. Note that shortcut folders do not get saved, as they are provided
by the application. For example, you can use this to add a
“file:///usr/share/mydrawprogram/Clipart” folder to the volume list.
Returns
TRUE if the folder could be added successfully, FALSE
otherwise. In the latter case, the error
will be set as appropriate.
Since: 2.4
gtk_file_chooser_remove_shortcut_folder_uri ()
gboolean
gtk_file_chooser_remove_shortcut_folder_uri
(GtkFileChooser *chooser,
const char *uri,
GError **error);
Removes a folder URI from a file chooser’s list of shortcut folders.
Since: 2.4
gtk_file_chooser_get_file ()
GFile *
gtk_file_chooser_get_file (GtkFileChooser *chooser);
Gets the GFile for the currently selected file in
the file selector. If multiple files are selected,
one of the files will be returned at random.
If the file chooser is in folder mode, this function returns the selected
folder.
Since: 2.14
gtk_file_chooser_set_file ()
gboolean
gtk_file_chooser_set_file (GtkFileChooser *chooser,
GFile *file,
GError **error);
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:
Since: 2.14
gtk_file_chooser_unselect_file ()
void
gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
GFile *file);
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