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