static void gtk_file_chooser_class_init (gpointer g_iface);
-static GFile *gtk_file_chooser_get_file (GtkFileChooser *chooser);
-
GType
gtk_file_chooser_get_type (void)
{
g_return_val_if_fail (filename != NULL, FALSE);
file = g_file_new_for_path (filename);
- result = _gtk_file_chooser_select_file (chooser, file, NULL);
+ result = gtk_file_chooser_select_file (chooser, file, NULL);
g_object_unref (file);
return result;
g_return_if_fail (filename != NULL);
file = g_file_new_for_path (filename);
- _gtk_file_chooser_unselect_file (chooser, file);
+ gtk_file_chooser_unselect_file (chooser, file);
g_object_unref (file);
}
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
- files = _gtk_file_chooser_get_files (chooser);
+ files = gtk_file_chooser_get_files (chooser);
result = files_to_strings (files, g_file_get_path);
g_slist_foreach (files, (GFunc) g_object_unref, NULL);
g_return_val_if_fail (filename != NULL, FALSE);
file = g_file_new_for_path (filename);
- result = _gtk_file_chooser_set_current_folder_file (chooser, file, NULL);
+ result = gtk_file_chooser_set_current_folder_file (chooser, file, NULL);
g_object_unref (file);
return result;
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
- file = _gtk_file_chooser_get_current_folder_file (chooser);
+ file = gtk_file_chooser_get_current_folder_file (chooser);
if (!file)
return NULL;
g_return_val_if_fail (uri != NULL, FALSE);
file = g_file_new_for_uri (uri);
- result = _gtk_file_chooser_select_file (chooser, file, NULL);
+ result = gtk_file_chooser_select_file (chooser, file, NULL);
g_object_unref (file);
return result;
g_return_if_fail (uri != NULL);
file = g_file_new_for_uri (uri);
- _gtk_file_chooser_unselect_file (chooser, file);
+ gtk_file_chooser_unselect_file (chooser, file);
g_object_unref (file);
}
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
- files = _gtk_file_chooser_get_files (chooser);
+ files = gtk_file_chooser_get_files (chooser);
result = files_to_strings (files, g_file_get_uri);
g_slist_foreach (files, (GFunc) g_object_unref, NULL);
g_return_val_if_fail (uri != NULL, FALSE);
file = g_file_new_for_uri (uri);
- result = _gtk_file_chooser_set_current_folder_file (chooser, file, NULL);
+ result = gtk_file_chooser_set_current_folder_file (chooser, file, NULL);
g_object_unref (file);
return result;
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
- file = _gtk_file_chooser_get_current_folder_file (chooser);
+ file = gtk_file_chooser_get_current_folder_file (chooser);
if (!file)
return NULL;
}
/**
- * _gtk_file_chooser_set_current_folder_file:
+ * gtk_file_chooser_set_current_folder_file:
* @chooser: a #GtkFileChooser
* @file: the #GFile for the new folder
* @error: location to store error, or %NULL.
* Return value: %TRUE if the folder could be changed successfully, %FALSE
* otherwise.
*
- * Since: 2.4
+ * Since: 2.14
**/
gboolean
-_gtk_file_chooser_set_current_folder_file (GtkFileChooser *chooser,
- GFile *file,
- GError **error)
+gtk_file_chooser_set_current_folder_file (GtkFileChooser *chooser,
+ GFile *file,
+ GError **error)
{
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
g_return_val_if_fail (G_IS_FILE (file), FALSE);
}
/**
- * _gtk_file_chooser_get_current_folder_file:
+ * gtk_file_chooser_get_current_folder_file:
* @chooser: a #GtkFileChooser
*
* Gets the current folder of @chooser as #GFile.
*
* Return value: the #GFile for the current folder.
*
- * Since: 2.4
+ * Since: 2.14
*/
GFile *
-_gtk_file_chooser_get_current_folder_file (GtkFileChooser *chooser)
+gtk_file_chooser_get_current_folder_file (GtkFileChooser *chooser)
{
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
}
/**
- * _gtk_file_chooser_select_file:
+ * gtk_file_chooser_select_file:
* @chooser: a #GtkFileChooser
* @file: the file to select
* @error: location to store error, or %NULL
*
- * Selects the file referred to by @path. An internal function. See
+ * Selects the file referred to by @file. 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
+ * Since: 2.14
**/
gboolean
-_gtk_file_chooser_select_file (GtkFileChooser *chooser,
- GFile *file,
- GError **error)
+gtk_file_chooser_select_file (GtkFileChooser *chooser,
+ GFile *file,
+ GError **error)
{
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
g_return_val_if_fail (G_IS_FILE (file), FALSE);
}
/**
- * _gtk_file_chooser_unselect_path:
+ * gtk_file_chooser_unselect_file:
* @chooser: a #GtkFileChooser
- * @path: the filename to path
+ * @file: a #GFile
*
- * Unselects the file referred to by @path. An internal
- * function. See _gtk_file_chooser_unselect_uri().
+ * 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.4
+ * Since: 2.14
**/
void
-_gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
- GFile *file)
+gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
+ GFile *file)
{
g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
g_return_if_fail (G_IS_FILE (file));
}
/**
- * _gtk_file_chooser_get_files:
+ * gtk_file_chooser_get_files:
* @chooser: a #GtkFileChooser
*
* Lists all the selected files and subfolders in the current folder of @chooser
* file and subfolder in the current folder. Free the returned list
* with g_slist_free(), and the files with g_object_unref().
*
- * Since: 2.4
+ * Since: 2.14
**/
GSList *
-_gtk_file_chooser_get_files (GtkFileChooser *chooser)
+gtk_file_chooser_get_files (GtkFileChooser *chooser)
{
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
return GTK_FILE_CHOOSER_GET_IFACE (chooser)->get_files (chooser);
}
-static GFile *
+/**
+ * gtk_file_chooser_set_file:
+ * @chooser: a #GtkFileChooser
+ * @file: the #GFile to set as current
+ * @error: location to store the error, or %NULL to ignore errors.
+ *
+ * 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 <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:
+ * |[
+ * 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);
+ * }
+ * ]|
+ *
+ * Return value: %TRUE if both the folder could be changed and the file was
+ * selected successfully, %FALSE otherwise.
+ *
+ * Since: 2.14
+ **/
+gboolean
+gtk_file_chooser_set_file (GtkFileChooser *chooser,
+ GFile *file,
+ GError **error)
+{
+ g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
+ g_return_val_if_fail (G_IS_FILE (file), FALSE);
+ g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
+
+ gtk_file_chooser_unselect_all (chooser);
+ return gtk_file_chooser_select_file (chooser, file, error);
+}
+
+/**
+ * gtk_file_chooser_get_file:
+ * @chooser: a #GtkFileChooser
+ *
+ * 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: a selected #GFile
+ **/
+GFile *
gtk_file_chooser_get_file (GtkFileChooser *chooser)
{
GSList *list;
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
- list = _gtk_file_chooser_get_files (chooser);
+ list = gtk_file_chooser_get_files (chooser);
if (list)
{
result = list->data;
* gtk_file_chooser_get_preview_file:
* @chooser: a #GtkFileChooser
*
- * Gets the filename that should be previewed in a custom preview
+ * Gets the #GFile that should be previewed in a custom preview
* Internal function, see gtk_file_chooser_get_preview_uri().
*
* Return value: the #GFile for the file to preview, or %NULL if no file
- * is selected. Free with gtk_file_path_free().
+ * is selected. Free with g_object_unref().
*
- * Since: 2.4
+ * Since: 2.14
**/
GFile *
-_gtk_file_chooser_get_preview_file (GtkFileChooser *chooser)
+gtk_file_chooser_get_preview_file (GtkFileChooser *chooser)
{
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
- file =_gtk_file_chooser_get_preview_file (chooser);
+ file = gtk_file_chooser_get_preview_file (chooser);
if (file)
{
result = g_file_get_path (file);
g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);
- file = _gtk_file_chooser_get_preview_file (chooser);
+ file = gtk_file_chooser_get_preview_file (chooser);
if (file)
{
result = g_file_get_uri (file);
data->selected =
(((data->action == GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER && is_folder) ||
(data->action == GTK_FILE_CHOOSER_ACTION_OPEN && !is_folder)) &&
- _gtk_file_chooser_select_file (GTK_FILE_CHOOSER (data->button->priv->dialog),
- data->file, NULL));
+ gtk_file_chooser_select_file (GTK_FILE_CHOOSER (data->button->priv->dialog),
+ data->file, NULL));
}
else
data->selected = FALSE;
case TEXT_PLAIN:
text = (char*) gtk_selection_data_get_text (data);
file = g_file_new_for_uri (text);
- _gtk_file_chooser_select_file (GTK_FILE_CHOOSER (priv->dialog), file,
- NULL);
+ gtk_file_chooser_select_file (GTK_FILE_CHOOSER (priv->dialog), file,
+ NULL);
g_object_unref (file);
g_free (text);
break;
gtk_tree_model_get_iter_first (priv->filter_model, &iter);
- files = _gtk_file_chooser_get_files (GTK_FILE_CHOOSER (priv->dialog));
+ files = gtk_file_chooser_get_files (GTK_FILE_CHOOSER (priv->dialog));
row_found = FALSE;
gchar *label_text;
GSList *files;
- files = _gtk_file_chooser_get_files (GTK_FILE_CHOOSER (priv->dialog));
+ files = gtk_file_chooser_get_files (GTK_FILE_CHOOSER (priv->dialog));
label_text = NULL;
pixbuf = NULL;
priv->dialog_file_activated_id);
g_signal_handler_block (priv->dialog,
priv->dialog_selection_changed_id);
- files = _gtk_file_chooser_get_files (GTK_FILE_CHOOSER (priv->dialog));
+ files = gtk_file_chooser_get_files (GTK_FILE_CHOOSER (priv->dialog));
if (files)
{
if (files->data)
case ROW_TYPE_CURRENT_FOLDER:
gtk_file_chooser_unselect_all (GTK_FILE_CHOOSER (priv->dialog));
if (data)
- _gtk_file_chooser_set_current_folder_file (GTK_FILE_CHOOSER (priv->dialog),
- data, NULL);
+ gtk_file_chooser_set_current_folder_file (GTK_FILE_CHOOSER (priv->dialog),
+ data, NULL);
break;
case ROW_TYPE_VOLUME:
{
base_file = _gtk_file_system_volume_get_root (data);
if (base_file)
{
- _gtk_file_chooser_set_current_folder_file (GTK_FILE_CHOOSER (priv->dialog),
- base_file, NULL);
+ gtk_file_chooser_set_current_folder_file (GTK_FILE_CHOOSER (priv->dialog),
+ base_file, NULL);
g_object_unref (base_file);
}
}
switch (gtk_file_chooser_get_action (GTK_FILE_CHOOSER (dialog)))
{
case GTK_FILE_CHOOSER_ACTION_OPEN:
- _gtk_file_chooser_select_file (GTK_FILE_CHOOSER (dialog), priv->old_file,
- NULL);
+ gtk_file_chooser_select_file (GTK_FILE_CHOOSER (dialog), priv->old_file,
+ NULL);
break;
case GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER:
- _gtk_file_chooser_set_current_folder_file (GTK_FILE_CHOOSER (dialog),
- priv->old_file, NULL);
+ gtk_file_chooser_set_current_folder_file (GTK_FILE_CHOOSER (dialog),
+ priv->old_file, NULL);
break;
default:
g_assert_not_reached ();