* Boston, MA 02111-1307, USA.
*/
+#include <config.h>
#include "gtkfilechooser.h"
#include "gtkfilechooserprivate.h"
#include "gtkfilesystem.h"
+#include "gtkintl.h"
#include "gtktypebuiltins.h"
-
-#define _(str) (str)
+#include "gtkprivate.h"
+#include "gtkmarshalers.h"
+#include "gtkalias.h"
static void gtk_file_chooser_class_init (gpointer g_iface);
if (!file_chooser_type)
{
- static const GTypeInfo file_chooser_info =
- {
- sizeof (GtkFileChooserIface), /* class_size */
- NULL, /* base_init */
- NULL, /* base_finalize */
- (GClassInitFunc)gtk_file_chooser_class_init, /* class_init */
- };
-
- file_chooser_type = g_type_register_static (G_TYPE_INTERFACE,
- "GtkFileChooser",
- &file_chooser_info, 0);
-
+ file_chooser_type = g_type_register_static_simple (G_TYPE_INTERFACE,
+ I_("GtkFileChooser"),
+ sizeof (GtkFileChooserIface),
+ (GClassInitFunc) gtk_file_chooser_class_init,
+ 0, NULL, 0);
+
g_type_interface_add_prerequisite (file_chooser_type, GTK_TYPE_WIDGET);
}
return file_chooser_type;
}
+static gboolean
+confirm_overwrite_accumulator (GSignalInvocationHint *ihint,
+ GValue *return_accu,
+ const GValue *handler_return,
+ gpointer dummy)
+{
+ gboolean continue_emission;
+ GtkFileChooserConfirmation conf;
+
+ conf = g_value_get_enum (handler_return);
+ g_value_set_enum (return_accu, conf);
+ continue_emission = (conf == GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM);
+
+ return continue_emission;
+}
+
static void
gtk_file_chooser_class_init (gpointer g_iface)
{
GType iface_type = G_TYPE_FROM_INTERFACE (g_iface);
- g_signal_new ("current-folder-changed",
+ /**
+ * GtkFileChooser::current-folder-changed
+ * @chooser: the object which received the signal.
+ *
+ * This signal is emitted when the current folder in a #GtkFileChooser
+ * 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().
+ */
+ g_signal_new (I_("current-folder-changed"),
iface_type,
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkFileChooserIface, current_folder_changed),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
- g_signal_new ("selection-changed",
+
+ /**
+ * GtkFileChooser::selection-changed
+ * @chooser: the object which received the signal.
+ *
+ * This signal is emitted when there is a change in the set of selected files
+ * in a #GtkFileChooser. 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().
+ */
+ g_signal_new (I_("selection-changed"),
iface_type,
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkFileChooserIface, selection_changed),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
- g_signal_new ("update-preview",
+
+ /**
+ * GtkFileChooser::update-preview
+ * @chooser: the object which received the signal.
+ *
+ * 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 <xref linkend="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().
+ */
+ g_signal_new (I_("update-preview"),
iface_type,
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkFileChooserIface, update_preview),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
- g_signal_new ("file-activated",
+
+ /**
+ * GtkFileChooser::file-activated
+ * @chooser: the object which received the signal.
+ *
+ * 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</keycap>.
+ *
+ * Normally you do not need to connect to this signal. It is used internally
+ * by #GtkFileChooserDialog 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().
+ */
+ g_signal_new (I_("file-activated"),
iface_type,
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkFileChooserIface, file_activated),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+
+ /* Documented in the docbook files */
+ g_signal_new (I_("confirm-overwrite"),
+ iface_type,
+ G_SIGNAL_RUN_LAST,
+ G_STRUCT_OFFSET (GtkFileChooserIface, confirm_overwrite),
+ confirm_overwrite_accumulator, NULL,
+ _gtk_marshal_ENUM__VOID,
+ GTK_TYPE_FILE_CHOOSER_CONFIRMATION, 0);
g_object_interface_install_property (g_iface,
g_param_spec_enum ("action",
- _("Action"),
- _("The type of operation that the file selector is performing"),
+ P_("Action"),
+ P_("The type of operation that the file selector is performing"),
GTK_TYPE_FILE_CHOOSER_ACTION,
GTK_FILE_CHOOSER_ACTION_OPEN,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
g_object_interface_install_property (g_iface,
- g_param_spec_object ("file-system",
- _("File System"),
- _("File system object to use"),
- GTK_TYPE_FILE_SYSTEM,
- G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ g_param_spec_string ("file-system-backend",
+ P_("File System Backend"),
+ P_("Name of file system backend to use"),
+ NULL,
+ GTK_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
g_object_interface_install_property (g_iface,
g_param_spec_object ("filter",
- _("Filter"),
- _("The current filter for selecting which files are displayed"),
+ P_("Filter"),
+ P_("The current filter for selecting which files are displayed"),
GTK_TYPE_FILE_FILTER,
- G_PARAM_READWRITE));
- g_object_interface_install_property (g_iface,
- g_param_spec_boolean ("folder-mode",
- _("Folder Mode"),
- _("Whether to select folders rather than files"),
- FALSE,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
g_object_interface_install_property (g_iface,
g_param_spec_boolean ("local-only",
- _("Local Only"),
- _("Whether the selected file(s) should be limited to local file: URLs"),
+ P_("Local Only"),
+ P_("Whether the selected file(s) should be limited to local file: URLs"),
TRUE,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
g_object_interface_install_property (g_iface,
g_param_spec_object ("preview-widget",
- _("Preview widget"),
- _("Application supplied widget for custom previews."),
+ P_("Preview widget"),
+ P_("Application supplied widget for custom previews."),
GTK_TYPE_WIDGET,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
g_object_interface_install_property (g_iface,
g_param_spec_boolean ("preview-widget-active",
- _("Preview Widget Active"),
- _("Whether the application supplied widget for custom previews should be shown."),
+ P_("Preview Widget Active"),
+ P_("Whether the application supplied widget for custom previews should be shown."),
+ TRUE,
+ GTK_PARAM_READWRITE));
+ g_object_interface_install_property (g_iface,
+ g_param_spec_boolean ("use-preview-label",
+ P_("Use Preview Label"),
+ P_("Whether to display a stock label with the name of the previewed file."),
TRUE,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
g_object_interface_install_property (g_iface,
g_param_spec_object ("extra-widget",
- _("Extra widget"),
- _("Application supplied widget for extra options."),
+ P_("Extra widget"),
+ P_("Application supplied widget for extra options."),
GTK_TYPE_WIDGET,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
g_object_interface_install_property (g_iface,
g_param_spec_boolean ("select-multiple",
- _("Select Multiple"),
- _("Whether to allow multiple files to be selected"),
+ P_("Select Multiple"),
+ P_("Whether to allow multiple files to be selected"),
FALSE,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
g_object_interface_install_property (g_iface,
g_param_spec_boolean ("show-hidden",
- _("Show Hidden"),
- _("Whether the hidden files and folders should be displayed"),
+ P_("Show Hidden"),
+ P_("Whether the hidden files and folders should be displayed"),
FALSE,
- G_PARAM_READWRITE));
+ GTK_PARAM_READWRITE));
+
+ /**
+ * GtkFileChooser:do-overwrite-confirmation:
+ *
+ * Whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode
+ * will present an overwrite confirmation dialog if the user
+ * selects a file name that already exists.
+ *
+ * Since: 2.8
+ */
+ g_object_interface_install_property (g_iface,
+ g_param_spec_boolean ("do-overwrite-confirmation",
+ P_("Do overwrite confirmation"),
+ P_("Whether a file chooser in save mode "
+ "will present an overwrite confirmation dialog "
+ "if necessary."),
+ FALSE,
+ GTK_PARAM_READWRITE));
}
/**
GQuark
gtk_file_chooser_error_quark (void)
{
- static GQuark quark = 0;
- if (quark == 0)
- quark = g_quark_from_static_string ("gtk-file-chooser-error-quark");
- return quark;
+ return g_quark_from_static_string ("gtk-file-chooser-error-quark");
}
/**
* @chooser: a #GtkFileChooser
* @action: the action that the file selector is performing
*
- * Sets the type of operation that that the chooser is performing; the
+ * 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
return action;
}
-/**
- * gtk_file_chooser_set_folder_mode:
- * @chooser: a #GtkFileChooser
- * @folder_mode: %TRUE if the file chooser is used to select folders
- * rather than files.
- *
- * Sets whether the file chooser is used to select folders
- * rather than files. If in folder mode, only folders are displayed
- * to the use, and not the individual files inside the folders
- * and the user selects a single folder rather than one or
- * more files.
- *
- * Since: 2.4
- **/
-void
-gtk_file_chooser_set_folder_mode (GtkFileChooser *chooser,
- gboolean folder_mode)
-{
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
-
- g_object_set (chooser, "folder-mode", folder_mode, NULL);
-}
-
-/**
- * gtk_file_chooser_get_folder_mode:
- * @chooser: a #GtkFileChooser
- *
- * Gets whether the file chooser is used to select folders
- * rather than files. See gtk_file_chooser_set_folder_mode()
- *
- * Return value: %TRUE if the file chooser is used to select
- * folders rather than files.
- *
- * Since: 2.4
- **/
-gboolean
-gtk_file_chooser_get_folder_mode (GtkFileChooser *chooser)
-{
- gboolean folder_mode;
-
- g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
-
- g_object_get (chooser, "folder-mode", &folder_mode, NULL);
-
- return folder_mode;
-}
-
/**
* gtk_file_chooser_set_local_only:
* @chooser: a #GtkFileChooser
* @chooser: a #GtkFileChooser
* @select_multiple: %TRUE if multiple files can be selected.
*
- * Sets whether multiple files can be selected in the file
- * selector. If the file selector if in folder mode (see
- * gtk_file_selector_set_folder_mode()) then only one folder
- * can be selected, without regard to this setting.
+ * 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_SAVE. It cannot be set with either of the folder
+ * actions.
*
* Since: 2.4
**/
* 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.
*
* Return value: The currently selected filename, or %NULL
* if no file is selected, or the selected file can't
* @chooser: a #GtkFileChooser
* @filename: the filename to set as current
*
- * Sets @filename as the current filename for the the file chooser;
- * 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().
+ * 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. To pre-enter a filename for the user, as in
- * a save-as dialog, use gtk_file_chooser_set_current_name()
+ * for the directory change.
+ *
+ * If you are implementing a <guimenuitem>File/Save As...</guimenuitem> 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 <guimenuitem>File/Save As...</guimenuitem>
+ * on it. 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:
+ *
+ * <programlisting>
+ * 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);
+ * }
+ * </programlisting>
+ *
+ * Return value: %TRUE if both the folder could be changed and the file was
+ * selected successfully, %FALSE otherwise.
*
* Since: 2.4
**/
-void
+gboolean
gtk_file_chooser_set_filename (GtkFileChooser *chooser,
const gchar *filename)
{
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
gtk_file_chooser_unselect_all (chooser);
- gtk_file_chooser_select_filename (chooser, filename);
+ return gtk_file_chooser_select_filename (chooser, filename);
}
/**
* folder of @chooser, then the current folder of @chooser will
* be changed to the folder containing @filename.
*
+ * Return value: %TRUE if both the folder could be changed and the file was
+ * selected successfully, %FALSE otherwise.
+ *
* Since: 2.4
**/
-void
+gboolean
gtk_file_chooser_select_filename (GtkFileChooser *chooser,
const gchar *filename)
{
GtkFileSystem *file_system;
GtkFilePath *path;
+ gboolean result;
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
- g_return_if_fail (filename != NULL);
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+ g_return_val_if_fail (filename != NULL, FALSE);
file_system = _gtk_file_chooser_get_file_system (chooser);
path = gtk_file_system_filename_to_path (file_system, filename);
if (path)
{
- _gtk_file_chooser_select_path (chooser, path);
+ result = _gtk_file_chooser_select_path (chooser, path, NULL);
gtk_file_path_free (path);
}
+ else
+ result = FALSE;
+
+ return result;
}
/**
* The user will be shown the full contents of the current folder,
* plus user interface elements for navigating to other folders.
*
+ * Return value: %TRUE if the folder could be changed successfully, %FALSE
+ * otherwise.
+ *
* Since: 2.4
**/
-void
+gboolean
gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
const gchar *filename)
{
GtkFileSystem *file_system;
GtkFilePath *path;
+ gboolean result;
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
- g_return_if_fail (filename != NULL);
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+ g_return_val_if_fail (filename != NULL, FALSE);
file_system = _gtk_file_chooser_get_file_system (chooser);
path = gtk_file_system_filename_to_path (file_system, filename);
if (path)
{
- _gtk_file_chooser_set_current_folder_path (chooser, path);
+ result = _gtk_file_chooser_set_current_folder_path (chooser, path, NULL);
gtk_file_path_free (path);
}
+ else
+ result = FALSE;
+
+ return result;
}
/**
*
* Gets the current folder of @chooser as a local filename.
* See gtk_file_chooser_set_current_folder().
- *
- * Return value: the full path of the current folder, or %NULL
- * if the current path cannot be represented as a local filename.
- * Free with g_free().
+ *
+ * Note that this is the folder that the file chooser is currently displaying
+ * (e.g. "/home/username/Documents"), which is <emphasis>not the same</emphasis>
+ * 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.
+ *
+ * Return value: 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.
*
* Since: 2.4
**/
file_system = _gtk_file_chooser_get_file_system (chooser);
path = _gtk_file_chooser_get_current_folder_path (chooser);
+ if (!path)
+ return NULL;
+
filename = gtk_file_system_path_to_filename (file_system, path);
gtk_file_path_free (path);
* 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() instead.
+ * 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
**/
* 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.
+ *
* Return value: The currently selected URI, or %NULL
* if no file is selected. Free with g_free()
*
* @chooser: a #GtkFileChooser
* @uri: the URI to set as current
*
- * Sets the file referred to by @uri as the current file for the the
- * file chooser; 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
- * @uri. This is equivalent to a sequence of gtk_file_chooser_unselect_all()
- * followed by gtk_file_chooser_select_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 file must exist, or nothing will be done except
- * for the directory change. To pre-enter a filename for the user, as in
- * a save-as dialog, use gtk_file_chooser_set_current_name()
+ * 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 <guimenuitem>File/Save As...</guimenuitem> 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 <guimenuitem>File/Save As...</guimenuitem>
+ * on it. 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:
+ *
+ * <programlisting>
+ * 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);
+ * }
+ * </programlisting>
+ *
+ * Return value: %TRUE if both the folder could be changed and the URI was
+ * selected successfully, %FALSE otherwise.
*
* Since: 2.4
**/
-void
+gboolean
gtk_file_chooser_set_uri (GtkFileChooser *chooser,
const char *uri)
{
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
gtk_file_chooser_unselect_all (chooser);
- gtk_file_chooser_select_uri (chooser, uri);
+ return gtk_file_chooser_select_uri (chooser, uri);
}
/**
* file in the current folder of @chooser, then the current folder of
* @chooser will be changed to the folder containing @filename.
*
+ * Return value: %TRUE if both the folder could be changed and the URI was
+ * selected successfully, %FALSE otherwise.
+ *
* Since: 2.4
**/
-void
+gboolean
gtk_file_chooser_select_uri (GtkFileChooser *chooser,
const char *uri)
{
GtkFileSystem *file_system;
GtkFilePath *path;
+ gboolean result;
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
- g_return_if_fail (uri != NULL);
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+ g_return_val_if_fail (uri != NULL, FALSE);
file_system = _gtk_file_chooser_get_file_system (chooser);
path = gtk_file_system_uri_to_path (file_system, uri);
if (path)
{
- _gtk_file_chooser_select_path (chooser, path);
+ result = _gtk_file_chooser_select_path (chooser, path, NULL);
gtk_file_path_free (path);
}
+ else
+ result = FALSE;
+
+ return result;
}
/**
}
}
+/**
+ * gtk_file_chooser_select_all:
+ * @chooser: a #GtkFileChooser
+ *
+ * Selects all the files in the current folder of a file chooser.
+ *
+ * Since: 2.4
+ **/
void
gtk_file_chooser_select_all (GtkFileChooser *chooser)
{
GTK_FILE_CHOOSER_GET_IFACE (chooser)->select_all (chooser);
}
+/**
+ * gtk_file_chooser_unselect_all:
+ * @chooser: a #GtkFileChooser
+ *
+ * Unselects all the files in the current folder of a file chooser.
+ *
+ * Since: 2.4
+ **/
void
gtk_file_chooser_unselect_all (GtkFileChooser *chooser)
{
* The user will be shown the full contents of the current folder,
* plus user interface elements for navigating to other folders.
*
+ * Return value: %TRUE if the folder could be changed successfully, %FALSE
+ * otherwise.
+ *
* Since: 2.4
**/
-void
+gboolean
gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser,
const gchar *uri)
{
GtkFileSystem *file_system;
GtkFilePath *path;
+ gboolean result;
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
- g_return_if_fail (uri != NULL);
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+ g_return_val_if_fail (uri != NULL, FALSE);
file_system = _gtk_file_chooser_get_file_system (chooser);
path = gtk_file_system_uri_to_path (file_system, uri);
if (path)
{
- _gtk_file_chooser_set_current_folder_path (chooser, path);
+ result = _gtk_file_chooser_set_current_folder_path (chooser, path, NULL);
gtk_file_path_free (path);
}
+ else
+ result = FALSE;
+
+ return result;
}
/**
*
* Gets the current folder of @chooser as an URI.
* See gtk_file_chooser_set_current_folder_uri().
- *
- * Return value: the URI for the current folder.
- * Free with g_free().
+ *
+ * Note that this is the folder that the file chooser is currently displaying
+ * (e.g. "file:///home/username/Documents"), which is <emphasis>not the same</emphasis>
+ * as the currently-selected folder if the chooser is in
+ * #GTK_FILE_CHOOSER_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.
+ *
+ * Return value: 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.
*
* Since: 2.4
*/
* _gtk_file_chooser_set_current_folder_path:
* @chooser: a #GtkFileChooser
* @path: the #GtkFilePath for the new folder
+ * @error: location to store error, or %NULL.
*
* Sets the current folder for @chooser from a #GtkFilePath.
* Internal function, see gtk_file_chooser_set_current_folder_uri().
*
+ * Return value: %TRUE if the folder could be changed successfully, %FALSE
+ * otherwise.
+ *
* Since: 2.4
**/
-void
+gboolean
_gtk_file_chooser_set_current_folder_path (GtkFileChooser *chooser,
- const GtkFilePath *path)
+ const GtkFilePath *path,
+ GError **error)
{
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
- g_return_if_fail (path != NULL);
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+ g_return_val_if_fail (path != NULL, FALSE);
+ g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
- GTK_FILE_CHOOSER_GET_IFACE (chooser)->set_current_folder (chooser, path);
+ return GTK_FILE_CHOOSER_GET_IFACE (chooser)->set_current_folder (chooser, path, error);
}
/**
* _gtk_file_chooser_select_path:
* @chooser: a #GtkFileChooser
* @path: the path to select
+ * @error: location to store error, or %NULL
*
* Selects the file referred to by @path. An internal function. See
* _gtk_file_chooser_select_uri().
*
+ * Return value: %TRUE if both the folder could be changed and the path was
+ * selected successfully, %FALSE otherwise.
+ *
* Since: 2.4
**/
-void
+gboolean
_gtk_file_chooser_select_path (GtkFileChooser *chooser,
- const GtkFilePath *path)
+ const GtkFilePath *path,
+ GError **error)
{
- g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+ g_return_val_if_fail (path != NULL, FALSE);
+ g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
- GTK_FILE_CHOOSER_GET_IFACE (chooser)->select_path (chooser, path);
+ return GTK_FILE_CHOOSER_GET_IFACE (chooser)->select_path (chooser, path, error);
}
/**
*
* 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 ::selection-changed
+ * 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
* @active: whether to display the user-specified preview widget
*
* Sets whether the preview widget set by
- * gtk_file_chooser_set_preview_widget_active() should be shown for the
+ * 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_get_preview_widget_active:
* @chooser: a #GtkFileChooser
*
- * Gets whether the preview widget set by
- * gtk_file_chooser_set_preview_widget_active() should be shown for the
- * current filename. See gtk_file_chooser_set_preview_widget_active().
+ * 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().
*
- * Return value: %TRUE if the preview widget is active for the
- * current filename.
+ * Return value: %TRUE if the preview widget is active for the current filename.
*
* Since: 2.4
**/
return active;
}
+/**
+ * gtk_file_chooser_set_use_preview_label:
+ * @chooser: a #GtkFileChooser
+ * @use_label: whether to display a stock label with the name of the previewed file
+ *
+ * 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
+ **/
+void
+gtk_file_chooser_set_use_preview_label (GtkFileChooser *chooser,
+ gboolean use_label)
+{
+ g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
+
+ g_object_set (chooser, "use-preview-label", use_label, NULL);
+}
+
+/**
+ * gtk_file_chooser_get_use_preview_label:
+ * @chooser: a #GtkFileChooser
+ *
+ * Gets whether a stock label should be drawn with the name of the previewed
+ * file. See gtk_file_chooser_set_use_preview_label().
+ *
+ * Return value: %TRUE if the file chooser is set to display a label with the
+ * name of the previewed file, %FALSE otherwise.
+ **/
+gboolean
+gtk_file_chooser_get_use_preview_label (GtkFileChooser *chooser)
+{
+ gboolean use_label;
+
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+
+ g_object_get (chooser, "use-preview-label", &use_label, NULL);
+
+ return use_label;
+}
+
/**
* gtk_file_chooser_get_preview_filename:
* @chooser: a #GtkFileChooser
}
/**
- * gtk_file_chooser_get_preview_filename:
+ * gtk_file_chooser_get_preview_uri:
* @chooser: a #GtkFileChooser
*
* Gets the URI that should be previewed in a custom preview
* widget. See gtk_file_chooser_set_preview_widget().
*
- * Return value: the URI for the file to preview, or %NULL if no file
- * is selected. Free with g_free().
+ * Return value: the URI for the file to preview, or %NULL if no file is
+ * selected. Free with g_free().
*
* Since: 2.4
**/
*
* 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.
+ * 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_add_filter:
+ * gtk_file_chooser_remove_filter:
* @chooser: a #GtkFileChooser
* @filter: a #GtkFileFilter
*
/**
* gtk_file_chooser_list_filters:
- * @choooser: a #GtkFileChooser
+ * @chooser: a #GtkFileChooser
*
* Lists the current set of user-selectable filters; see
* gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
g_set_error (error,
GTK_FILE_CHOOSER_ERROR,
GTK_FILE_CHOOSER_ERROR_BAD_FILENAME,
- "Invalid filename: %s",
+ _("Invalid filename: %s"),
folder);
return FALSE;
}
g_set_error (error,
GTK_FILE_CHOOSER_ERROR,
GTK_FILE_CHOOSER_ERROR_BAD_FILENAME,
- "Invalid filename: %s",
+ _("Invalid filename: %s"),
folder);
return FALSE;
}
* @chooser: a #GtkFileChooser
*
* Queries the list of shortcut folders in the file chooser, as set by
- * gtk_file_chooser_set_shortcut_folders().
+ * gtk_file_chooser_add_shortcut_folder().
*
* Return value: 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
/**
* gtk_file_chooser_add_shortcut_folder_uri:
* @chooser: a #GtkFileChooser
- * @folder: URI of the folder to add
+ * @uri: URI of the folder to add
* @error: location to store error, or %NULL
*
* Adds a folder URI to be displayed with the shortcut folders in a file
g_set_error (error,
GTK_FILE_CHOOSER_ERROR,
GTK_FILE_CHOOSER_ERROR_BAD_FILENAME,
- "Invalid filename: %s",
+ _("Invalid filename: %s"),
uri);
return FALSE;
}
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
g_return_val_if_fail (uri != NULL, FALSE);
- path = gtk_file_system_filename_to_path (_gtk_file_chooser_get_file_system (chooser), uri);
+ path = gtk_file_system_uri_to_path (_gtk_file_chooser_get_file_system (chooser), uri);
if (!path)
{
g_set_error (error,
GTK_FILE_CHOOSER_ERROR,
GTK_FILE_CHOOSER_ERROR_BAD_FILENAME,
- "Invalid filename: %s",
+ _("Invalid filename: %s"),
uri);
return FALSE;
}
* @chooser: a #GtkFileChooser
*
* Queries the list of shortcut folders in the file chooser, as set by
- * gtk_file_chooser_set_shortcut_folder_uris().
+ * gtk_file_chooser_add_shortcut_folder_uri().
*
* Return value: A list of folder URIs, or %NULL if there are no shortcut
* folders. Free the returned list with g_slist_free(), and the URIs with
gtk_file_paths_free (folders);
return result;
}
+
+
+/**
+ * gtk_file_chooser_set_show_hidden:
+ * @chooser: a #GtkFileChooser
+ * @show_hidden: %TRUE if hidden files and folders should be displayed.
+ *
+ * Sets whether hidden files and folders are displayed in the file selector.
+ *
+ * Since: 2.6
+ **/
+void
+gtk_file_chooser_set_show_hidden (GtkFileChooser *chooser,
+ gboolean show_hidden)
+{
+ g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
+
+ g_object_set (chooser, "show-hidden", show_hidden, NULL);
+}
+
+/**
+ * gtk_file_chooser_get_show_hidden:
+ * @chooser: a #GtkFileChooser
+ *
+ * Gets whether hidden files and folders are displayed in the file selector.
+ * See gtk_file_chooser_set_show_hidden().
+ *
+ * Return value: %TRUE if hidden files and folders are displayed.
+ *
+ * Since: 2.6
+ **/
+gboolean
+gtk_file_chooser_get_show_hidden (GtkFileChooser *chooser)
+{
+ gboolean show_hidden;
+
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+
+ g_object_get (chooser, "show-hidden", &show_hidden, NULL);
+
+ return show_hidden;
+}
+
+/**
+ * gtk_file_chooser_set_do_overwrite_confirmation:
+ * @chooser: a #GtkFileChooser
+ * @do_overwrite_confirmation: whether to confirm overwriting in save mode
+ *
+ * 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.
+ *
+ * Regardless of this setting, 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
+ **/
+void
+gtk_file_chooser_set_do_overwrite_confirmation (GtkFileChooser *chooser,
+ gboolean do_overwrite_confirmation)
+{
+ g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
+
+ g_object_set (chooser, "do-overwrite-confirmation", do_overwrite_confirmation, NULL);
+}
+
+/**
+ * gtk_file_chooser_get_do_overwrite_confirmation:
+ * @chooser: a #GtkFileChooser
+ *
+ * Queries whether a file chooser is set to confirm for overwriting when the user
+ * types a file name that already exists.
+ *
+ * Return value: %TRUE if the file chooser will present a confirmation dialog;
+ * %FALSE otherwise.
+ *
+ * Since: 2.8
+ **/
+gboolean
+gtk_file_chooser_get_do_overwrite_confirmation (GtkFileChooser *chooser)
+{
+ gboolean do_overwrite_confirmation;
+
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+
+ g_object_get (chooser, "do-overwrite-confirmation", &do_overwrite_confirmation, NULL);
+
+ return do_overwrite_confirmation;
+}
+
+#ifdef G_OS_WIN32
+
+/* DLL ABI stability backward compatibility versions */
+
+#undef gtk_file_chooser_get_filename
+
+gchar *
+gtk_file_chooser_get_filename (GtkFileChooser *chooser)
+{
+ gchar *utf8_filename = gtk_file_chooser_get_filename_utf8 (chooser);
+ gchar *retval = g_locale_from_utf8 (utf8_filename, -1, NULL, NULL, NULL);
+
+ g_free (utf8_filename);
+
+ return retval;
+}
+
+#undef gtk_file_chooser_set_filename
+
+gboolean
+gtk_file_chooser_set_filename (GtkFileChooser *chooser,
+ const gchar *filename)
+{
+ gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
+ gboolean retval = gtk_file_chooser_set_filename_utf8 (chooser, utf8_filename);
+
+ g_free (utf8_filename);
+
+ return retval;
+}
+
+#undef gtk_file_chooser_select_filename
+
+gboolean
+gtk_file_chooser_select_filename (GtkFileChooser *chooser,
+ const gchar *filename)
+{
+ gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
+ gboolean retval = gtk_file_chooser_select_filename_utf8 (chooser, utf8_filename);
+
+ g_free (utf8_filename);
+
+ return retval;
+}
+
+#undef gtk_file_chooser_unselect_filename
+
+void
+gtk_file_chooser_unselect_filename (GtkFileChooser *chooser,
+ const char *filename)
+{
+ gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
+
+ gtk_file_chooser_unselect_filename_utf8 (chooser, utf8_filename);
+ g_free (utf8_filename);
+}
+
+#undef gtk_file_chooser_get_filenames
+
+GSList *
+gtk_file_chooser_get_filenames (GtkFileChooser *chooser)
+{
+ GSList *list = gtk_file_chooser_get_filenames_utf8 (chooser);
+ GSList *rover = list;
+
+ while (rover)
+ {
+ gchar *tem = (gchar *) rover->data;
+ rover->data = g_locale_from_utf8 ((gchar *) rover->data, -1, NULL, NULL, NULL);
+ g_free (tem);
+ rover = rover->next;
+ }
+
+ return list;
+}
+
+#undef gtk_file_chooser_set_current_folder
+
+gboolean
+gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
+ const gchar *filename)
+{
+ gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
+ gboolean retval = gtk_file_chooser_set_current_folder_utf8 (chooser, utf8_filename);
+
+ g_free (utf8_filename);
+
+ return retval;
+}
+
+#undef gtk_file_chooser_get_current_folder
+
+gchar *
+gtk_file_chooser_get_current_folder (GtkFileChooser *chooser)
+{
+ gchar *utf8_folder = gtk_file_chooser_get_current_folder_utf8 (chooser);
+ gchar *retval = g_locale_from_utf8 (utf8_folder, -1, NULL, NULL, NULL);
+
+ g_free (utf8_folder);
+
+ return retval;
+}
+
+#undef gtk_file_chooser_get_preview_filename
+
+char *
+gtk_file_chooser_get_preview_filename (GtkFileChooser *chooser)
+{
+ char *utf8_filename = gtk_file_chooser_get_preview_filename_utf8 (chooser);
+ char *retval = g_locale_from_utf8 (utf8_filename, -1, NULL, NULL, NULL);
+
+ g_free (utf8_filename);
+
+ return retval;
+}
+
+#undef gtk_file_chooser_add_shortcut_folder
+
+gboolean
+gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser,
+ const char *folder,
+ GError **error)
+{
+ char *utf8_folder = g_locale_to_utf8 (folder, -1, NULL, NULL, NULL);
+ gboolean retval =
+ gtk_file_chooser_add_shortcut_folder_utf8 (chooser, utf8_folder, error);
+
+ g_free (utf8_folder);
+
+ return retval;
+}
+
+#undef gtk_file_chooser_remove_shortcut_folder
+
+gboolean
+gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser,
+ const char *folder,
+ GError **error)
+{
+ char *utf8_folder = g_locale_to_utf8 (folder, -1, NULL, NULL, NULL);
+ gboolean retval =
+ gtk_file_chooser_remove_shortcut_folder_utf8 (chooser, utf8_folder, error);
+
+ g_free (utf8_folder);
+
+ return retval;
+}
+
+#undef gtk_file_chooser_list_shortcut_folders
+
+GSList *
+gtk_file_chooser_list_shortcut_folders (GtkFileChooser *chooser)
+{
+ GSList *list = gtk_file_chooser_list_shortcut_folders_utf8 (chooser);
+ GSList *rover = list;
+
+ while (rover)
+ {
+ gchar *tem = (gchar *) rover->data;
+ rover->data = g_locale_from_utf8 ((gchar *) rover->data, -1, NULL, NULL, NULL);
+ g_free (tem);
+ rover = rover->next;
+ }
+
+ return list;
+}
+
+#endif
+
+#define __GTK_FILE_CHOOSER_C__
+#include "gtkaliasdef.c"
projects / ~andy / gtk / blobdiff