gtkfilechooser.c 84.1 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Owen Taylor's avatar
Owen Taylor committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 * gtkfilechooser.c: Abstract interface for file selector GUIs
 * Copyright (C) 2003, Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

21
#include "config.h"
Owen Taylor's avatar
Owen Taylor committed
22
#include "gtkfilechooser.h"
23
#include "gtkfilechooserprivate.h"
24
#include "gtkintl.h"
25
#include "gtktypebuiltins.h"
26
#include "gtkprivate.h"
27
#include "gtkmarshalers.h"
28
#include "gtkalias.h"
Owen Taylor's avatar
Owen Taylor committed
29

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526

/**
 * SECTION:gtkfilechooser
 * @Short_description: File chooser interface used by GtkFileChooserWidget and GtkFileChooserDialog
 * @Title: GtkFileChooser
 * @See_also: #GtkFileChooserDialog, #GtkFileChooserWidget, #GtkFileChooserButton
 *
 * #GtkFileChooser is an interface that can be implemented by file
 * selection widgets.  In GTK+, the main objects that implement this
 * interface are #GtkFileChooserWidget, #GtkFileChooserDialog, and
 * #GtkFileChooserButton.  You do not need to write an object that
 * implements the #GtkFileChooser interface unless you are trying to
 * adapt an existing file selector to expose a standard programming
 * interface.
 *
 * #GtkFileChooser 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 taht these shortcuts come from various
 * sources and in various flavours, so lets explain the terminology here:
 * <variablelist>
 *    <varlistentry>
 *       <term>Bookmarks</term>
 *       <listitem>
 *          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.
 *       </listitem>
 *    </varlistentry>
 *    <varlistentry>
 *       <term>Shortcuts</term>
 *       <listitem>
 *          can be provided by the application or by the underlying filesystem
 *          abstraction (e.g. both the gnome-vfs and the Windows filesystems
 *          provide "Desktop" shortcuts). Shortcuts cannot be modified by the
 *          user.
 *       </listitem>
 *    </varlistentry>
 *    <varlistentry>
 *       <term>Volumes</term>
 *       <listitem>
 *          are provided by the underlying filesystem abstraction. They are
 *          the "roots" of the filesystem.
 *       </listitem>
 *    </varlistentry>
 * </variablelist>
 * <refsect2 id="gtkfilechooser-encodings">
 * <title>File Names and Encodings</title>
 * When the user is finished selecting files in a
 * #GtkFileChooser, 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 <emphasis>always</emphasis> returned in
 * the character set specified by the
 * <envar>G_FILENAME_ENCODING</envar> environment variable.
 * Please see the Glib documentation for more details about this
 * variable.
 * <note>
 *    This means that while you can pass the result of
 *    gtk_file_chooser_get_filename() to
 *    <function>open(2)</function> or
 *    <function>fopen(3)</function>, you may not be able to
 *    directly set it as the text of a #GtkLabel 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.
 * </note>
 * </refsect2>
 * <refsect2 id="gtkfilechooser-preview">
 * <title>Adding a Preview Widget</title>
 * <para>
 * 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
 * #GtkFileChooser::update-preview signal to get notified when
 * you need to update the contents of the preview.
 * </para>
 * <para>
 * 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.
 * </para>
 * <example id="example-gtkfilechooser-preview">
 * <title>Sample Usage</title>
 * <programlisting>
 * {
 *   GtkImage *preview;
 *
 *   ...
 *
 *   preview = gtk_image_new (<!-- -->);
 *
 *   gtk_file_chooser_set_preview_widget (my_file_chooser, preview);
 *   g_signal_connect (my_file_chooser, "update-preview",
 * 		    G_CALLBACK (update_preview_cb), preview);
 * }
 *
 * static void
 * update_preview_cb (GtkFileChooser *file_chooser, gpointer data)
 * {
 *   GtkWidget *preview;
 *   char *filename;
 *   GdkPixbuf *pixbuf;
 *   gboolean have_preview;
 *
 *   preview = GTK_WIDGET (data);
 *   filename = gtk_file_chooser_get_preview_filename (file_chooser);
 *
 *   pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 128, 128, NULL);
 *   have_preview = (pixbuf != NULL);
 *   g_free (filename);
 *
 *   gtk_image_set_from_pixbuf (GTK_IMAGE (preview), pixbuf);
 *   if (pixbuf)
 *     g_object_unref (pixbuf);
 *
 *   gtk_file_chooser_set_preview_widget_active (file_chooser, have_preview);
 * }
 * </programlisting>
 * </example>
 * </refsect2>
 * <refsect2 id="gtkfilechooser-extra">
 * <title>Adding Extra Widgets</title>
 * <para>
 * You can add extra widgets to a file chooser to provide options
 * that are not present in the default design.  For example, you
 * can add a toggle button to give the user the option to open a
 * file in read-only mode.  You can use
 * gtk_file_chooser_set_extra_widget() to insert additional
 * widgets in a file chooser.
 * </para>
 * <example id="example-gtkfilechooser-extra">
 * <title>Sample Usage</title>
 * <programlisting>
 *
 *   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);
 * }
 * </programlisting>
 * </example>
 * <note>
 *    If you want to set more than one extra widget in the file
 *    chooser, you can a container such as a #GtkVBox or a #GtkTable
 *    and include your widgets in it.  Then, set the container as
 *    the whole extra widget.
 * </note>
 * </refsect2>
 * <refsect2 id="gtkfilechooser-key-bindings">
 * <title>Key Bindings</title>
 * <para>
 * Internally, GTK+ implements a file chooser's graphical user
 * interface with the private
 * <classname>GtkFileChooserDefaultClass</classname>.  This
 * widget has several <link linkend="gtk-Bindings">key
 * bindings</link> and their associated signals.  This section
 * describes the available key binding signals.
 * </para>
 * <example id="gtkfilechooser-key-binding-example">
 * <title>GtkFileChooser key binding example</title>
 * <para>
 * The default keys that activate the key-binding signals in
 * <classname>GtkFileChooserDefaultClass</classname> are as
 * follows:
 * </para>
 * 	<informaltable>
 * 	  <tgroup cols="2">
 * 	    <tbody>
 * 	      <row>
 * 		<entry>Signal name</entry>
 * 		<entry>Default key combinations</entry>
 * 	      </row>
 * 	      <row>
 * 		<entry>location-popup</entry>
 * 		<entry>
 * 		  <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo> (empty path);
 * 		  <keycap>/</keycap> (path of "/")
 *                <footnote>
 * 		      Both the individual <keycap>/</keycap> key and the
 * 		      numeric keypad's "divide" key are supported.
 * 		  </footnote>;
 * 		  <keycap>~</keycap> (path of "~")
 * 		</entry>
 * 	      </row>
 * 	      <row>
 * 		<entry>up-folder</entry>
 * 		<entry>
 * 		  <keycombo><keycap>Alt</keycap><keycap>Up</keycap></keycombo>
 *                <footnote>
 * 		      Both the individual Up key and the numeric
 * 		      keypad's Up key are supported.
 * 		  </footnote>
 * 		  ;
 * 		  <keycap>Backspace</keycap>
 * 		</entry>
 * 	      </row>
 * 	      <row>
 * 		<entry>down-folder</entry>
 * 		<entry><keycombo><keycap>Alt</keycap><keycap>Down</keycap></keycombo></entry>
 * 	      </row>
 * 	      <row>
 * 		<entry>home-folder</entry>
 * 		<entry><keycombo><keycap>Alt</keycap><keycap>Home</keycap></keycombo></entry>
 * 	      </row>
 * 	      <row>
 * 		<entry>desktop-folder</entry>
 * 		<entry><keycombo><keycap>Alt</keycap><keycap>D</keycap></keycombo></entry>
 * 	      </row>
 * 	      <row>
 * 		<entry>quick-bookmark</entry>
 * 		<entry><keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo> through <keycombo><keycap>Alt</keycap><keycap>0</keycap></keycombo></entry>
 * 	      </row>
 * 	    </tbody>
 * 	  </tgroup>
 * 	</informaltable>
 * <para>
 * You can change these defaults to something else.  For
 * example, to add a <keycap>Shift</keycap> modifier to a few
 * of the default bindings, you can include the following
 * fragment in your <filename>.gtkrc-2.0</filename> file:
 * </para>
 * <programlisting>
 * binding "my-own-gtkfilechooser-bindings" {
 * 	bind "&lt;Alt&gt;&lt;Shift&gt;Up" {
 * 		"up-folder" ()
 * 	}
 * 	bind "&lt;Alt&gt;&lt;Shift&gt;Down" {
 * 		"down-folder" ()
 * 	}
 * 	bind "&lt;Alt&gt;&lt;Shift&gt;Home" {
 * 		"home-folder" ()
 * 	}
 * }
 *
 * class "GtkFileChooserDefault" binding "my-own-gtkfilechooser-bindings"
 * </programlisting>
 * </example>
 * <refsect3 id="GtkFileChooserDefault-location-popup">
 * <title>The &quot;GtkFileChooserDefault::location-popup&quot; signal</title>
 * <programlisting>
 *    void user_function (GtkFileChooserDefault *chooser,
 *                        const char            *path,
 * <link linkend="gpointer">gpointer</link>      user_data);
 * </programlisting>
 * <para>
 * This is used to make the file chooser show a "Location"
 * dialog which the user can use to manually type the name of
 * the file he wishes to select.  The
 * <parameter>path</parameter> argument is a string that gets
 * put in the text entry for the file name.  By default this is bound to
 * <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
 * with a <parameter>path</parameter> string of "" (the empty
 * string).  It is also bound to <keycap>/</keycap> with a
 * <parameter>path</parameter> string of "<literal>/</literal>"
 * (a slash):  this lets you type <keycap>/</keycap> and
 * immediately type a path name.  On Unix systems, this is bound to
 * <keycap>~</keycap> (tilde) with a <parameter>path</parameter> string
 * of "~" itself for access to home directories.
 * </para>
 * 	<variablelist role="params">
 * 	  <varlistentry>
 * 	    <term><parameter>chooser</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		the object which received the signal.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	  <varlistentry>
 * 	    <term><parameter>path</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		default contents for the text entry for the file name
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	  <varlistentry>
 * 	    <term><parameter>user_data</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		user data set when the signal handler was connected.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	</variablelist>
 * <note>
 *    You can create your own bindings for the
 *    GtkFileChooserDefault::location-popup signal with custom
 *    <parameter>path</parameter> strings, and have a crude form
 *    of easily-to-type bookmarks.  For example, say you access
 *    the path <filename>/home/username/misc</filename> very
 *    frequently.  You could then create an <keycombo>
 *    <keycap>Alt</keycap> <keycap>M</keycap> </keycombo>
 *    shortcut by including the following in your
 *    <filename>.gtkrc-2.0</filename>:
 *    <programlisting>
 *    binding "misc-shortcut" {
 *       bind "&lt;Alt&gt;M" {
 *          "location-popup" ("/home/username/misc")
 * 	 }
 *    }
 *
 *    class "GtkFileChooserDefault" binding "misc-shortcut"
 *    </programlisting>
 * </note>
 * </refsect3>
 * <refsect3 id="GtkFileChooserDefault-up-folder">
 * <title>The &quot;GtkFileChooserDefault::up-folder&quot; signal</title>
 * <programlisting>
 *           void user_function (GtkFileChooserDefault *chooser,
 *                               <link linkend="gpointer">gpointer</link> user_data);
 * </programlisting>
 * <para>
 * This is used to make the file chooser go to the parent of
 * the current folder in the file hierarchy.  By default this
 * is bound to <keycap>Backspace</keycap> and
 * <keycombo><keycap>Alt</keycap><keycap>Up</keycap></keycombo>
 * (the Up key in the numeric keypad also works).
 * </para>
 * 	<variablelist role="params">
 * 	  <varlistentry>
 * 	    <term><parameter>chooser</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		the object which received the signal.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	  <varlistentry>
 * 	    <term><parameter>user_data</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		user data set when the signal handler was connected.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	</variablelist>
 * </refsect3>
 * <refsect3 id="GtkFileChooserDefault-down-folder">
 * <title>The &quot;GtkFileChooserDefault::down-folder&quot; signal</title>
 * <programlisting>
 *           void user_function (GtkFileChooserDefault *chooser,
 *                               <link linkend="gpointer">gpointer</link> user_data);
 * </programlisting>
 * <para>
 * This is used to make the file chooser go to a child of the
 * current folder in the file hierarchy.  The subfolder that
 * will be used is displayed in the path bar widget of the file
 * chooser.  For example, if the path bar is showing
 * "/foo/<emphasis>bar/</emphasis>baz", then this will cause
 * the file chooser to switch to the "baz" subfolder.  By
 * default this is bound to
 * <keycombo><keycap>Alt</keycap><keycap>Down</keycap></keycombo>
 * (the Down key in the numeric keypad also works).
 * </para>
 * 	<variablelist role="params">
 * 	  <varlistentry>
 * 	    <term><parameter>chooser</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		the object which received the signal.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	  <varlistentry>
 * 	    <term><parameter>user_data</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		user data set when the signal handler was connected.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	</variablelist>
 * </refsect3>
 * <refsect3 id="GtkFileChooserDefault-home-folder">
 * <title>The &quot;GtkFileChooserDefault::home-folder&quot; signal</title>
 * <programlisting>
 *           void user_function (GtkFileChooserDefault *chooser,
 *                               <link linkend="gpointer">gpointer</link> user_data);
 * </programlisting>
 * <para>
 * This is used to make the file chooser show the user's home
 * folder in the file list.  By default this is bound to
 * <keycombo><keycap>Alt</keycap><keycap>Home</keycap></keycombo>
 * (the Home key in the numeric keypad also works).
 * </para>
 * 	<variablelist role="params">
 * 	  <varlistentry>
 * 	    <term><parameter>chooser</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		the object which received the signal.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	  <varlistentry>
 * 	    <term><parameter>user_data</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		user data set when the signal handler was connected.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	</variablelist>
 * </refsect3>
 * <refsect3 id="GtkFileChooserDefault-desktop-folder">
 * <title>The &quot;GtkFileChooserDefault::desktop-folder&quot; signal</title>
 * <programlisting>
 *           void user_function (GtkFileChooserDefault *chooser,
 *                               <link linkend="gpointer">gpointer</link> user_data);
 * </programlisting>
 * <para>
 * This is used to make the file chooser show the user's Desktop
 * folder in the file list.  By default this is bound to
 * <keycombo><keycap>Alt</keycap><keycap>D</keycap></keycombo>.
 * </para>
 * 	<variablelist role="params">
 * 	  <varlistentry>
 * 	    <term><parameter>chooser</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		the object which received the signal.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	  <varlistentry>
 * 	    <term><parameter>user_data</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		user data set when the signal handler was connected.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	</variablelist>
 * </refsect3>
 * <refsect3 id="GtkFileChooserDefault-quick-bookmark">
 * <title>The &quot;GtkFileChooserDefault::quick-bookmark&quot; signal</title>
 * <programlisting>
 *           void user_function (GtkFileChooserDefault *chooser,
 *                               gint bookmark_index,
 *                               <link linkend="gpointer">gpointer</link> user_data);
 * </programlisting>
 * <para>
 * This is used to make the file chooser switch to the bookmark
 * specified in the <parameter>bookmark_index</parameter> parameter.
 * For example, if you have three bookmarks, you can pass 0, 1, 2 to
 * this signal to switch to each of them, respectively.  By default this is bound to
 * <keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo>,
 * <keycombo><keycap>Alt</keycap><keycap>2</keycap></keycombo>,
 * etc. until
 * <keycombo><keycap>Alt</keycap><keycap>0</keycap></keycombo>.  Note
 * that in the default binding,
 * that <keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo> is
 * actually defined to switch to the bookmark at index 0, and so on
 * successively;
 * <keycombo><keycap>Alt</keycap><keycap>0</keycap></keycombo> is
 * defined to switch to the bookmark at index 10.
 * </para>
 * 	<variablelist role="params">
 * 	  <varlistentry>
 * 	    <term><parameter>chooser</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		the object which received the signal.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	  <varlistentry>
 * 	    <term><parameter>bookmark_indes</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		index of the bookmark to switch to; the indices start at 0.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	  <varlistentry>
 * 	    <term><parameter>user_data</parameter>&nbsp;:</term>
 * 	    <listitem>
 * 	      <simpara>
 * 		user data set when the signal handler was connected.
 * 	      </simpara>
 * 	    </listitem>
 * 	  </varlistentry>
 * 	</variablelist>
 * </refsect3>
 * </refsect2>
 */


527
static void gtk_file_chooser_class_init (gpointer g_iface);
Owen Taylor's avatar
Owen Taylor committed
528 529 530 531 532 533 534 535

GType
gtk_file_chooser_get_type (void)
{
  static GType file_chooser_type = 0;

  if (!file_chooser_type)
    {
Matthias Clasen's avatar
Matthias Clasen committed
536 537 538
      file_chooser_type = g_type_register_static_simple (G_TYPE_INTERFACE,
							 I_("GtkFileChooser"),
							 sizeof (GtkFileChooserIface),
539
							 (GClassInitFunc) gtk_file_chooser_class_init,
Matthias Clasen's avatar
Matthias Clasen committed
540 541
							 0, NULL, 0);
      
542
      g_type_interface_add_prerequisite (file_chooser_type, GTK_TYPE_WIDGET);
Owen Taylor's avatar
Owen Taylor committed
543 544 545 546 547
    }

  return file_chooser_type;
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
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;
}

Owen Taylor's avatar
Owen Taylor committed
564
static void
565
gtk_file_chooser_class_init (gpointer g_iface)
Owen Taylor's avatar
Owen Taylor committed
566
{
567
  GType iface_type = G_TYPE_FROM_INTERFACE (g_iface);
Owen Taylor's avatar
Owen Taylor committed
568

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
  /**
   * 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().
   */
587
  g_signal_new (I_("current-folder-changed"),
588 589 590 591 592 593
		iface_type,
		G_SIGNAL_RUN_LAST,
		G_STRUCT_OFFSET (GtkFileChooserIface, current_folder_changed),
		NULL, NULL,
		g_cclosure_marshal_VOID__VOID,
		G_TYPE_NONE, 0);
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613

  /**
   * 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().
   */
614
  g_signal_new (I_("selection-changed"),
615 616 617 618 619 620
		iface_type,
		G_SIGNAL_RUN_LAST,
		G_STRUCT_OFFSET (GtkFileChooserIface, selection_changed),
		NULL, NULL,
		g_cclosure_marshal_VOID__VOID,
		G_TYPE_NONE, 0);
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636

  /**
   * 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
637
   * must call gtk_file_chooser_set_preview_widget_active() to inform the file
638 639 640 641 642 643 644 645 646 647
   * 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().
   */
648
  g_signal_new (I_("update-preview"),
649 650 651 652 653 654
		iface_type,
		G_SIGNAL_RUN_LAST,
		G_STRUCT_OFFSET (GtkFileChooserIface, update_preview),
		NULL, NULL,
		g_cclosure_marshal_VOID__VOID,
		G_TYPE_NONE, 0);
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671

  /**
   * 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().
   */
672
  g_signal_new (I_("file-activated"),
673 674 675 676 677 678
		iface_type,
		G_SIGNAL_RUN_LAST,
		G_STRUCT_OFFSET (GtkFileChooserIface, file_activated),
		NULL, NULL,
		g_cclosure_marshal_VOID__VOID,
		G_TYPE_NONE, 0);
679

680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
  /**
   * GtkFileChooser::confirm-overwrite:
   * @chooser: the object which received the signal.
   *
   * This signal gets emitted whenever it is appropriate to present a
   * confirmation dialog when the user has selected a file name that
   * already exists.  The signal only gets emitted when the file
   * chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode.
   *
   * Most applications just need to turn on the
   * #GtkFileChooser:do-overwrite-confirmation property (or call the
   * gtk_file_chooser_set_do_overwrite_confirmation() function), and
   * they will automatically get a stock confirmation dialog.
   * Applications which need to customize this behavior should do
   * that, and also connect to the #GtkFileChooser::confirm-overwrite
   * signal.
   *
   * A signal handler for this signal must return a
   * #GtkFileChooserConfirmation value, which indicates the action to
   * take.  If the handler determines that the user wants to select a
   * different filename, it should return
   * %GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN.  If it determines
   * that the user is satisfied with his choice of file name, it
   * should return %GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME.
   * On the other hand, if it determines that the stock confirmation
   * dialog should be used, it should return
   * %GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM. The following example
   * illustrates this.
   * <example id="gtkfilechooser-confirmation">
   * <title>Custom confirmation</title>
   * <programlisting>
   * static GtkFileChooserConfirmation
   * confirm_overwrite_callback (GtkFileChooser *chooser, gpointer data)
   * {
   *   char *uri;
   *
   *   uri = gtk_file_chooser_get_uri (chooser);
   *
   *   if (is_uri_read_only (uri))
   *     {
   *       if (user_wants_to_replace_read_only_file (uri))
   *         return GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME;
   *       else
   *         return GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN;
   *     } else
   *       return GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM; // fall back to the default dialog
   * }
   *
   * ...
   *
   * chooser = gtk_file_chooser_dialog_new (...);
   *
   * gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog), TRUE);
   * g_signal_connect (chooser, "confirm-overwrite",
   *                   G_CALLBACK (confirm_overwrite_callback), NULL);
   *
   * if (gtk_dialog_run (chooser) == GTK_RESPONSE_ACCEPT)
   *         save_to_file (gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (chooser));
   *
   * gtk_widget_destroy (chooser);
   * </programlisting>
   * </example>
   *
   * Returns: a #GtkFileChooserConfirmation value that indicates which
   *  action to take after emitting the signal.
   *
   * Since: 2.8
   */
748
  g_signal_new (I_("confirm-overwrite"),
749 750 751 752 753 754
		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);
755 756 757
  
  g_object_interface_install_property (g_iface,
				       g_param_spec_enum ("action",
758 759
							  P_("Action"),
							  P_("The type of operation that the file selector is performing"),
760 761
							  GTK_TYPE_FILE_CHOOSER_ACTION,
							  GTK_FILE_CHOOSER_ACTION_OPEN,
762
							  GTK_PARAM_READWRITE));
763
  g_object_interface_install_property (g_iface,
764 765 766 767
				       g_param_spec_string ("file-system-backend",
							    P_("File System Backend"),
							    P_("Name of file system backend to use"),
							    NULL, 
768
							    GTK_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
769 770
  g_object_interface_install_property (g_iface,
				       g_param_spec_object ("filter",
771 772
							    P_("Filter"),
							    P_("The current filter for selecting which files are displayed"),
773
							    GTK_TYPE_FILE_FILTER,
774
							    GTK_PARAM_READWRITE));
775 776
  g_object_interface_install_property (g_iface,
				       g_param_spec_boolean ("local-only",
777 778
							     P_("Local Only"),
							     P_("Whether the selected file(s) should be limited to local file: URLs"),
779
							     TRUE,
780
							     GTK_PARAM_READWRITE));
781 782
  g_object_interface_install_property (g_iface,
				       g_param_spec_object ("preview-widget",
783 784
							    P_("Preview widget"),
							    P_("Application supplied widget for custom previews."),
785
							    GTK_TYPE_WIDGET,
786
							    GTK_PARAM_READWRITE));
787 788
  g_object_interface_install_property (g_iface,
				       g_param_spec_boolean ("preview-widget-active",
789 790
							     P_("Preview Widget Active"),
							     P_("Whether the application supplied widget for custom previews should be shown."),
791
							     TRUE,
792
							     GTK_PARAM_READWRITE));
793 794 795 796 797
  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,
798
							     GTK_PARAM_READWRITE));
799 800
  g_object_interface_install_property (g_iface,
				       g_param_spec_object ("extra-widget",
801 802
							    P_("Extra widget"),
							    P_("Application supplied widget for extra options."),
803
							    GTK_TYPE_WIDGET,
804
							    GTK_PARAM_READWRITE));
805 806
  g_object_interface_install_property (g_iface,
				       g_param_spec_boolean ("select-multiple",
807 808
							     P_("Select Multiple"),
							     P_("Whether to allow multiple files to be selected"),
809
							     FALSE,
810
							     GTK_PARAM_READWRITE));
811 812 813
  
  g_object_interface_install_property (g_iface,
				       g_param_spec_boolean ("show-hidden",
814 815
							     P_("Show Hidden"),
							     P_("Whether the hidden files and folders should be displayed"),
816
							     FALSE,
817
							     GTK_PARAM_READWRITE));
818

819 820 821 822 823 824 825 826 827
  /**
   * 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
   */
828 829 830
  g_object_interface_install_property (g_iface,
				       g_param_spec_boolean ("do-overwrite-confirmation",
							     P_("Do overwrite confirmation"),
831
							     P_("Whether a file chooser in save mode "
832
								"will present an overwrite confirmation dialog "
833
								"if necessary."),
834 835
							     FALSE,
							     GTK_PARAM_READWRITE));
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851

  /**
   * GtkFileChooser:create-folders:
   * 
   * Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode
   * will offer the user to create new folders.
   *
   * Since: 2.18
   */
  g_object_interface_install_property (g_iface,
				       g_param_spec_boolean ("create-folders",
							     P_("Allow folders creation"),
							     P_("Whether a file chooser not in open mode "
								"will offer the user to create new folders."),
							     TRUE,
							     GTK_PARAM_READWRITE));
Owen Taylor's avatar
Owen Taylor committed
852 853
}

854 855 856 857 858 859
/**
 * gtk_file_chooser_error_quark:
 *
 * Registers an error quark for #GtkFileChooser if necessary.
 * 
 * Return value: The error quark used for #GtkFileChooser errors.
860 861
 *
 * Since: 2.4
862 863 864 865
 **/
GQuark
gtk_file_chooser_error_quark (void)
{
866
  return g_quark_from_static_string ("gtk-file-chooser-error-quark");
867 868
}

869 870 871 872 873
/**
 * gtk_file_chooser_set_action:
 * @chooser: a #GtkFileChooser
 * @action: the action that the file selector is performing
 * 
874
 * Sets the type of operation that the chooser is performing; the
875 876 877 878
 * 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.
879 880
 *
 * Since: 2.4
881
 **/
Owen Taylor's avatar
Owen Taylor committed
882 883 884 885 886 887 888 889 890
void
gtk_file_chooser_set_action (GtkFileChooser       *chooser,
			     GtkFileChooserAction  action)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));

  g_object_set (chooser, "action", action, NULL);
}

891 892 893 894 895 896 897 898
/**
 * gtk_file_chooser_get_action:
 * @chooser: a #GtkFileChooser
 * 
 * Gets the type of operation that the file chooser is performing; see
 * gtk_file_chooser_set_action().
 * 
 * Return value: the action that the file selector is performing
899 900
 *
 * Since: 2.4
901
 **/
Owen Taylor's avatar
Owen Taylor committed
902 903 904 905 906 907 908 909 910 911 912 913
GtkFileChooserAction
gtk_file_chooser_get_action (GtkFileChooser *chooser)
{
  GtkFileChooserAction action;
  
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);

  g_object_get (chooser, "action", &action, NULL);

  return action;
}

914 915 916 917 918 919 920 921 922 923 924 925 926 927
/**
 * gtk_file_chooser_set_local_only:
 * @chooser: a #GtkFileChooser
 * @local_only: %TRUE if only local files can be selected
 * 
 * Sets whether only local files can be selected in the
 * file selector. If @local_only is %TRUE (the default),
 * then the selected file are files are guaranteed to be
 * accessible through the operating systems native file
 * 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(),
928 929
 *
 * Since: 2.4
930
 **/
Owen Taylor's avatar
Owen Taylor committed
931 932 933 934 935 936
void
gtk_file_chooser_set_local_only (GtkFileChooser *chooser,
				 gboolean        local_only)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));

937
  g_object_set (chooser, "local-only", local_only, NULL);
Owen Taylor's avatar
Owen Taylor committed
938 939
}

940 941 942 943 944 945 946 947
/**
 * gtk_file_chooser_get_local_only:
 * @chooser: a #GtkFileChoosre
 * 
 * Gets whether only local files can be selected in the
 * file selector. See gtk_file_chooser_set_local_only()
 * 
 * Return value: %TRUE if only local files can be selected.
948 949
 *
 * Since: 2.4
950
 **/
Owen Taylor's avatar
Owen Taylor committed
951 952 953 954 955 956 957
gboolean
gtk_file_chooser_get_local_only (GtkFileChooser *chooser)
{
  gboolean local_only;
  
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);

958
  g_object_get (chooser, "local-only", &local_only, NULL);
Owen Taylor's avatar
Owen Taylor committed
959 960 961 962

  return local_only;
}

963 964 965 966 967
/**
 * gtk_file_chooser_set_select_multiple:
 * @chooser: a #GtkFileChooser
 * @select_multiple: %TRUE if multiple files can be selected.
 * 
968
 * Sets whether multiple files can be selected in the file selector.  This is
969 970
 * only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or
 * %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
971 972
 *
 * Since: 2.4
973
 **/
Owen Taylor's avatar
Owen Taylor committed
974 975 976 977 978 979
void
gtk_file_chooser_set_select_multiple (GtkFileChooser *chooser,
				      gboolean        select_multiple)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));

980
  g_object_set (chooser, "select-multiple", select_multiple, NULL);
Owen Taylor's avatar
Owen Taylor committed
981 982
}

983 984 985 986 987 988 989 990
/**
 * gtk_file_chooser_get_select_multiple:
 * @chooser: a #GtkFileChooser
 * 
 * Gets whether multiple files can be selected in the file
 * selector. See gtk_file_chooser_set_select_multiple().
 * 
 * Return value: %TRUE if multiple files can be selected.
991 992
 *
 * Since: 2.4
993
 **/
Owen Taylor's avatar
Owen Taylor committed
994 995 996 997 998 999 1000
gboolean
gtk_file_chooser_get_select_multiple (GtkFileChooser *chooser)
{
  gboolean select_multiple;
  
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);

1001
  g_object_get (chooser, "select-multiple", &select_multiple, NULL);
Owen Taylor's avatar
Owen Taylor committed
1002 1003 1004 1005

  return select_multiple;
}

1006 1007 1008 1009 1010 1011 1012
/**
 * gtk_file_chooser_set_create_folders:
 * @chooser: a #GtkFileChooser
 * @create_folders: %TRUE if the New Folder button should be displayed
 * 
 * Sets whether file choser will offer to create new folders.
 * This is only relevant if the action is not set to be 
1013
 * %GTK_FILE_CHOOSER_ACTION_OPEN.
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
 *
 * Since: 2.18
 **/
void
gtk_file_chooser_set_create_folders (GtkFileChooser *chooser,
				     gboolean        create_folders)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));

  g_object_set (chooser, "create-folders", create_folders, NULL);
}

/**
 * gtk_file_chooser_get_create_folders:
 * @chooser: a #GtkFileChooser
 * 
 * Gets whether file choser will offer to create new folders.
 * See gtk_file_chooser_set_create_folders().
 * 
 * Return value: %TRUE if the New Folder button should be displayed.
 *
 * Since: 2.18
 **/
gboolean
gtk_file_chooser_get_create_folders (GtkFileChooser *chooser)
{
  gboolean create_folders;
  
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);

  g_object_get (chooser, "create-folders", &create_folders, NULL);

  return create_folders;
}

1049 1050 1051 1052 1053 1054 1055
/**
 * gtk_file_chooser_get_filename:
 * @chooser: a #GtkFileChooser
 * 
 * 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.
1056 1057 1058
 *
 * If the file chooser is in folder mode, this function returns the selected
 * folder.
1059 1060 1061
 * 
 * Return value: The currently selected filename, or %NULL
 *  if no file is selected, or the selected file can't
1062
 *  be represented with a local filename. Free with g_free().
1063 1064
 *
 * Since: 2.4
1065
 **/
1066
gchar *
Owen Taylor's avatar
Owen Taylor committed
1067 1068
gtk_file_chooser_get_filename (GtkFileChooser *chooser)
{
1069
  GFile *file;
Owen Taylor's avatar
Owen Taylor committed
1070
  gchar *result = NULL;
1071

Owen Taylor's avatar
Owen Taylor committed
1072 1073
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);

1074 1075 1076
  file = gtk_file_chooser_get_file (chooser);

  if (file)
Owen Taylor's avatar
Owen Taylor committed
1077
    {
1078
      result = g_file_get_path (file);
1079
      g_object_unref (file);
Owen Taylor's avatar
Owen Taylor committed
1080 1081 1082 1083 1084
    }

  return result;
}

1085 1086 1087 1088 1089
/**
 * gtk_file_chooser_set_filename:
 * @chooser: a #GtkFileChooser
 * @filename: the filename to set as current
 * 
1090 1091
 * 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
1092
 * the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file's base name
1093 1094 1095 1096 1097 1098
 * 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().
1099 1100
 *
 * Note that the file must exist, or nothing will be done except
1101 1102
 * for the directory change.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1103 1104 1105 1106 1107 1108 1109 1110
 * 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 &mdash; 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:
 * |[
1111 1112
 * if (document_is_new)
 *   {
Matthias Clasen's avatar
Matthias Clasen committed
1113
 *     /&ast; the user just created a new document &ast;/
1114 1115 1116 1117 1118
 *     gtk_file_chooser_set_current_folder (chooser, default_folder_for_saving);
 *     gtk_file_chooser_set_current_name (chooser, "Untitled document");
 *   }
 * else
 *   {
Matthias Clasen's avatar
Matthias Clasen committed
1119
 *     /&ast; the user edited an existing document &ast;/ 
1120 1121
 *     gtk_file_chooser_set_filename (chooser, existing_filename);
 *   }
Matthias Clasen's avatar
Matthias Clasen committed
1122
 * ]|
1123
 * 
1124 1125 1126
 * Return value: %TRUE if both the folder could be changed and the file was
 * selected successfully, %FALSE otherwise.
 *
1127
 * Since: 2.4
1128
 **/
1129
gboolean
Owen Taylor's avatar
Owen Taylor committed
1130
gtk_file_chooser_set_filename (GtkFileChooser *chooser,
1131
			       const gchar    *filename)
Owen Taylor's avatar
Owen Taylor committed
1132
{
1133
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
1134 1135

  gtk_file_chooser_unselect_all (chooser);
1136
  return gtk_file_chooser_select_filename (chooser, filename);
Owen Taylor's avatar
Owen Taylor committed
1137 1138
}

1139 1140 1141 1142 1143 1144 1145 1146
/**
 * gtk_file_chooser_select_filename:
 * @chooser: a #GtkFileChooser
 * @filename: the filename to select
 * 
 * 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.
1147
 *
1148 1149 1150
 * Return value: %TRUE if both the folder could be changed and the file was
 * selected successfully, %FALSE otherwise.
 *
1151
 * Since: 2.4
1152
 **/
1153
gboolean
Owen Taylor's avatar
Owen Taylor committed
1154
gtk_file_chooser_select_filename (GtkFileChooser *chooser,
1155
				  const gchar    *filename)
Owen Taylor's avatar
Owen Taylor committed
1156
{
1157
  GFile *file;
1158
  gboolean result;
1159
  
1160 1161
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
  g_return_val_if_fail (filename != NULL, FALSE);
1162

1163
  file = g_file_new_for_path (filename);
1164
  result = gtk_file_chooser_select_file (chooser, file, NULL);
1165
  g_object_unref (file);
1166 1167

  return result;
Owen Taylor's avatar
Owen Taylor committed
1168 1169
}

1170 1171 1172 1173 1174 1175 1176 1177
/**
 * gtk_file_chooser_unselect_filename:
 * @chooser: a #GtkFileChooser
 * @filename: the filename to unselect
 * 
 * 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.
1178 1179
 *
 * Since: 2.4
1180
 **/
Owen Taylor's avatar
Owen Taylor committed
1181 1182 1183 1184
void
gtk_file_chooser_unselect_filename (GtkFileChooser *chooser,
				    const char     *filename)
{
1185 1186
  GFile *file;

Owen Taylor's avatar
Owen Taylor committed
1187 1188
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
  g_return_if_fail (filename != NULL);
1189

1190
  file = g_file_new_for_path (filename);
1191
  gtk_file_chooser_unselect_file (chooser, file);
1192
  g_object_unref (file);
Owen Taylor's avatar
Owen Taylor committed
1193 1194
}

1195
/* Converts a list of GFile* to a list of strings using the specified function */
1196
static GSList *
1197 1198
files_to_strings (GSList  *files,
		  gchar * (*convert_func) (GFile *file))
1199 1200 1201 1202 1203
{
  GSList *strings;

  strings = NULL;

1204
  for (; files; files = files->next)
1205
    {
1206
      GFile *file;
1207 1208
      gchar *string;

1209 1210
      file = files->data;
      string = (* convert_func) (file);
1211 1212 1213 1214 1215 1216 1217 1218

      if (string)
	strings = g_slist_prepend (strings, string);
    }

  return g_slist_reverse (strings);
}

1219 1220 1221 1222
/**
 * gtk_file_chooser_get_filenames:
 * @chooser: a #GtkFileChooser
 * 
1223 1224 1225 1226
 * 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())
1227 1228
 *
 * Return value: (element-type utf8) (transfer full): a #GSList containing the filenames of all selected
1229
 *   files and subfolders in the current folder. Free the returned list
1230
 *   with g_slist_free(), and the filenames with g_free().
1231 1232
 *
 * Since: 2.4
1233
 **/
Owen Taylor's avatar
Owen Taylor committed
1234 1235 1236
GSList *
gtk_file_chooser_get_filenames (GtkFileChooser *chooser)
{
1237
  GSList *files, *result;
1238
  
Owen Taylor's avatar
Owen Taylor committed
1239 1240
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);

1241
  files = gtk_file_chooser_get_files (chooser);
1242 1243 1244 1245

  result = files_to_strings (files, g_file_get_path);
  g_slist_foreach (files, (GFunc) g_object_unref, NULL);
  g_slist_free (files);
1246

1247
  return result;
Owen Taylor's avatar
Owen Taylor committed
1248 1249
}

1250 1251 1252 1253 1254 1255 1256 1257
/**
 * gtk_file_chooser_set_current_folder:
 * @chooser: a #GtkFileChooser
 * @filename: the full path of the new current folder
 * 
 * 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.
1258
 *
1259 1260 1261
 * Return value: %TRUE if the folder could be changed successfully, %FALSE
 * otherwise.
 *
1262
 * Since: 2.4
1263
 **/
1264
gboolean
Owen Taylor's avatar
Owen Taylor committed
1265 1266 1267
gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
				     const gchar    *filename)
{
1268
  GFile *file;
1269
  gboolean result;
1270
  
1271 1272
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
  g_return_val_if_fail (filename != NULL, FALSE);
1273

1274
  file = g_file_new_for_path (filename);
1275
  result = gtk_file_chooser_set_current_folder_file (chooser, file, NULL);
1276
  g_object_unref (file);
1277 1278

  return result;
Owen Taylor's avatar
Owen Taylor committed
1279 1280
}

1281 1282 1283 1284 1285 1286
/**
 * gtk_file_chooser_get_current_folder:
 * @chooser: a #GtkFileChooser
 * 
 * Gets the current folder of @chooser as a local filename.
 * See gtk_file_chooser_set_current_folder().
1287 1288 1289 1290
 *
 * 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
1291
 * %GTK_FILE_CHOOSER_SELECT_FOLDER mode
1292 1293 1294
 * (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.
1295
 * 
1296 1297 1298 1299 1300
 * 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.
1301 1302
 *
 * Since: 2.4
1303
 **/
Owen Taylor's avatar
Owen Taylor committed
1304 1305 1306
gchar *
gtk_file_chooser_get_current_folder (GtkFileChooser *chooser)
{
1307
  GFile *file;
1308 1309
  gchar *filename;
  
Owen Taylor's avatar
Owen Taylor committed
1310 1311
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);

1312
  file = gtk_file_chooser_get_current_folder_file (chooser);
1313
  if (!file)
1314 1315
    return NULL;

1316 1317
  filename = g_file_get_path (file);
  g_object_unref (file);
1318 1319

  return filename;
Owen Taylor's avatar
Owen Taylor committed
1320 1321
}

1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
/**
 * gtk_file_chooser_set_current_name:
 * @chooser: a #GtkFileChooser
 * @name: the filename to use, as a UTF-8 string
 * 
 * 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.
 *
1332 1333 1334 1335
 * 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.
1336 1337
 *
 * Since: 2.4
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
 **/
void
gtk_file_chooser_set_current_name  (GtkFileChooser *chooser,
				    const gchar    *name)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
  g_return_if_fail (name != NULL);
  
  GTK_FILE_CHOOSER_GET_IFACE (chooser)->set_current_name (chooser, name);
}

/**
 * gtk_file_chooser_get_uri:
 * @chooser: a #GtkFileChooser
 * 
 * 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.
 * 
1357 1358 1359
 * If the file chooser is in folder mode, this function returns the selected
 * folder.
 * 
1360 1361
 * Return value: The currently selected URI, or %NULL
 *  if no file is selected. Free with g_free()
1362 1363
 *
 * Since: 2.4
1364
 **/
Owen Taylor's avatar
Owen Taylor committed
1365 1366 1367
gchar *
gtk_file_chooser_get_uri (GtkFileChooser *chooser)
{
1368
  GFile *file;
Owen Taylor's avatar
Owen Taylor committed
1369 1370 1371 1372
  gchar *result = NULL;
  
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);

1373 1374
  file = gtk_file_chooser_get_file (chooser);
  if (file)
Owen Taylor's avatar
Owen Taylor committed
1375
    {
1376 1377
      result = g_file_get_uri (file);
      g_object_unref (file);
Owen Taylor's avatar
Owen Taylor committed
1378 1379 1380 1381 1382
    }

  return result;
}

1383 1384 1385 1386 1387
/**
 * gtk_file_chooser_set_uri:
 * @chooser: a #GtkFileChooser
 * @uri: the URI to set as current
 * 
1388 1389
 * 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
1390
 * list.  If the @chooser is %GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI's base
1391
 * name will also appear in the dialog's file name entry.
1392
 *
1393 1394 1395 1396 1397
 * 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().
 *
Matthias Clasen's avatar
Matthias Clasen committed
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
 * 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 &mdash; 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:
 * |[
1408 1409
 * if (document_is_new)
 *   {
Matthias Clasen's avatar
Matthias Clasen committed
1410
 *     /&ast; the user just created a new document &ast;/
1411 1412 1413 1414 1415
 *     gtk_file_chooser_set_current_folder_uri (chooser, default_folder_for_saving);
 *     gtk_file_chooser_set_current_name (chooser, "Untitled document");
 *   }
 * else
 *   {
Matthias Clasen's avatar
Matthias Clasen committed
1416
 *     /&ast; the user edited an existing document &ast;/ 
1417 1418
 *     gtk_file_chooser_set_uri (chooser, existing_uri);
 *   }
Matthias Clasen's avatar
Matthias Clasen committed
1419
 * ]|
1420
 *
1421 1422 1423
 * Return value: %TRUE if both the folder could be changed and the URI was
 * selected successfully, %FALSE otherwise.
 *
1424
 * Since: 2.4
1425
 **/
1426
gboolean
Owen Taylor's avatar
Owen Taylor committed
1427 1428 1429
gtk_file_chooser_set_uri (GtkFileChooser *chooser,
			  const char     *uri)
{
1430
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
1431 1432

  gtk_file_chooser_unselect_all (chooser);
1433
  return gtk_file_chooser_select_uri (chooser, uri);
Owen Taylor's avatar
Owen Taylor committed
1434 1435
}

1436 1437 1438 1439 1440 1441 1442 1443
/**
 * gtk_file_chooser_select_uri:
 * @chooser: a #GtkFileChooser
 * @uri: the URI to select
 * 
 * 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.
1444
 *
1445 1446 1447
 * Return value: %TRUE if both the folder could be changed and the URI was
 * selected successfully, %FALSE otherwise.
 *
1448
 * Since: 2.4
1449
 **/
1450
gboolean
Owen Taylor's avatar
Owen Taylor committed
1451 1452 1453
gtk_file_chooser_select_uri (GtkFileChooser *chooser,
			     const char     *uri)
{
1454
  GFile *file;
1455
  gboolean result;
Owen Taylor's avatar
Owen Taylor committed
1456
  
1457 1458
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
  g_return_val_if_fail (uri != NULL, FALSE);
1459

1460
  file = g_file_new_for_uri (uri);
1461
  result = gtk_file_chooser_select_file (chooser, file, NULL);
1462
  g_object_unref (file);
1463 1464

  return result;
Owen Taylor's avatar
Owen Taylor committed
1465 1466
}

1467 1468 1469 1470 1471 1472 1473 1474
/**
 * gtk_file_chooser_unselect_uri:
 * @chooser: a #GtkFileChooser
 * @uri: the URI to unselect
 * 
 * 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.
1475 1476
 *
 * Since: 2.4
1477
 **/
Owen Taylor's avatar
Owen Taylor committed
1478 1479 1480 1481
void
gtk_file_chooser_unselect_uri (GtkFileChooser *chooser,
			       const char     *uri)
{
1482 1483
  GFile *file;

1484 1485 1486
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
  g_return_if_fail (uri != NULL);

1487
  file = g_file_new_for_uri (uri);
1488
  gtk_file_chooser_unselect_file (chooser, file);
1489
  g_object_unref (file);
Owen Taylor's avatar
Owen Taylor committed
1490 1491
}

1492 1493 1494 1495 1496
/**
 * gtk_file_chooser_select_all:
 * @chooser: a #GtkFileChooser
 * 
 * Selects all the files in the current folder of a file chooser.
Matthias Clasen's avatar
Matthias Clasen committed
1497 1498
 *
 * Since: 2.4
1499
 **/
Owen Taylor's avatar
Owen Taylor committed
1500 1501 1502 1503 1504 1505 1506 1507
void
gtk_file_chooser_select_all (GtkFileChooser *chooser)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
  
  GTK_FILE_CHOOSER_GET_IFACE (chooser)->select_all (chooser);
}

1508 1509 1510 1511 1512
/**
 * gtk_file_chooser_unselect_all:
 * @chooser: a #GtkFileChooser
 * 
 * Unselects all the files in the current folder of a file chooser.
Matthias Clasen's avatar
Matthias Clasen committed
1513 1514
 *
 * Since: 2.4
1515
 **/
Owen Taylor's avatar
Owen Taylor committed
1516 1517 1518 1519 1520 1521 1522 1523 1524
void
gtk_file_chooser_unselect_all (GtkFileChooser *chooser)
{

  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
  
  GTK_FILE_CHOOSER_GET_IFACE (chooser)->unselect_all (chooser);
}

1525
/**
1526
 * gtk_file_chooser_get_uris:
1527 1528
 * @chooser: a #GtkFileChooser
 * 
1529
 * Lists all the selected files and subfolders in the current folder of
1530
 * @chooser. The returned names are full absolute URIs.
1531 1532
 *
 * Return value: (element-type utf8) (transfer full): a #GSList containing the URIs of all selected
1533
 *   files and subfolders in the current folder. Free the returned list
1534
 *   with g_slist_free(), and the filenames with g_free().
1535 1536
 *
 * Since: 2.4
1537
 **/
Owen Taylor's avatar
Owen Taylor committed
1538 1539 1540
GSList *
gtk_file_chooser_get_uris (GtkFileChooser *chooser)
{
1541
  GSList *files, *result;
Owen Taylor's avatar
Owen Taylor committed
1542
  
1543 1544
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);

1545
  files = gtk_file_chooser_get_files (chooser);
1546 1547 1548 1549

  result = files_to_strings (files, g_file_get_uri);
  g_slist_foreach (files, (GFunc) g_object_unref, NULL);
  g_slist_free (files);
1550

1551
  return result;
Owen Taylor's avatar
Owen Taylor committed
1552 1553
}

1554 1555 1556 1557 1558 1559 1560 1561
/**
 * gtk_file_chooser_set_current_folder_uri:
 * @chooser: a #GtkFileChooser
 * @uri: the URI for the new current folder
 * 
 * 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.
1562
 *
1563 1564 1565
 * Return value: %TRUE if the folder could be changed successfully, %FALSE
 * otherwise.
 *
1566
 * Since: 2.4
1567
 **/
1568
gboolean
Owen Taylor's avatar
Owen Taylor committed
1569 1570 1571
gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser,
					 const gchar    *uri)
{
1572
  GFile *file;
1573
  gboolean result;
1574
  
1575 1576
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
  g_return_val_if_fail (uri != NULL, FALSE);
Owen Taylor's avatar
Owen Taylor committed
1577

1578
  file = g_file_new_for_uri (uri);
1579
  result = gtk_file_chooser_set_current_folder_file (chooser, file, NULL);
1580
  g_object_unref (file);
1581 1582

  return result;
1583
}
Owen Taylor's avatar
Owen Taylor committed
1584

1585 1586 1587 1588 1589 1590
/**
 * gtk_file_chooser_get_current_folder_uri:
 * @chooser: a #GtkFileChooser
 * 
 * Gets the current folder of @chooser as an URI.
 * See gtk_file_chooser_set_current_folder_uri().
1591 1592 1593 1594
 *
 * 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
1595
 * %GTK_FILE_CHOOSER_SELECT_FOLDER mode
1596 1597 1598
 * (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.
1599
 * 
1600 1601 1602 1603
 * 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.
1604 1605
 *
 * Since: 2.4
1606
 */
Owen Taylor's avatar
Owen Taylor committed
1607 1608
gchar *
gtk_file_chooser_get_current_folder_uri (GtkFileChooser *chooser)
1609
{
1610
  GFile *file;
1611 1612 1613 1614
  gchar *uri;
  
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);

1615
  file = gtk_file_chooser_get_current_folder_file (chooser);
1616
  if (!file)
1617 1618
    return NULL;

1619 1620
  uri = g_file_get_uri (file);
  g_object_unref (file);
1621 1622 1623 1624

  return uri;
}

1625
/**
1626
 * gtk_file_chooser_set_current_folder_file:
1627
 * @chooser: a #GtkFileChooser
1628
 * @file: the #GFile for the new folder
1629
 * @error: (allow-none): location to store error, or %NULL.
1630
 * 
1631
 * Sets the current folder for @chooser from a #GFile.
1632
 * Internal function, see gtk_file_chooser_set_current_folder_uri().
1633
 *
1634 1635 1636
 * Return value: %TRUE if the folder could be changed successfully, %FALSE
 * otherwise.
 *
1637
 * Since: 2.14
1638
 **/
1639
gboolean
1640 1641 1642
gtk_file_chooser_set_current_folder_file (GtkFileChooser  *chooser,
                                          GFile           *file,
                                          GError         **error)
1643
{
1644
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
1645
  g_return_val_if_fail (G_IS_FILE (file), FALSE);
1646
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1647

1648
  return GTK_FILE_CHOOSER_GET_IFACE (chooser)->set_current_folder (chooser, file, error);
1649 1650
}

1651
/**
1652
 * gtk_file_chooser_get_current_folder_file:
1653 1654
 * @chooser: a #GtkFileChooser
 * 
1655
 * Gets the current folder of @chooser as #GFile.
1656 1657
 * See gtk_file_chooser_get_current_folder_uri().
 * 
1658
 * Return value: the #GFile for the current folder.
1659
 *
1660
 * Since: 2.14
1661
 */
1662
GFile *
1663
gtk_file_chooser_get_current_folder_file (GtkFileChooser *chooser)
Owen Taylor's avatar
Owen Taylor committed
1664 1665 1666 1667 1668 1669
{
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), NULL);

  return GTK_FILE_CHOOSER_GET_IFACE (chooser)->get_current_folder (chooser);  
}

1670
/**
1671
 * gtk_file_chooser_select_file:
1672
 * @chooser: a #GtkFileChooser
1673
 * @file: the file to select
1674
 * @error: (allow-none): location to store error, or %NULL
1675
 * 
1676
 * Selects the file referred to by @file. An internal function. See
1677
 * _gtk_file_chooser_select_uri().
1678
 *
1679 1680 1681
 * Return value: %TRUE if both the folder could be changed and the path was
 * selected successfully, %FALSE otherwise.
 *
1682
 * Since: 2.14
1683
 **/
1684
gboolean
1685 1686 1687
gtk_file_chooser_select_file (GtkFileChooser  *chooser,
                              GFile           *file,
                              GError         **error)
1688
{
1689
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER (chooser), FALSE);
1690
  g_return_val_if_fail (G_IS_FILE (file), FALSE);
1691
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1692

1693
  return GTK_FILE_CHOOSER_GET_IFACE (chooser)->select_file (chooser, file, error);
1694 1695
}

1696
/**
1697
 * gtk_file_chooser_unselect_file:
1698
 * @chooser: a #GtkFileChooser
1699
 * @file: a #GFile
1700
 * 
1701 1702
 * 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.
1703
 *
1704
 * Since: 2.14
1705
 **/
1706
void
1707 1708
gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
                                GFile          *file)
1709 1710
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
1711
  g_return_if_fail (G_IS_FILE (file));
1712

1713
  GTK_FILE_CHOOSER_GET_IFACE (chooser)->unselect_file (chooser, file);
1714 1715
}

1716
/**
1717
 * gtk_file_chooser_get_files:
1718 1719
 * @chooser: a #GtkFileChooser
 * 
1720
 * Lists all the selected files and subfolders in the current folder of @chooser
1721
 * as #GFile. An internal function, see gtk_file_chooser_get_uris().
1722 1723
 *
 * Return value: (element-type utf8) (transfer full): a #GSList containing a #GFile for each selected
1724
 *   file and subfolder in the current folder.  Free the returned list
1725
 *   with g_slist_free(), and the files with g_object_unref().
1726
 *
1727
 * Since: 2.14
1728
 **/
1729
GSList *
1730
gtk_file_chooser_get_files (GtkFileChooser *