Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkfilechooser.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkFileChooser
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 File chooser interface used by GtkFileChooserWidget and GtkFileChooserDialog
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8     <para>
   9       #GtkFileChooser is an interface that can be implemented by file
  10       selection widgets.  In GTK+, the main objects that implement this
  11       interface are #GtkFileChooserWidget, #GtkFileChooserDialog, and
  12       #GtkFileChooserButton.  You do not need to write an object that
  13       implements the #GtkFileChooser interface unless you are trying to
  14       adapt an existing file selector to expose a standard programming
  15       interface.
  16     </para>
  17
  18     <para>
  19       #GtkFileChooser allows for shortcuts to various places in the filesystem.
  20       In the default implementation these are displayed in the left pane. It
  21       may be a bit confusing at first taht these shortcuts come from various
  22       sources and in various flavours, so lets explain the terminology here:
  23     </para>
  24       <variablelist>
  25          <varlistentry>
  26            <term>Bookmarks</term>
  27            <listitem><para>
  28              are created by the user, by dragging folders from the
  29              right pane to the left pane, or by using the "Add". Bookmarks
  30              can be renamed and deleted by the user.
  31            </para></listitem>
  32          </varlistentry>
  33          <varlistentry>
  34            <term>Shortcuts</term>
  35            <listitem><para>
  36              can be provided by the application or by the underlying filesystem
  37              abstraction (e.g. both the gnome-vfs and the Windows filesystems
  38              provide "Desktop" shortcuts). Shortcuts cannot be modified by the
  39              user.
  40            </para></listitem>
  41          </varlistentry>
  42          <varlistentry>
  43            <term>Volumes</term>
  44            <listitem><para>
  45              are provided by the underlying filesystem abstraction. They are
  46              the "roots" of the filesystem.
  47            </para></listitem>
  48          </varlistentry>
  49       </variablelist>
  50
  51     <refsect2 id="gtkfilechooser-encodings">
  52       <title>File Names and Encodings</title>
  53
  54       <para>
  55         When the user is finished selecting files in a
  56         #GtkFileChooser, your program can get the selected names
  57         either as filenames or as URIs.  For URIs, the normal escaping
  58         rules are applied if the URI contains non-ASCII characters.
  59         However, filenames are <emphasis>always</emphasis> returned in
  60         the character set specified by the
  61         <envar>G_FILENAME_ENCODING</envar> environment variable.
  62         Please see the Glib documentation for more details about this
  63         variable.
  64       </para>
  65
  66       <important>
  67         <para>
  68           This means that while you can pass the result of
  69           gtk_file_chooser_get_filename() to
  70           <function>open(2)</function> or
  71           <function>fopen(3)</function>, you may not be able to
  72           directly set it as the text of a #GtkLabel widget unless you
  73           convert it first to UTF-8, which all GTK+ widgets expect.
  74           You should use g_filename_to_utf8() to convert filenames
  75           into strings that can be passed to GTK+ widgets.
  76         </para>
  77       </important>
  78     </refsect2>
  79
  80     <refsect2 id="gtkfilechooser-preview">
  81       <title>Adding a Preview Widget</title>
  82
  83       <para>
  84         You can add a custom preview widget to a file chooser and then
  85         get notification about when the preview needs to be updated.
  86         To install a preview widget, use
  87         gtk_file_chooser_set_preview_widget().  Then, connect to the
  88         #GtkFileChooser::update-preview signal to get notified when
  89         you need to update the contents of the preview.
  90       </para>
  91
  92       <para>
  93         Your callback should use
  94         gtk_file_chooser_get_preview_filename() to see what needs
  95         previewing.  Once you have generated the preview for the
  96         corresponding file, you must call
  97         gtk_file_chooser_set_preview_widget_active() with a boolean
  98         flag that indicates whether your callback could successfully
  99         generate a preview.
 100       </para>
 101
 102       <example id="example-gtkfilechooser-preview">
 103         <title>Sample Usage</title>
 104
 105         <programlisting>
 106 {
 107   GtkImage *preview;
 108
 109   ...
 110
 111   preview = gtk_image_new (<!-- -->);
 112
 113   gtk_file_chooser_set_preview_widget (my_file_chooser, preview);
 114   g_signal_connect (my_file_chooser, "update-preview",
 115                     G_CALLBACK (update_preview_cb), preview);
 116 }
 117
 118 static void
 119 update_preview_cb (GtkFileChooser *file_chooser, gpointer data)
 120 {
 121   GtkWidget *preview;
 122   char *filename;
 123   GdkPixbuf *pixbuf;
 124   gboolean have_preview;
 125
 126   preview = GTK_WIDGET (data);
 127   filename = gtk_file_chooser_get_preview_filename (file_chooser);
 128
 129   pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 128, 128, NULL);
 130   have_preview = (pixbuf != NULL);
 131   g_free (filename);
 132
 133   gtk_image_set_from_pixbuf (GTK_IMAGE (preview), pixbuf);
 134   if (pixbuf)
 135     gdk_pixbuf_unref (pixbuf);
 136
 137   gtk_file_chooser_set_preview_widget_active (file_chooser, have_preview);
 138 }
 139         </programlisting>
 140       </example>
 141     </refsect2>
 142
 143     <refsect2 id="gtkfilechooser-extra">
 144       <title>Adding Extra Widgets</title>
 145
 146       <para>
 147         You can add extra widgets to a file chooser to provide options
 148         that are not present in the default design.  For example, you
 149         can add a toggle button to give the user the option to open a
 150         file in read-only mode.  You can use
 151         gtk_file_chooser_set_extra_widget() to insert additional
 152         widgets in a file chooser.
 153       </para>
 154
 155       <example id="example-gtkfilechooser-extra">
 156         <title>Sample Usage</title>
 157
 158         <programlisting>
 159 {
 160   GtkWidget *toggle;
 161
 162   ...
 163
 164   toggle = gtk_check_button_new_with_label ("Open file read-only");
 165   gtk_widget_show (toggle);
 166   gtk_file_chooser_set_extra_widget (my_file_chooser, toggle);
 167 }
 168         </programlisting>
 169       </example>
 170
 171       <note>
 172         <para>
 173           If you want to set more than one extra widget in the file
 174           chooser, you can a container such as a GtkVBox or a GtkTable
 175           and include your widgets in it.  Then, set the container as
 176           the whole extra widget.
 177         </para>
 178       </note>
 179     </refsect2>
 180
 181     <refsect2 id="gtkfilechooser-key-bindings">
 182       <title>Key Bindings</title>
 183
 184       <para>
 185         Internally, GTK+ implements a file chooser's graphical user
 186         interface with the private
 187         <classname>GtkFileChooserDefaultClass</classname>.  This
 188         widget has several <link linkend="gtk-Bindings">key
 189         bindings</link> and their associated signals.  This section
 190         describes the available key binding signals.
 191       </para>
 192
 193       <example id="gtkfilechooser-key-binding-example">
 194         <title>GtkFileChooser key binding example</title>
 195
 196         <para>
 197           The default keys that activate the key-binding signals in
 198           <classname>GtkFileChooserDefaultClass</classname> are as
 199           follows:
 200         </para>
 201
 202         <informaltable>
 203           <tgroup cols="2">
 204             <tbody>
 205               <row>
 206                 <entry>Signal name</entry>
 207                 <entry>Default key combinations</entry>
 208               </row>
 209               <row>
 210                 <entry>location-popup</entry>
 211                 <entry>
 212                   <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>;
 213                   <keycap>/</keycap>
 214                 </entry>
 215               </row>
 216               <row>
 217                 <entry>up-folder</entry>
 218                 <entry>
 219                   <keycombo><keycap>Alt</keycap><keycap>Up</keycap></keycombo><footnote>
 220                     <para>
 221                       Both the individual Up key and the numeric
 222                       keypad's Up key are supported.
 223                     </para>
 224                   </footnote>
 225                   ;
 226                   <keycap>Backspace</keycap>
 227                 </entry>
 228               </row>
 229               <row>
 230                 <entry>down-folder</entry>
 231                 <entry><keycombo><keycap>Alt</keycap><keycap>Down</keycap></keycombo></entry>
 232               </row>
 233               <row>
 234                 <entry>home-folder</entry>
 235                 <entry><keycombo><keycap>Alt</keycap><keycap>Home</keycap></keycombo></entry>
 236               </row>
 237               <row>
 238                 <entry>desktop-folder</entry>
 239                 <entry><keycombo><keycap>Alt</keycap><keycap>D</keycap></keycombo></entry>
 240               </row>
 241             </tbody>
 242           </tgroup>
 243         </informaltable>
 244
 245         <para>
 246           You can change these defaults to something else.  For
 247           example, to add a <keycap>Shift</keycap> modifier to a few
 248           of the default bindings, you can include the following
 249           fragment in your <filename>.gtkrc-2.0</filename> file:
 250         </para>
 251
 252         <programlisting>
 253 binding "my-own-gtkfilechooser-bindings" {
 254         bind "&lt;Alt&gt;&lt;Shift&gt;Up" {
 255                 "up-folder" ()
 256         }
 257         bind "&lt;Alt&gt;&lt;Shift&gt;Down" {
 258                 "down-folder" ()
 259         }
 260         bind "&lt;Alt&gt;&lt;Shift&gt;Home" {
 261                 "home-folder" ()
 262         }
 263 }
 264
 265 class "GtkFileChooserDefault" binding "my-own-gtkfilechooser-bindings"
 266         </programlisting>
 267       </example>
 268
 269       <refsect3 id="GtkFileChooserDefault-location-popup">
 270         <title>The &quot;GtkFileChooserDefault::location-popup&quot; signal</title>
 271
 272         <programlisting>
 273           void user_function (GtkFileChooserDefault *chooser,
 274                               const char            *path,
 275                               <link linkend="gpointer">gpointer</link> user_data);
 276         </programlisting>
 277
 278         <para>
 279           This is used to make the file chooser show a "Location"
 280           dialog which the user can use to manually type the name of
 281           the file he wishes to select.  The
 282           <parameter>path</parameter> argument is a string that gets
 283           put in the text entry for the file name.  By default this is bound to
 284           <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
 285           with a <parameter>path</parameter> string of "" (the empty
 286           string); it is also bound to <keycap>/</keycap> with a
 287           <parameter>path</parameter> string of "<literal>/</literal>"
 288           (a slash):  this lets you type <keycap>/</keycap> and
 289           immediately type a path name.
 290         </para>
 291
 292         <variablelist role="params">
 293           <varlistentry>
 294             <term><parameter>chooser</parameter>&nbsp;:</term>
 295             <listitem>
 296               <simpara>
 297                 the object which received the signal.
 298               </simpara>
 299             </listitem>
 300           </varlistentry>
 301           <varlistentry>
 302             <term><parameter>path</parameter>&nbsp;:</term>
 303             <listitem>
 304               <simpara>
 305                 default contents for the text entry for the file name
 306               </simpara>
 307             </listitem>
 308           </varlistentry>
 309           <varlistentry>
 310             <term><parameter>user_data</parameter>&nbsp;:</term>
 311             <listitem>
 312               <simpara>
 313                 user data set when the signal handler was connected.
 314               </simpara>
 315             </listitem>
 316           </varlistentry>
 317         </variablelist>
 318
 319         <tip>
 320           <para>
 321             You can create your own bindings for the
 322             <symbol>location-popup</symbol> signal with custom
 323             <parameter>path</parameter> strings, and have a crude form
 324             of easily-to-type bookmarks.  For example, say you access
 325             the path <filename>/home/username/misc</filename> very
 326             frequently.  You could then create an <keycombo>
 327             <keycap>Alt</keycap> <keycap>M</keycap> </keycombo>
 328             shortcut by including the following in your
 329             <filename>.gtkrc-2.0</filename>:
 330           </para>
 331
 332           <programlisting>
 333 binding "misc-shortcut" {
 334         bind "&lt;Alt&gt;M" {
 335                 "location-popup" ("/home/username/misc")
 336         }
 337 }
 338
 339 class "GtkFileChooserDefault" binding "misc-shortcut"
 340           </programlisting>
 341         </tip>
 342       </refsect3>
 343
 344       <refsect3 id="GtkFileChooserDefault-up-folder">
 345         <title>The &quot;GtkFileChooserDefault::up-folder&quot; signal</title>
 346
 347         <programlisting>
 348           void user_function (GtkFileChooserDefault *chooser,
 349                               <link linkend="gpointer">gpointer</link> user_data);
 350         </programlisting>
 351
 352         <para>
 353           This is used to make the file chooser go to the parent of
 354           the current folder in the file hierarchy.  By default this
 355           is bound to <keycap>Backspace</keycap> and
 356           <keycombo><keycap>Alt</keycap><keycap>Up</keycap></keycombo>
 357           (the Up key in the numeric keypad also works).
 358         </para>
 359
 360         <variablelist role="params">
 361           <varlistentry>
 362             <term><parameter>chooser</parameter>&nbsp;:</term>
 363             <listitem>
 364               <simpara>
 365                 the object which received the signal.
 366               </simpara>
 367             </listitem>
 368           </varlistentry>
 369           <varlistentry>
 370             <term><parameter>user_data</parameter>&nbsp;:</term>
 371             <listitem>
 372               <simpara>
 373                 user data set when the signal handler was connected.
 374               </simpara>
 375             </listitem>
 376           </varlistentry>
 377         </variablelist>
 378       </refsect3>
 379
 380       <refsect3 id="GtkFileChooserDefault-down-folder">
 381         <title>The &quot;GtkFileChooserDefault::down-folder&quot; signal</title>
 382
 383         <programlisting>
 384           void user_function (GtkFileChooserDefault *chooser,
 385                               <link linkend="gpointer">gpointer</link> user_data);
 386         </programlisting>
 387
 388         <para>
 389           This is used to make the file chooser go to a child of the
 390           current folder in the file hierarchy.  The subfolder that
 391           will be used is displayed in the path bar widget of the file
 392           chooser.  For example, if the path bar is showing
 393           "/foo/<emphasis>bar/</emphasis>baz", then this will cause
 394           the file chooser to switch to the "baz" subfolder.  By
 395           default this is bound to
 396           <keycombo><keycap>Alt</keycap><keycap>Down</keycap></keycombo>
 397           (the Down key in the numeric keypad also works).
 398         </para>
 399
 400         <variablelist role="params">
 401           <varlistentry>
 402             <term><parameter>chooser</parameter>&nbsp;:</term>
 403             <listitem>
 404               <simpara>
 405                 the object which received the signal.
 406               </simpara>
 407             </listitem>
 408           </varlistentry>
 409           <varlistentry>
 410             <term><parameter>user_data</parameter>&nbsp;:</term>
 411             <listitem>
 412               <simpara>
 413                 user data set when the signal handler was connected.
 414               </simpara>
 415             </listitem>
 416           </varlistentry>
 417         </variablelist>
 418       </refsect3>
 419
 420       <refsect3 id="GtkFileChooserDefault-home-folder">
 421         <title>The &quot;GtkFileChooserDefault::home-folder&quot; signal</title>
 422
 423         <programlisting>
 424           void user_function (GtkFileChooserDefault *chooser,
 425                               <link linkend="gpointer">gpointer</link> user_data);
 426         </programlisting>
 427
 428         <para>
 429           This is used to make the file chooser show the user's home
 430           folder in the file list.  By default this is bound to
 431           <keycombo><keycap>Alt</keycap><keycap>Home</keycap></keycombo>
 432           (the Home key in the numeric keypad also works).
 433         </para>
 434
 435         <variablelist role="params">
 436           <varlistentry>
 437             <term><parameter>chooser</parameter>&nbsp;:</term>
 438             <listitem>
 439               <simpara>
 440                 the object which received the signal.
 441               </simpara>
 442             </listitem>
 443           </varlistentry>
 444           <varlistentry>
 445             <term><parameter>user_data</parameter>&nbsp;:</term>
 446             <listitem>
 447               <simpara>
 448                 user data set when the signal handler was connected.
 449               </simpara>
 450             </listitem>
 451           </varlistentry>
 452         </variablelist>
 453       </refsect3>
 454
 455       <refsect3 id="GtkFileChooserDefault-desktop-folder">
 456         <title>The &quot;GtkFileChooserDefault::desktop-folder&quot; signal</title>
 457
 458         <programlisting>
 459           void user_function (GtkFileChooserDefault *chooser,
 460                               <link linkend="gpointer">gpointer</link> user_data);
 461         </programlisting>
 462
 463         <para>
 464           This is used to make the file chooser show the user's Desktop
 465           folder in the file list.  By default this is bound to
 466           <keycombo><keycap>Alt</keycap><keycap>D</keycap></keycombo>.
 467         </para>
 468
 469         <variablelist role="params">
 470           <varlistentry>
 471             <term><parameter>chooser</parameter>&nbsp;:</term>
 472             <listitem>
 473               <simpara>
 474                 the object which received the signal.
 475               </simpara>
 476             </listitem>
 477           </varlistentry>
 478           <varlistentry>
 479             <term><parameter>user_data</parameter>&nbsp;:</term>
 480             <listitem>
 481               <simpara>
 482                 user data set when the signal handler was connected.
 483               </simpara>
 484             </listitem>
 485           </varlistentry>
 486         </variablelist>
 487       </refsect3>
 488     </refsect2>
 489
 490 <!-- ##### SECTION See_Also ##### -->
 491     <para>
 492       #GtkFileChooserDialog, #GtkFileChooserWidget, #GtkFileChooserButton
 493     </para>
 494
 495 <!-- ##### SECTION Stability_Level ##### -->
 496
 497
 498 <!-- ##### STRUCT GtkFileChooser ##### -->
 499 <para>
 500
 501 </para>
 502
 503
 504 <!-- ##### SIGNAL GtkFileChooser::confirm-overwrite ##### -->
 505     <para>
 506       This signal gets emitted whenever it is appropriate to present a
 507       confirmation dialog when the user has selected a file name that
 508       already exists.  The signal only gets emitted when the file
 509       chooser is in #GTK_FILE_CHOOSER_ACTION_SAVE mode.
 510     </para>
 511
 512     <para>
 513       Most applications just need to turn on the <link
 514       linkend="GtkFileChooser--do-overwrite-confirmation">do-overwrite-confirmation</link>
 515       property (or call the
 516       gtk_file_chooser_set_do_overwrite_confirmation() function), and
 517       they will automatically get a stock confirmation dialog.
 518       Applications which need to customize this behavior should do
 519       that, and also connect to the <symbol>confirm-overwrite</symbol>
 520       signal.
 521     </para>
 522
 523     <para>
 524       A signal handler for this signal must return a
 525       #GtkFileChooserConfirmation value, which indicates the action to
 526       take.  If the handler determines that the user wants to select a
 527       different filename, it should return
 528       #GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN.  If it determines
 529       that the user is satisfied with his choice of file name, it
 530       should return #GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME.
 531       On the other hand, if it determines that the stock confirmation
 532       dialog should be used, it should return
 533       #GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM.  The following example
 534       illustrates this.
 535     </para>
 536
 537     <example id="gtkfilechooser-confirmation">
 538       <title>Custom confirmation</title>
 539
 540       <programlisting>
 541 static GtkFileChooserConfirmation
 542 confirm_overwrite_callback (GtkFileChooser *chooser, gpointer data)
 543 {
 544   char *uri;
 545
 546   uri = gtk_file_chooser_get_uri (chooser);
 547
 548   if (is_uri_read_only (uri))
 549     {
 550       if (user_wants_to_replace_read_only_file (uri))
 551         return GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME;
 552       else
 553         return GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN;
 554     } else
 555       return GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM; /* fall back to the default dialog */
 556 }
 557
 558 ...
 559
 560 chooser = gtk_file_chooser_dialog_new (...);
 561
 562 gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog), TRUE);
 563 g_signal_connect (chooser, "confirm-overwrite",
 564                   G_CALLBACK (confirm_overwrite_callback), NULL);
 565
 566 if (gtk_dialog_run (chooser) == GTK_RESPONSE_ACCEPT)
 567         save_to_file (gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (chooser));
 568
 569 gtk_widget_destroy (chooser);
 570       </programlisting>
 571     </example>
 572
 573 @filechooser: the object which received the signal.
 574 @Returns: #GtkFileChooserConfirmation value that indicates which
 575     action to take after emitting the signal.
 576
 577     <para>
 578       Since 2.8
 579     </para>
 580
 581 <!-- ##### SIGNAL GtkFileChooser::current-folder-changed ##### -->
 582 <para>
 583
 584 </para>
 585
 586 @filechooser: the object which received the signal.
 587
 588 <!-- ##### SIGNAL GtkFileChooser::file-activated ##### -->
 589 <para>
 590
 591 </para>
 592
 593 @filechooser: the object which received the signal.
 594
 595 <!-- ##### SIGNAL GtkFileChooser::selection-changed ##### -->
 596 <para>
 597
 598 </para>
 599
 600 @filechooser: the object which received the signal.
 601
 602 <!-- ##### SIGNAL GtkFileChooser::update-preview ##### -->
 603 <para>
 604
 605 </para>
 606
 607 @filechooser: the object which received the signal.
 608
 609 <!-- ##### ARG GtkFileChooser:action ##### -->
 610 <para>
 611
 612 </para>
 613
 614 <!-- ##### ARG GtkFileChooser:do-overwrite-confirmation ##### -->
 615 <para>
 616
 617 </para>
 618
 619 <!-- ##### ARG GtkFileChooser:extra-widget ##### -->
 620 <para>
 621
 622 </para>
 623
 624 <!-- ##### ARG GtkFileChooser:file-system-backend ##### -->
 625 <para>
 626
 627 </para>
 628
 629 <!-- ##### ARG GtkFileChooser:filter ##### -->
 630 <para>
 631
 632 </para>
 633
 634 <!-- ##### ARG GtkFileChooser:local-only ##### -->
 635 <para>
 636
 637 </para>
 638
 639 <!-- ##### ARG GtkFileChooser:preview-widget ##### -->
 640 <para>
 641
 642 </para>
 643
 644 <!-- ##### ARG GtkFileChooser:preview-widget-active ##### -->
 645 <para>
 646
 647 </para>
 648
 649 <!-- ##### ARG GtkFileChooser:select-multiple ##### -->
 650 <para>
 651
 652 </para>
 653
 654 <!-- ##### ARG GtkFileChooser:show-hidden ##### -->
 655 <para>
 656
 657 </para>
 658
 659 <!-- ##### ARG GtkFileChooser:use-preview-label ##### -->
 660 <para>
 661
 662 </para>
 663
 664 <!-- ##### ENUM GtkFileChooserAction ##### -->
 665     <para>
 666       Describes whether a #GtkFileChooser is being used to open
 667       existing files or to save to a possibly new file.
 668     </para>
 669
 670 @GTK_FILE_CHOOSER_ACTION_OPEN: Indicates open mode.  The file chooser
 671     will only let the user pick an existing file.
 672 @GTK_FILE_CHOOSER_ACTION_SAVE: Indicates save mode.  The file chooser
 673     will let the user pick an existing file, or type in a new
 674     filename.
 675 @GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER: Indicates an Open mode for
 676     selecting folders.  The file chooser will let the user pick an
 677     existing folder.
 678 @GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER: Indicates a mode for creating a
 679     new folder.  The file chooser will let the user name an existing or
 680     new folder.
 681
 682 <!-- ##### ENUM GtkFileChooserConfirmation ##### -->
 683     <para>
 684       Used as a return value of handlers for the <link
 685       linkend="GtkFileChooser-confirm-overwrite">confirm-overwrite</link>
 686       signal of a <classname>GtkFileChooser</classname>.  This value
 687       determines whether the file chooser will present the stock
 688       confirmation dialog, accept the user's choice of a filename, or
 689       let the user choose another filename.
 690     </para>
 691
 692 @GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM: The file chooser will present
 693     its stock dialog to confirm about overwriting an existing file.
 694 @GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME: The file chooser will
 695     terminate and accept the user's choice of a file name.
 696 @GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN: The file chooser will
 697     continue running, so as to let the user select another file name.
 698
 699     <para>
 700       Since 2.8
 701     </para>
 702
 703 <!-- ##### MACRO GTK_FILE_CHOOSER_ERROR ##### -->
 704     <para>
 705       Used to get the #GError quark for #GtkFileChooser errors.
 706     </para>
 707
 708
 709
 710 <!-- ##### ENUM GtkFileChooserError ##### -->
 711     <para>
 712       These identify the various errors that can occur while calling
 713       #GtkFileChooser functions.
 714     </para>
 715
 716 @GTK_FILE_CHOOSER_ERROR_NONEXISTENT: Indicates that a file does not exist.
 717 @GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: Indicates a malformed filename.
 718
 719 <!-- ##### FUNCTION gtk_file_chooser_error_quark ##### -->
 720 <para>
 721
 722 </para>
 723
 724 @Returns:
 725
 726
 727 <!-- ##### FUNCTION gtk_file_chooser_set_action ##### -->
 728 <para>
 729
 730 </para>
 731
 732 @chooser:
 733 @action:
 734
 735
 736 <!-- ##### FUNCTION gtk_file_chooser_get_action ##### -->
 737 <para>
 738
 739 </para>
 740
 741 @chooser:
 742 @Returns:
 743
 744
 745 <!-- ##### FUNCTION gtk_file_chooser_set_local_only ##### -->
 746 <para>
 747
 748 </para>
 749
 750 @chooser:
 751 @local_only:
 752 <!-- # Unused Parameters # -->
 753 @files_only:
 754
 755
 756 <!-- ##### FUNCTION gtk_file_chooser_get_local_only ##### -->
 757 <para>
 758
 759 </para>
 760
 761 @chooser:
 762 @Returns:
 763
 764
 765 <!-- ##### FUNCTION gtk_file_chooser_set_select_multiple ##### -->
 766 <para>
 767
 768 </para>
 769
 770 @chooser:
 771 @select_multiple:
 772
 773
 774 <!-- ##### FUNCTION gtk_file_chooser_get_select_multiple ##### -->
 775 <para>
 776
 777 </para>
 778
 779 @chooser:
 780 @Returns:
 781
 782
 783 <!-- ##### FUNCTION gtk_file_chooser_set_show_hidden ##### -->
 784 <para>
 785
 786 </para>
 787
 788 @chooser:
 789 @show_hidden:
 790
 791
 792 <!-- ##### FUNCTION gtk_file_chooser_get_show_hidden ##### -->
 793 <para>
 794
 795 </para>
 796
 797 @chooser:
 798 @Returns:
 799
 800
 801 <!-- ##### FUNCTION gtk_file_chooser_set_do_overwrite_confirmation ##### -->
 802 <para>
 803
 804 </para>
 805
 806 @chooser:
 807 @do_overwrite_confirmation:
 808
 809
 810 <!-- ##### FUNCTION gtk_file_chooser_get_do_overwrite_confirmation ##### -->
 811 <para>
 812
 813 </para>
 814
 815 @chooser:
 816 @Returns:
 817
 818
 819 <!-- ##### FUNCTION gtk_file_chooser_set_current_name ##### -->
 820 <para>
 821
 822 </para>
 823
 824 @chooser:
 825 @name:
 826
 827
 828 <!-- ##### FUNCTION gtk_file_chooser_get_filename ##### -->
 829 <para>
 830
 831 </para>
 832
 833 @chooser:
 834 @Returns:
 835
 836
 837 <!-- ##### FUNCTION gtk_file_chooser_set_filename ##### -->
 838 <para>
 839
 840 </para>
 841
 842 @chooser:
 843 @filename:
 844 @Returns:
 845
 846
 847 <!-- ##### FUNCTION gtk_file_chooser_select_filename ##### -->
 848 <para>
 849
 850 </para>
 851
 852 @chooser:
 853 @filename:
 854 @Returns:
 855
 856
 857 <!-- ##### FUNCTION gtk_file_chooser_unselect_filename ##### -->
 858 <para>
 859
 860 </para>
 861
 862 @chooser:
 863 @filename:
 864
 865
 866 <!-- ##### FUNCTION gtk_file_chooser_select_all ##### -->
 867 <para>
 868
 869 </para>
 870
 871 @chooser:
 872
 873
 874 <!-- ##### FUNCTION gtk_file_chooser_unselect_all ##### -->
 875 <para>
 876
 877 </para>
 878
 879 @chooser:
 880
 881
 882 <!-- ##### FUNCTION gtk_file_chooser_get_filenames ##### -->
 883 <para>
 884
 885 </para>
 886
 887 @chooser:
 888 @Returns:
 889
 890
 891 <!-- ##### FUNCTION gtk_file_chooser_set_current_folder ##### -->
 892 <para>
 893
 894 </para>
 895
 896 @chooser:
 897 @filename:
 898 @Returns:
 899
 900
 901 <!-- ##### FUNCTION gtk_file_chooser_get_current_folder ##### -->
 902 <para>
 903
 904 </para>
 905
 906 @chooser:
 907 @Returns:
 908
 909
 910 <!-- ##### FUNCTION gtk_file_chooser_get_uri ##### -->
 911 <para>
 912
 913 </para>
 914
 915 @chooser:
 916 @Returns:
 917
 918
 919 <!-- ##### FUNCTION gtk_file_chooser_set_uri ##### -->
 920 <para>
 921
 922 </para>
 923
 924 @chooser:
 925 @uri:
 926 @Returns:
 927
 928
 929 <!-- ##### FUNCTION gtk_file_chooser_select_uri ##### -->
 930 <para>
 931
 932 </para>
 933
 934 @chooser:
 935 @uri:
 936 @Returns:
 937
 938
 939 <!-- ##### FUNCTION gtk_file_chooser_unselect_uri ##### -->
 940 <para>
 941
 942 </para>
 943
 944 @chooser:
 945 @uri:
 946
 947
 948 <!-- ##### FUNCTION gtk_file_chooser_get_uris ##### -->
 949 <para>
 950
 951 </para>
 952
 953 @chooser:
 954 @Returns:
 955
 956
 957 <!-- ##### FUNCTION gtk_file_chooser_set_current_folder_uri ##### -->
 958 <para>
 959
 960 </para>
 961
 962 @chooser:
 963 @uri:
 964 @Returns:
 965
 966
 967 <!-- ##### FUNCTION gtk_file_chooser_get_current_folder_uri ##### -->
 968 <para>
 969
 970 </para>
 971
 972 @chooser:
 973 @Returns:
 974
 975
 976 <!-- ##### FUNCTION gtk_file_chooser_set_preview_widget ##### -->
 977 <para>
 978
 979 </para>
 980
 981 @chooser:
 982 @preview_widget:
 983
 984
 985 <!-- ##### FUNCTION gtk_file_chooser_get_preview_widget ##### -->
 986 <para>
 987
 988 </para>
 989
 990 @chooser:
 991 @Returns:
 992
 993
 994 <!-- ##### FUNCTION gtk_file_chooser_set_preview_widget_active ##### -->
 995 <para>
 996
 997 </para>
 998
 999 @chooser:
1000 @active:
1001
1002
1003 <!-- ##### FUNCTION gtk_file_chooser_get_preview_widget_active ##### -->
1004 <para>
1005
1006 </para>
1007
1008 @chooser:
1009 @Returns:
1010
1011
1012 <!-- ##### FUNCTION gtk_file_chooser_set_use_preview_label ##### -->
1013 <para>
1014
1015 </para>
1016
1017 @chooser:
1018 @use_label:
1019
1020
1021 <!-- ##### FUNCTION gtk_file_chooser_get_use_preview_label ##### -->
1022 <para>
1023
1024 </para>
1025
1026 @chooser:
1027 @Returns:
1028
1029
1030 <!-- ##### FUNCTION gtk_file_chooser_get_preview_filename ##### -->
1031 <para>
1032
1033 </para>
1034
1035 @chooser:
1036 @Returns:
1037 <!-- # Unused Parameters # -->
1038 @file_chooser:
1039
1040
1041 <!-- ##### FUNCTION gtk_file_chooser_get_preview_uri ##### -->
1042 <para>
1043
1044 </para>
1045
1046 @chooser:
1047 @Returns:
1048 <!-- # Unused Parameters # -->
1049 @file_chooser:
1050
1051
1052 <!-- ##### FUNCTION gtk_file_chooser_set_extra_widget ##### -->
1053 <para>
1054
1055 </para>
1056
1057 @chooser:
1058 @extra_widget:
1059
1060
1061 <!-- ##### FUNCTION gtk_file_chooser_get_extra_widget ##### -->
1062 <para>
1063
1064 </para>
1065
1066 @chooser:
1067 @Returns:
1068
1069
1070 <!-- ##### FUNCTION gtk_file_chooser_add_filter ##### -->
1071 <para>
1072
1073 </para>
1074
1075 @chooser:
1076 @filter:
1077
1078
1079 <!-- ##### FUNCTION gtk_file_chooser_remove_filter ##### -->
1080 <para>
1081
1082 </para>
1083
1084 @chooser:
1085 @filter:
1086
1087
1088 <!-- ##### FUNCTION gtk_file_chooser_list_filters ##### -->
1089 <para>
1090
1091 </para>
1092
1093 @chooser:
1094 @Returns:
1095
1096
1097 <!-- ##### FUNCTION gtk_file_chooser_set_filter ##### -->
1098 <para>
1099
1100 </para>
1101
1102 @chooser:
1103 @filter:
1104
1105
1106 <!-- ##### FUNCTION gtk_file_chooser_get_filter ##### -->
1107 <para>
1108
1109 </para>
1110
1111 @chooser:
1112 @Returns:
1113
1114
1115 <!-- ##### FUNCTION gtk_file_chooser_add_shortcut_folder ##### -->
1116 <para>
1117
1118 </para>
1119
1120 @chooser:
1121 @folder:
1122 @error:
1123 @Returns:
1124
1125
1126 <!-- ##### FUNCTION gtk_file_chooser_remove_shortcut_folder ##### -->
1127 <para>
1128
1129 </para>
1130
1131 @chooser:
1132 @folder:
1133 @error:
1134 @Returns:
1135
1136
1137 <!-- ##### FUNCTION gtk_file_chooser_list_shortcut_folders ##### -->
1138 <para>
1139
1140 </para>
1141
1142 @chooser:
1143 @Returns:
1144
1145
1146 <!-- ##### FUNCTION gtk_file_chooser_add_shortcut_folder_uri ##### -->
1147 <para>
1148
1149 </para>
1150
1151 @chooser:
1152 @uri:
1153 @error:
1154 @Returns:
1155 <!-- # Unused Parameters # -->
1156 @folder:
1157
1158
1159 <!-- ##### FUNCTION gtk_file_chooser_remove_shortcut_folder_uri ##### -->
1160 <para>
1161
1162 </para>
1163
1164 @chooser:
1165 @uri:
1166 @error:
1167 @Returns:
1168 <!-- # Unused Parameters # -->
1169 @folder:
1170
1171
1172 <!-- ##### FUNCTION gtk_file_chooser_list_shortcut_folder_uris ##### -->
1173 <para>
1174
1175 </para>
1176
1177 @chooser:
1178 @Returns:
1179
1180
1181
1182 <!--
1183 Local variables:
1184 mode: sgml
1185 sgml-parent-document: ("../gtk-docs.sgml" "book" "refentry")
1186 End:
1187 -->
1188
1189