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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkIconView
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget which displays a list of icons in a grid
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #GtkIconView provides an alternative view on a list model.
  10 It displays the model as a grid of icons with labels. Like
  11 #GtkTreeView, it allows to select one or multiple items
  12 (depending on the selection mode, see gtk_icon_view_set_selection_mode()).
  13 In addition to selection with the arrow keys, #GtkIconView supports
  14 rubberband selection, which is controlled by dragging the pointer.
  15 </para>
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18 <para>
  19
  20 </para>
  21
  22 <!-- ##### SECTION Stability_Level ##### -->
  23
  24
  25 <!-- ##### STRUCT GtkIconView ##### -->
  26 <para>
  27 The <structname>GtkIconView</structname> struct contains only
  28 private fields and should not be directly accessed.
  29 </para>
  30
  31
  32 <!-- ##### SIGNAL GtkIconView::activate-cursor-item ##### -->
  33 <para>
  34
  35 </para>
  36
  37 @iconview: the object which received the signal.
  38 @Returns:
  39
  40 <!-- ##### SIGNAL GtkIconView::item-activated ##### -->
  41 <para>
  42
  43 </para>
  44
  45 @iconview: the object which received the signal.
  46 @arg1:
  47
  48 <!-- ##### SIGNAL GtkIconView::move-cursor ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @iconview: the object which received the signal.
  54 @arg1:
  55 @arg2:
  56 @Returns:
  57
  58 <!-- ##### SIGNAL GtkIconView::select-all ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @iconview: the object which received the signal.
  64
  65 <!-- ##### SIGNAL GtkIconView::select-cursor-item ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @iconview: the object which received the signal.
  71
  72 <!-- ##### SIGNAL GtkIconView::selection-changed ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @iconview: the object which received the signal.
  78
  79 <!-- ##### SIGNAL GtkIconView::set-scroll-adjustments ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @iconview: the object which received the signal.
  85 @arg1:
  86 @arg2:
  87
  88 <!-- ##### SIGNAL GtkIconView::toggle-cursor-item ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @iconview: the object which received the signal.
  94
  95 <!-- ##### SIGNAL GtkIconView::unselect-all ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @iconview: the object which received the signal.
 101
 102 <!-- ##### ARG GtkIconView:column-spacing ##### -->
 103 <para>
 104
 105 </para>
 106
 107 <!-- ##### ARG GtkIconView:columns ##### -->
 108 <para>
 109
 110 </para>
 111
 112 <!-- ##### ARG GtkIconView:item-width ##### -->
 113 <para>
 114
 115 </para>
 116
 117 <!-- ##### ARG GtkIconView:margin ##### -->
 118 <para>
 119
 120 </para>
 121
 122 <!-- ##### ARG GtkIconView:markup-column ##### -->
 123 <para>
 124
 125 </para>
 126
 127 <!-- ##### ARG GtkIconView:model ##### -->
 128 <para>
 129
 130 </para>
 131
 132 <!-- ##### ARG GtkIconView:orientation ##### -->
 133 <para>
 134
 135 </para>
 136
 137 <!-- ##### ARG GtkIconView:pixbuf-column ##### -->
 138 <para>
 139
 140 </para>
 141
 142 <!-- ##### ARG GtkIconView:reorderable ##### -->
 143 <para>
 144
 145 </para>
 146
 147 <!-- ##### ARG GtkIconView:row-spacing ##### -->
 148 <para>
 149
 150 </para>
 151
 152 <!-- ##### ARG GtkIconView:selection-mode ##### -->
 153 <para>
 154
 155 </para>
 156
 157 <!-- ##### ARG GtkIconView:spacing ##### -->
 158 <para>
 159
 160 </para>
 161
 162 <!-- ##### ARG GtkIconView:text-column ##### -->
 163 <para>
 164
 165 </para>
 166
 167 <!-- ##### ARG GtkIconView:selection-box-alpha ##### -->
 168 <para>
 169
 170 </para>
 171
 172 <!-- ##### ARG GtkIconView:selection-box-color ##### -->
 173 <para>
 174
 175 </para>
 176
 177 <!-- ##### USER_FUNCTION GtkIconViewForeachFunc ##### -->
 178 <para>
 179 A function used by gtk_icon_view_selected_foreach() to map all
 180 selected rows.  It will be called on every selected row in the view.
 181 </para>
 182
 183 @icon_view: a #GtkIconView
 184 @path: The #GtkTreePath of a selected row
 185 @data: user data
 186
 187
 188 <!-- ##### FUNCTION gtk_icon_view_new ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @Returns:
 194
 195
 196 <!-- ##### FUNCTION gtk_icon_view_new_with_model ##### -->
 197 <para>
 198
 199 </para>
 200
 201 @model:
 202 @Returns:
 203
 204
 205 <!-- ##### FUNCTION gtk_icon_view_set_model ##### -->
 206 <para>
 207
 208 </para>
 209
 210 @icon_view:
 211 @model:
 212
 213
 214 <!-- ##### FUNCTION gtk_icon_view_get_model ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @icon_view:
 220 @Returns:
 221
 222
 223 <!-- ##### FUNCTION gtk_icon_view_set_text_column ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @icon_view:
 229 @column:
 230
 231
 232 <!-- ##### FUNCTION gtk_icon_view_get_text_column ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @icon_view:
 238 @Returns:
 239
 240
 241 <!-- ##### FUNCTION gtk_icon_view_set_markup_column ##### -->
 242 <para>
 243
 244 </para>
 245
 246 @icon_view:
 247 @column:
 248
 249
 250 <!-- ##### FUNCTION gtk_icon_view_get_markup_column ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @icon_view:
 256 @Returns:
 257
 258
 259 <!-- ##### FUNCTION gtk_icon_view_set_pixbuf_column ##### -->
 260 <para>
 261
 262 </para>
 263
 264 @icon_view:
 265 @column:
 266
 267
 268 <!-- ##### FUNCTION gtk_icon_view_get_pixbuf_column ##### -->
 269 <para>
 270
 271 </para>
 272
 273 @icon_view:
 274 @Returns:
 275
 276
 277 <!-- ##### FUNCTION gtk_icon_view_get_path_at_pos ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @icon_view:
 283 @x:
 284 @y:
 285 @Returns:
 286
 287
 288 <!-- ##### FUNCTION gtk_icon_view_get_item_at_pos ##### -->
 289 <para>
 290
 291 </para>
 292
 293 @icon_view:
 294 @x:
 295 @y:
 296 @path:
 297 @cell:
 298 @Returns:
 299
 300
 301 <!-- ##### FUNCTION gtk_icon_view_set_cursor ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @icon_view:
 307 @path:
 308 @cell:
 309 @start_editing:
 310
 311
 312 <!-- ##### FUNCTION gtk_icon_view_get_cursor ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @icon_view:
 318 @path:
 319 @cell:
 320 @Returns:
 321
 322
 323 <!-- ##### FUNCTION gtk_icon_view_selected_foreach ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @icon_view:
 329 @func:
 330 @data:
 331
 332
 333 <!-- ##### FUNCTION gtk_icon_view_set_selection_mode ##### -->
 334 <para>
 335
 336 </para>
 337
 338 @icon_view:
 339 @mode:
 340
 341
 342 <!-- ##### FUNCTION gtk_icon_view_get_selection_mode ##### -->
 343 <para>
 344
 345 </para>
 346
 347 @icon_view:
 348 @Returns:
 349
 350
 351 <!-- ##### FUNCTION gtk_icon_view_set_orientation ##### -->
 352 <para>
 353
 354 </para>
 355
 356 @icon_view:
 357 @orientation:
 358
 359
 360 <!-- ##### FUNCTION gtk_icon_view_get_orientation ##### -->
 361 <para>
 362
 363 </para>
 364
 365 @icon_view:
 366 @Returns:
 367
 368
 369 <!-- ##### FUNCTION gtk_icon_view_set_columns ##### -->
 370 <para>
 371
 372 </para>
 373
 374 @icon_view:
 375 @columns:
 376
 377
 378 <!-- ##### FUNCTION gtk_icon_view_get_columns ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @icon_view:
 384 @Returns:
 385
 386
 387 <!-- ##### FUNCTION gtk_icon_view_set_item_width ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @icon_view:
 393 @item_width:
 394
 395
 396 <!-- ##### FUNCTION gtk_icon_view_get_item_width ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @icon_view:
 402 @Returns:
 403
 404
 405 <!-- ##### FUNCTION gtk_icon_view_set_spacing ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @icon_view:
 411 @spacing:
 412
 413
 414 <!-- ##### FUNCTION gtk_icon_view_get_spacing ##### -->
 415 <para>
 416
 417 </para>
 418
 419 @icon_view:
 420 @Returns:
 421
 422
 423 <!-- ##### FUNCTION gtk_icon_view_set_row_spacing ##### -->
 424 <para>
 425
 426 </para>
 427
 428 @icon_view:
 429 @row_spacing:
 430
 431
 432 <!-- ##### FUNCTION gtk_icon_view_get_row_spacing ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @icon_view:
 438 @Returns:
 439
 440
 441 <!-- ##### FUNCTION gtk_icon_view_set_column_spacing ##### -->
 442 <para>
 443
 444 </para>
 445
 446 @icon_view:
 447 @column_spacing:
 448
 449
 450 <!-- ##### FUNCTION gtk_icon_view_get_column_spacing ##### -->
 451 <para>
 452
 453 </para>
 454
 455 @icon_view:
 456 @Returns:
 457
 458
 459 <!-- ##### FUNCTION gtk_icon_view_set_margin ##### -->
 460 <para>
 461
 462 </para>
 463
 464 @icon_view:
 465 @margin:
 466
 467
 468 <!-- ##### FUNCTION gtk_icon_view_get_margin ##### -->
 469 <para>
 470
 471 </para>
 472
 473 @icon_view:
 474 @Returns:
 475
 476
 477 <!-- ##### FUNCTION gtk_icon_view_select_path ##### -->
 478 <para>
 479
 480 </para>
 481
 482 @icon_view:
 483 @path:
 484
 485
 486 <!-- ##### FUNCTION gtk_icon_view_unselect_path ##### -->
 487 <para>
 488
 489 </para>
 490
 491 @icon_view:
 492 @path:
 493
 494
 495 <!-- ##### FUNCTION gtk_icon_view_path_is_selected ##### -->
 496 <para>
 497
 498 </para>
 499
 500 @icon_view:
 501 @path:
 502 @Returns:
 503
 504
 505 <!-- ##### FUNCTION gtk_icon_view_get_selected_items ##### -->
 506 <para>
 507
 508 </para>
 509
 510 @icon_view:
 511 @Returns:
 512
 513
 514 <!-- ##### FUNCTION gtk_icon_view_select_all ##### -->
 515 <para>
 516
 517 </para>
 518
 519 @icon_view:
 520
 521
 522 <!-- ##### FUNCTION gtk_icon_view_unselect_all ##### -->
 523 <para>
 524
 525 </para>
 526
 527 @icon_view:
 528
 529
 530 <!-- ##### FUNCTION gtk_icon_view_item_activated ##### -->
 531 <para>
 532
 533 </para>
 534
 535 @icon_view:
 536 @path:
 537
 538
 539 <!-- ##### FUNCTION gtk_icon_view_scroll_to_path ##### -->
 540 <para>
 541
 542 </para>
 543
 544 @icon_view:
 545 @path:
 546 @use_align:
 547 @row_align:
 548 @col_align:
 549
 550
 551 <!-- ##### FUNCTION gtk_icon_view_get_visible_range ##### -->
 552 <para>
 553
 554 </para>
 555
 556 @icon_view:
 557 @start_path:
 558 @end_path:
 559 @Returns:
 560
 561
 562 <!-- ##### ENUM GtkIconViewDropPosition ##### -->
 563 <para>
 564 An enum for determining where a dropped item goes.
 565 </para>
 566
 567 @GTK_ICON_VIEW_NO_DROP: no drop possible
 568 @GTK_ICON_VIEW_DROP_INTO: dropped item replaces the item
 569 @GTK_ICON_VIEW_DROP_LEFT: droppped item is inserted to the left
 570 @GTK_ICON_VIEW_DROP_RIGHT: dropped item is inserted to the right
 571 @GTK_ICON_VIEW_DROP_ABOVE: dropped item is inserted above
 572 @GTK_ICON_VIEW_DROP_BELOW: dropped item is inserted below
 573
 574 <!-- ##### FUNCTION gtk_icon_view_enable_model_drag_source ##### -->
 575 <para>
 576
 577 </para>
 578
 579 @icon_view:
 580 @start_button_mask:
 581 @targets:
 582 @n_targets:
 583 @actions:
 584
 585
 586 <!-- ##### FUNCTION gtk_icon_view_enable_model_drag_dest ##### -->
 587 <para>
 588
 589 </para>
 590
 591 @icon_view:
 592 @targets:
 593 @n_targets:
 594 @actions:
 595
 596
 597 <!-- ##### FUNCTION gtk_icon_view_unset_model_drag_source ##### -->
 598 <para>
 599
 600 </para>
 601
 602 @icon_view:
 603
 604
 605 <!-- ##### FUNCTION gtk_icon_view_unset_model_drag_dest ##### -->
 606 <para>
 607
 608 </para>
 609
 610 @icon_view:
 611
 612
 613 <!-- ##### FUNCTION gtk_icon_view_set_reorderable ##### -->
 614 <para>
 615
 616 </para>
 617
 618 @icon_view:
 619 @reorderable:
 620
 621
 622 <!-- ##### FUNCTION gtk_icon_view_get_reorderable ##### -->
 623 <para>
 624
 625 </para>
 626
 627 @icon_view:
 628 @Returns:
 629
 630
 631 <!-- ##### FUNCTION gtk_icon_view_set_drag_dest_item ##### -->
 632 <para>
 633
 634 </para>
 635
 636 @icon_view:
 637 @path:
 638 @pos:
 639
 640
 641 <!-- ##### FUNCTION gtk_icon_view_get_drag_dest_item ##### -->
 642 <para>
 643
 644 </para>
 645
 646 @icon_view:
 647 @path:
 648 @pos:
 649
 650
 651 <!-- ##### FUNCTION gtk_icon_view_get_dest_item_at_pos ##### -->
 652 <para>
 653
 654 </para>
 655
 656 @icon_view:
 657 @drag_x:
 658 @drag_y:
 659 @path:
 660 @pos:
 661 @Returns:
 662
 663
 664 <!-- ##### FUNCTION gtk_icon_view_create_drag_icon ##### -->
 665 <para>
 666
 667 </para>
 668
 669 @icon_view:
 670 @path:
 671 @Returns:
 672
 673