diff options
| author | Federico Mena Quintero <federico@novell.com> | 2006-06-19 17:16:14 +0000 |
|---|---|---|
| committer | Federico Mena Quintero <federico@src.gnome.org> | 2006-06-19 17:16:14 +0000 |
| commit | 05d785685bfcd4ac49558176071da9f95cfc0364 (patch) | |
| tree | a52c52f7da63735032b96840377583c18652750c /gtk/gtkfilechooser.c | |
| parent | ff865a441f072d3fdf07ef5e9bf65748eea64dbb (diff) | |
| download | gtk+-05d785685bfcd4ac49558176071da9f95cfc0364.tar.gz | |
Clarify the use of these functions, to avoid the case where a chooser is
2006-06-19 Federico Mena Quintero <federico@novell.com>
* gtk/gtkfilechooser.c (gtk_file_chooser_get_current_folder)
(gtk_file_chooser_get_current_folder_uri): Clarify the use of
these functions, to avoid the case where a chooser is in
SELECT_FOLDER mode and people mistakenly use _get_current_folder()
to get the selection: they should use _get_filename() instead.
Diffstat (limited to 'gtk/gtkfilechooser.c')
| -rw-r--r-- | gtk/gtkfilechooser.c | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c index 4ed46e9a85..a522a9df36 100644 --- a/gtk/gtkfilechooser.c +++ b/gtk/gtkfilechooser.c @@ -690,6 +690,14 @@ gtk_file_chooser_set_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 <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 @@ -1014,6 +1022,14 @@ gtk_file_chooser_set_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 <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 |