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
  11       this interface are #GtkFileChooserWidget and
  12       #GtkFileChooserDialog.  You do not need to write an object that
  13       implements the #GtkFileChooser interface unless you are trying
  14       to adapt an existing file selector to expose a standard
  15       programming interface.
  16     </para>
  17
  18 <!-- ##### SECTION See_Also ##### -->
  19     <para>
  20       #GtkFileChooserDialog, #GtkFileChooserWidget
  21     </para>
  22
  23 <!-- ##### ENUM GtkFileChooserAction ##### -->
  24     <para>
  25       Describes whether a #GtkFileChooser is being used to open
  26       existing files or to save to a possibly new file.
  27     </para>
  28
  29 @GTK_FILE_CHOOSER_ACTION_OPEN: Indicates Open mode.  The file chooser
  30     will only let the user pick an existing file.
  31 @GTK_FILE_CHOOSER_ACTION_SAVE: Indicates Save mode.  The file chooser
  32     will let the user pick an existing file, or type in a new
  33     filename.
  34
  35 <!-- ##### MACRO GTK_FILE_CHOOSER_ERROR ##### -->
  36     <para>
  37       Used to get the #GError quark for #GtkFileChooser errors.
  38     </para>
  39
  40
  41
  42 <!-- ##### ENUM GtkFileChooserError ##### -->
  43     <para>
  44       These identify the various errors that can occur while calling
  45       #GtkFileChooser functions.
  46     </para>
  47
  48 @GTK_FILE_CHOOSER_ERROR_NONEXISTENT: Indicates that a file does not exist.
  49 @GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: Indicates a malformed filename.
  50
  51 <!-- ##### FUNCTION gtk_file_chooser_error_quark ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @Returns:
  57
  58
  59 <!-- ##### FUNCTION gtk_file_chooser_set_action ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @chooser:
  65 @action:
  66
  67
  68 <!-- ##### FUNCTION gtk_file_chooser_get_action ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @chooser:
  74 @Returns:
  75
  76
  77 <!-- ##### FUNCTION gtk_file_chooser_set_folder_mode ##### -->
  78 <para>
  79
  80 </para>
  81
  82 @chooser:
  83 @folder_mode:
  84
  85
  86 <!-- ##### FUNCTION gtk_file_chooser_get_folder_mode ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @chooser:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION gtk_file_chooser_set_local_only ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @chooser:
 101 @files_only:
 102
 103
 104 <!-- ##### FUNCTION gtk_file_chooser_get_local_only ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @chooser:
 110 @Returns:
 111
 112
 113 <!-- ##### FUNCTION gtk_file_chooser_set_select_multiple ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @chooser:
 119 @select_multiple:
 120
 121
 122 <!-- ##### FUNCTION gtk_file_chooser_get_select_multiple ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @chooser:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gtk_file_chooser_set_current_name ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @chooser:
 137 @name:
 138
 139
 140 <!-- ##### FUNCTION gtk_file_chooser_get_filename ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @chooser:
 146 @Returns:
 147
 148
 149 <!-- ##### FUNCTION gtk_file_chooser_set_filename ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @chooser:
 155 @filename:
 156
 157
 158 <!-- ##### FUNCTION gtk_file_chooser_select_filename ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @chooser:
 164 @filename:
 165
 166
 167 <!-- ##### FUNCTION gtk_file_chooser_unselect_filename ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @chooser:
 173 @filename:
 174
 175
 176 <!-- ##### FUNCTION gtk_file_chooser_select_all ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @chooser:
 182
 183
 184 <!-- ##### FUNCTION gtk_file_chooser_unselect_all ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @chooser:
 190
 191
 192 <!-- ##### FUNCTION gtk_file_chooser_get_filenames ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @chooser:
 198 @Returns:
 199
 200
 201 <!-- ##### FUNCTION gtk_file_chooser_set_current_folder ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @chooser:
 207 @filename:
 208
 209
 210 <!-- ##### FUNCTION gtk_file_chooser_get_current_folder ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @chooser:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION gtk_file_chooser_get_uri ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @chooser:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION gtk_file_chooser_set_uri ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @chooser:
 234 @uri:
 235
 236
 237 <!-- ##### FUNCTION gtk_file_chooser_select_uri ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @chooser:
 243 @uri:
 244
 245
 246 <!-- ##### FUNCTION gtk_file_chooser_unselect_uri ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @chooser:
 252 @uri:
 253
 254
 255 <!-- ##### FUNCTION gtk_file_chooser_get_uris ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @chooser:
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION gtk_file_chooser_set_current_folder_uri ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @chooser:
 270 @uri:
 271
 272
 273 <!-- ##### FUNCTION gtk_file_chooser_get_current_folder_uri ##### -->
 274 <para>
 275
 276 </para>
 277
 278 @chooser:
 279 @Returns:
 280
 281
 282 <!-- ##### FUNCTION gtk_file_chooser_set_preview_widget ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @chooser:
 288 @preview_widget:
 289
 290
 291 <!-- ##### FUNCTION gtk_file_chooser_get_preview_widget ##### -->
 292 <para>
 293
 294 </para>
 295
 296 @chooser:
 297 @Returns:
 298
 299
 300 <!-- ##### FUNCTION gtk_file_chooser_set_preview_widget_active ##### -->
 301 <para>
 302
 303 </para>
 304
 305 @chooser:
 306 @active:
 307
 308
 309 <!-- ##### FUNCTION gtk_file_chooser_get_preview_widget_active ##### -->
 310 <para>
 311
 312 </para>
 313
 314 @chooser:
 315 @Returns:
 316
 317
 318 <!-- ##### FUNCTION gtk_file_chooser_get_preview_filename ##### -->
 319 <para>
 320
 321 </para>
 322
 323 @file_chooser:
 324 @Returns:
 325
 326
 327 <!-- ##### FUNCTION gtk_file_chooser_get_preview_uri ##### -->
 328 <para>
 329
 330 </para>
 331
 332 @file_chooser:
 333 @Returns:
 334
 335
 336 <!-- ##### FUNCTION gtk_file_chooser_set_extra_widget ##### -->
 337 <para>
 338
 339 </para>
 340
 341 @chooser:
 342 @extra_widget:
 343
 344
 345 <!-- ##### FUNCTION gtk_file_chooser_get_extra_widget ##### -->
 346 <para>
 347
 348 </para>
 349
 350 @chooser:
 351 @Returns:
 352
 353
 354 <!-- ##### FUNCTION gtk_file_chooser_add_filter ##### -->
 355 <para>
 356
 357 </para>
 358
 359 @chooser:
 360 @filter:
 361
 362
 363 <!-- ##### FUNCTION gtk_file_chooser_remove_filter ##### -->
 364 <para>
 365
 366 </para>
 367
 368 @chooser:
 369 @filter:
 370
 371
 372 <!-- ##### FUNCTION gtk_file_chooser_list_filters ##### -->
 373 <para>
 374
 375 </para>
 376
 377 @chooser:
 378 @Returns:
 379
 380
 381 <!-- ##### FUNCTION gtk_file_chooser_set_filter ##### -->
 382 <para>
 383
 384 </para>
 385
 386 @chooser:
 387 @filter:
 388
 389
 390 <!-- ##### FUNCTION gtk_file_chooser_get_filter ##### -->
 391 <para>
 392
 393 </para>
 394
 395 @chooser:
 396 @Returns:
 397
 398
 399 <!-- ##### FUNCTION gtk_file_chooser_add_shortcut_folder ##### -->
 400 <para>
 401
 402 </para>
 403
 404 @chooser:
 405 @folder:
 406 @error:
 407 @Returns:
 408
 409
 410 <!-- ##### FUNCTION gtk_file_chooser_remove_shortcut_folder ##### -->
 411 <para>
 412
 413 </para>
 414
 415 @chooser:
 416 @folder:
 417 @error:
 418 @Returns:
 419
 420
 421 <!-- ##### FUNCTION gtk_file_chooser_list_shortcut_folders ##### -->
 422 <para>
 423
 424 </para>
 425
 426 @chooser:
 427 @Returns:
 428
 429
 430 <!-- ##### FUNCTION gtk_file_chooser_add_shortcut_folder_uri ##### -->
 431 <para>
 432
 433 </para>
 434
 435 @chooser:
 436 @folder:
 437 @error:
 438 @Returns:
 439
 440
 441 <!-- ##### FUNCTION gtk_file_chooser_remove_shortcut_folder_uri ##### -->
 442 <para>
 443
 444 </para>
 445
 446 @chooser:
 447 @folder:
 448 @error:
 449 @Returns:
 450
 451
 452 <!-- ##### FUNCTION gtk_file_chooser_list_shortcut_folder_uris ##### -->
 453 <para>
 454
 455 </para>
 456
 457 @chooser:
 458 @Returns:
 459
 460
 461
 462 <!--
 463 Local variables:
 464 mode: sgml
 465 sgml-parent-document: ("../gtk-docs.sgml" "book" "refentry")
 466 End:
 467 -->
 468
 469