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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkRecentChooser
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Interface implemented by widgets displaying recently used files
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #GtkRecentChooser is an interface that can be implemented by widgets
  10 displaying the list of recently used files.  In GTK+, the main objects
  11 that implement this interface are #GtkRecentChooserWidget,
  12 #GtkRecentChooserDialog and #GtkRecentChooserMenu.
  13 </para>
  14
  15 <para>
  16 Recently used files are supported since GTK+ 2.10.
  17 </para>
  18
  19 <!-- ##### SECTION See_Also ##### -->
  20 <para>
  21 #GtkRecentManager, #GtkRecentChooserDialog, #GtkRecentChooserWidget,
  22 #GtkRecentChooserMenu
  23 </para>
  24
  25 <!-- ##### SECTION Stability_Level ##### -->
  26
  27
  28 <!-- ##### SECTION Image ##### -->
  29
  30
  31 <!-- ##### STRUCT GtkRecentChooser ##### -->
  32 <para>
  33
  34 </para>
  35
  36
  37 <!-- ##### SIGNAL GtkRecentChooser::item-activated ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @recentchooser: the object which received the signal.
  43
  44 <!-- ##### SIGNAL GtkRecentChooser::selection-changed ##### -->
  45 <para>
  46
  47 </para>
  48
  49 @recentchooser: the object which received the signal.
  50
  51 <!-- ##### ARG GtkRecentChooser:filter ##### -->
  52 <para>
  53
  54 </para>
  55
  56 <!-- ##### ARG GtkRecentChooser:limit ##### -->
  57 <para>
  58
  59 </para>
  60
  61 <!-- ##### ARG GtkRecentChooser:local-only ##### -->
  62 <para>
  63
  64 </para>
  65
  66 <!-- ##### ARG GtkRecentChooser:recent-manager ##### -->
  67 <para>
  68
  69 </para>
  70
  71 <!-- ##### ARG GtkRecentChooser:select-multiple ##### -->
  72 <para>
  73
  74 </para>
  75
  76 <!-- ##### ARG GtkRecentChooser:show-icons ##### -->
  77 <para>
  78
  79 </para>
  80
  81 <!-- ##### ARG GtkRecentChooser:show-not-found ##### -->
  82 <para>
  83
  84 </para>
  85
  86 <!-- ##### ARG GtkRecentChooser:show-private ##### -->
  87 <para>
  88
  89 </para>
  90
  91 <!-- ##### ARG GtkRecentChooser:show-tips ##### -->
  92 <para>
  93
  94 </para>
  95
  96 <!-- ##### ARG GtkRecentChooser:sort-type ##### -->
  97 <para>
  98
  99 </para>
 100
 101 <!-- ##### STRUCT GtkRecentChooserIface ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @base_iface:
 107 @set_current_uri:
 108 @get_current_uri:
 109 @select_uri:
 110 @unselect_uri:
 111 @select_all:
 112 @unselect_all:
 113 @get_items:
 114 @get_recent_manager:
 115 @add_filter:
 116 @remove_filter:
 117 @list_filters:
 118 @set_sort_func:
 119 @item_activated:
 120 @selection_changed:
 121
 122 <!-- ##### MACRO GTK_RECENT_CHOOSER_ERROR ##### -->
 123 <para>
 124 Used to get the #GError quark for #GtkRecentChooser errors.
 125 </para>
 126
 127
 128
 129 <!-- ##### ENUM GtkRecentChooserError ##### -->
 130 <para>
 131 These identify the various errors that can occur while calling
 132 #GtkRecentChooser functions.
 133 </para>
 134
 135 @GTK_RECENT_CHOOSER_ERROR_NOT_FOUND: Indicates that a file does not exist
 136 @GTK_RECENT_CHOOSER_ERROR_INVALID_URI: Indicates a malformed URI
 137
 138 <!-- ##### FUNCTION gtk_recent_chooser_set_show_private ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @chooser:
 144 @show_private:
 145
 146
 147 <!-- ##### FUNCTION gtk_recent_chooser_get_show_private ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @chooser:
 153 @Returns:
 154
 155
 156 <!-- ##### FUNCTION gtk_recent_chooser_set_show_not_found ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @chooser:
 162 @show_not_found:
 163
 164
 165 <!-- ##### FUNCTION gtk_recent_chooser_get_show_not_found ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @chooser:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION gtk_recent_chooser_set_show_icons ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @chooser:
 180 @show_icons:
 181
 182
 183 <!-- ##### FUNCTION gtk_recent_chooser_get_show_icons ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @chooser:
 189 @Returns:
 190
 191
 192 <!-- ##### FUNCTION gtk_recent_chooser_set_select_multiple ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @chooser:
 198 @select_multiple:
 199
 200
 201 <!-- ##### FUNCTION gtk_recent_chooser_get_select_multiple ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @chooser:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION gtk_recent_chooser_set_local_only ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @chooser:
 216 @local_only:
 217
 218
 219 <!-- ##### FUNCTION gtk_recent_chooser_get_local_only ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @chooser:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION gtk_recent_chooser_set_limit ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @chooser:
 234 @limit:
 235
 236
 237 <!-- ##### FUNCTION gtk_recent_chooser_get_limit ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @chooser:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION gtk_recent_chooser_set_show_tips ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @chooser:
 252 @show_tips:
 253
 254
 255 <!-- ##### FUNCTION gtk_recent_chooser_get_show_tips ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @chooser:
 261 @Returns:
 262
 263
 264 <!-- ##### ENUM GtkRecentSortType ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @GTK_RECENT_SORT_NONE:
 270 @GTK_RECENT_SORT_MRU:
 271 @GTK_RECENT_SORT_LRU:
 272 @GTK_RECENT_SORT_CUSTOM:
 273
 274 <!-- ##### FUNCTION gtk_recent_chooser_set_sort_type ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @chooser:
 280 @sort_type:
 281
 282
 283 <!-- ##### FUNCTION gtk_recent_chooser_get_sort_type ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @chooser:
 289 @Returns:
 290
 291
 292 <!-- ##### USER_FUNCTION GtkRecentSortFunc ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @a:
 298 @b:
 299 @user_data:
 300 @Returns:
 301
 302
 303 <!-- ##### FUNCTION gtk_recent_chooser_set_sort_func ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @chooser:
 309 @sort_func:
 310 @sort_data:
 311 @data_destroy:
 312
 313
 314 <!-- ##### FUNCTION gtk_recent_chooser_set_current_uri ##### -->
 315 <para>
 316
 317 </para>
 318
 319 @chooser:
 320 @uri:
 321 @error:
 322 @Returns:
 323
 324
 325 <!-- ##### FUNCTION gtk_recent_chooser_get_current_uri ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @chooser:
 331 @Returns:
 332
 333
 334 <!-- ##### FUNCTION gtk_recent_chooser_get_current_item ##### -->
 335 <para>
 336
 337 </para>
 338
 339 @chooser:
 340 @Returns:
 341
 342
 343 <!-- ##### FUNCTION gtk_recent_chooser_select_uri ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @chooser:
 349 @uri:
 350 @error:
 351 @Returns:
 352
 353
 354 <!-- ##### FUNCTION gtk_recent_chooser_unselect_uri ##### -->
 355 <para>
 356
 357 </para>
 358
 359 @chooser:
 360 @uri:
 361
 362
 363 <!-- ##### FUNCTION gtk_recent_chooser_select_all ##### -->
 364 <para>
 365
 366 </para>
 367
 368 @chooser:
 369
 370
 371 <!-- ##### FUNCTION gtk_recent_chooser_unselect_all ##### -->
 372 <para>
 373
 374 </para>
 375
 376 @chooser:
 377
 378
 379 <!-- ##### FUNCTION gtk_recent_chooser_get_items ##### -->
 380 <para>
 381
 382 </para>
 383
 384 @chooser:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION gtk_recent_chooser_get_uris ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @chooser:
 394 @length:
 395 @Returns:
 396
 397
 398 <!-- ##### FUNCTION gtk_recent_chooser_add_filter ##### -->
 399 <para>
 400
 401 </para>
 402
 403 @chooser:
 404 @filter:
 405
 406
 407 <!-- ##### FUNCTION gtk_recent_chooser_remove_filter ##### -->
 408 <para>
 409
 410 </para>
 411
 412 @chooser:
 413 @filter:
 414
 415
 416 <!-- ##### FUNCTION gtk_recent_chooser_list_filters ##### -->
 417 <para>
 418
 419 </para>
 420
 421 @chooser:
 422 @Returns:
 423
 424
 425 <!-- ##### FUNCTION gtk_recent_chooser_set_filter ##### -->
 426 <para>
 427
 428 </para>
 429
 430 @chooser:
 431 @filter:
 432
 433
 434 <!-- ##### FUNCTION gtk_recent_chooser_get_filter ##### -->
 435 <para>
 436
 437 </para>
 438
 439 @chooser:
 440 @Returns:
 441
 442