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-padding ##### -->
 113 <para>
 114
 115 </para>
 116
 117 <!-- ##### ARG GtkIconView:item-width ##### -->
 118 <para>
 119
 120 </para>
 121
 122 <!-- ##### ARG GtkIconView:margin ##### -->
 123 <para>
 124
 125 </para>
 126
 127 <!-- ##### ARG GtkIconView:markup-column ##### -->
 128 <para>
 129
 130 </para>
 131
 132 <!-- ##### ARG GtkIconView:model ##### -->
 133 <para>
 134
 135 </para>
 136
 137 <!-- ##### ARG GtkIconView:orientation ##### -->
 138 <para>
 139
 140 </para>
 141
 142 <!-- ##### ARG GtkIconView:pixbuf-column ##### -->
 143 <para>
 144
 145 </para>
 146
 147 <!-- ##### ARG GtkIconView:reorderable ##### -->
 148 <para>
 149
 150 </para>
 151
 152 <!-- ##### ARG GtkIconView:row-spacing ##### -->
 153 <para>
 154
 155 </para>
 156
 157 <!-- ##### ARG GtkIconView:selection-mode ##### -->
 158 <para>
 159
 160 </para>
 161
 162 <!-- ##### ARG GtkIconView:spacing ##### -->
 163 <para>
 164
 165 </para>
 166
 167 <!-- ##### ARG GtkIconView:text-column ##### -->
 168 <para>
 169
 170 </para>
 171
 172 <!-- ##### ARG GtkIconView:tooltip-column ##### -->
 173 <para>
 174
 175 </para>
 176
 177 <!-- ##### ARG GtkIconView:selection-box-alpha ##### -->
 178 <para>
 179
 180 </para>
 181
 182 <!-- ##### ARG GtkIconView:selection-box-color ##### -->
 183 <para>
 184
 185 </para>
 186
 187 <!-- ##### USER_FUNCTION GtkIconViewForeachFunc ##### -->
 188 <para>
 189 A function used by gtk_icon_view_selected_foreach() to map all
 190 selected rows.  It will be called on every selected row in the view.
 191 </para>
 192
 193 @icon_view: a #GtkIconView
 194 @path: The #GtkTreePath of a selected row
 195 @data: user data
 196
 197
 198 <!-- ##### FUNCTION gtk_icon_view_new ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION gtk_icon_view_new_with_model ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @model:
 212 @Returns:
 213
 214
 215 <!-- ##### FUNCTION gtk_icon_view_set_model ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @icon_view:
 221 @model:
 222
 223
 224 <!-- ##### FUNCTION gtk_icon_view_get_model ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @icon_view:
 230 @Returns:
 231
 232
 233 <!-- ##### FUNCTION gtk_icon_view_set_text_column ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @icon_view:
 239 @column:
 240
 241
 242 <!-- ##### FUNCTION gtk_icon_view_get_text_column ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @icon_view:
 248 @Returns:
 249
 250
 251 <!-- ##### FUNCTION gtk_icon_view_set_markup_column ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @icon_view:
 257 @column:
 258
 259
 260 <!-- ##### FUNCTION gtk_icon_view_get_markup_column ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @icon_view:
 266 @Returns:
 267
 268
 269 <!-- ##### FUNCTION gtk_icon_view_set_pixbuf_column ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @icon_view:
 275 @column:
 276
 277
 278 <!-- ##### FUNCTION gtk_icon_view_get_pixbuf_column ##### -->
 279 <para>
 280
 281 </para>
 282
 283 @icon_view:
 284 @Returns:
 285
 286
 287 <!-- ##### FUNCTION gtk_icon_view_get_path_at_pos ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @icon_view:
 293 @x:
 294 @y:
 295 @Returns:
 296
 297
 298 <!-- ##### FUNCTION gtk_icon_view_get_item_at_pos ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @icon_view:
 304 @x:
 305 @y:
 306 @path:
 307 @cell:
 308 @Returns:
 309
 310
 311 <!-- ##### FUNCTION gtk_icon_view_convert_widget_to_bin_window_coords ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @icon_view:
 317 @wx:
 318 @wy:
 319 @bx:
 320 @by:
 321
 322
 323 <!-- ##### FUNCTION gtk_icon_view_set_cursor ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @icon_view:
 329 @path:
 330 @cell:
 331 @start_editing:
 332
 333
 334 <!-- ##### FUNCTION gtk_icon_view_get_cursor ##### -->
 335 <para>
 336
 337 </para>
 338
 339 @icon_view:
 340 @path:
 341 @cell:
 342 @Returns:
 343
 344
 345 <!-- ##### FUNCTION gtk_icon_view_selected_foreach ##### -->
 346 <para>
 347
 348 </para>
 349
 350 @icon_view:
 351 @func:
 352 @data:
 353
 354
 355 <!-- ##### FUNCTION gtk_icon_view_set_selection_mode ##### -->
 356 <para>
 357
 358 </para>
 359
 360 @icon_view:
 361 @mode:
 362
 363
 364 <!-- ##### FUNCTION gtk_icon_view_get_selection_mode ##### -->
 365 <para>
 366
 367 </para>
 368
 369 @icon_view:
 370 @Returns:
 371
 372
 373 <!-- ##### FUNCTION gtk_icon_view_set_orientation ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @icon_view:
 379 @orientation:
 380
 381
 382 <!-- ##### FUNCTION gtk_icon_view_get_orientation ##### -->
 383 <para>
 384
 385 </para>
 386
 387 @icon_view:
 388 @Returns:
 389
 390
 391 <!-- ##### FUNCTION gtk_icon_view_set_columns ##### -->
 392 <para>
 393
 394 </para>
 395
 396 @icon_view:
 397 @columns:
 398
 399
 400 <!-- ##### FUNCTION gtk_icon_view_get_columns ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @icon_view:
 406 @Returns:
 407
 408
 409 <!-- ##### FUNCTION gtk_icon_view_set_item_width ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @icon_view:
 415 @item_width:
 416
 417
 418 <!-- ##### FUNCTION gtk_icon_view_get_item_width ##### -->
 419 <para>
 420
 421 </para>
 422
 423 @icon_view:
 424 @Returns:
 425
 426
 427 <!-- ##### FUNCTION gtk_icon_view_set_spacing ##### -->
 428 <para>
 429
 430 </para>
 431
 432 @icon_view:
 433 @spacing:
 434
 435
 436 <!-- ##### FUNCTION gtk_icon_view_get_spacing ##### -->
 437 <para>
 438
 439 </para>
 440
 441 @icon_view:
 442 @Returns:
 443
 444
 445 <!-- ##### FUNCTION gtk_icon_view_set_row_spacing ##### -->
 446 <para>
 447
 448 </para>
 449
 450 @icon_view:
 451 @row_spacing:
 452
 453
 454 <!-- ##### FUNCTION gtk_icon_view_get_row_spacing ##### -->
 455 <para>
 456
 457 </para>
 458
 459 @icon_view:
 460 @Returns:
 461
 462
 463 <!-- ##### FUNCTION gtk_icon_view_set_column_spacing ##### -->
 464 <para>
 465
 466 </para>
 467
 468 @icon_view:
 469 @column_spacing:
 470
 471
 472 <!-- ##### FUNCTION gtk_icon_view_get_column_spacing ##### -->
 473 <para>
 474
 475 </para>
 476
 477 @icon_view:
 478 @Returns:
 479
 480
 481 <!-- ##### FUNCTION gtk_icon_view_set_margin ##### -->
 482 <para>
 483
 484 </para>
 485
 486 @icon_view:
 487 @margin:
 488
 489
 490 <!-- ##### FUNCTION gtk_icon_view_get_margin ##### -->
 491 <para>
 492
 493 </para>
 494
 495 @icon_view:
 496 @Returns:
 497
 498
 499 <!-- ##### FUNCTION gtk_icon_view_set_item_padding ##### -->
 500 <para>
 501
 502 </para>
 503
 504 @icon_view:
 505 @item_padding:
 506
 507
 508 <!-- ##### FUNCTION gtk_icon_view_get_item_padding ##### -->
 509 <para>
 510
 511 </para>
 512
 513 @icon_view:
 514 @Returns:
 515
 516
 517 <!-- ##### FUNCTION gtk_icon_view_select_path ##### -->
 518 <para>
 519
 520 </para>
 521
 522 @icon_view:
 523 @path:
 524
 525
 526 <!-- ##### FUNCTION gtk_icon_view_unselect_path ##### -->
 527 <para>
 528
 529 </para>
 530
 531 @icon_view:
 532 @path:
 533
 534
 535 <!-- ##### FUNCTION gtk_icon_view_path_is_selected ##### -->
 536 <para>
 537
 538 </para>
 539
 540 @icon_view:
 541 @path:
 542 @Returns:
 543
 544
 545 <!-- ##### FUNCTION gtk_icon_view_get_selected_items ##### -->
 546 <para>
 547
 548 </para>
 549
 550 @icon_view:
 551 @Returns:
 552
 553
 554 <!-- ##### FUNCTION gtk_icon_view_select_all ##### -->
 555 <para>
 556
 557 </para>
 558
 559 @icon_view:
 560
 561
 562 <!-- ##### FUNCTION gtk_icon_view_unselect_all ##### -->
 563 <para>
 564
 565 </para>
 566
 567 @icon_view:
 568
 569
 570 <!-- ##### FUNCTION gtk_icon_view_item_activated ##### -->
 571 <para>
 572
 573 </para>
 574
 575 @icon_view:
 576 @path:
 577
 578
 579 <!-- ##### FUNCTION gtk_icon_view_scroll_to_path ##### -->
 580 <para>
 581
 582 </para>
 583
 584 @icon_view:
 585 @path:
 586 @use_align:
 587 @row_align:
 588 @col_align:
 589
 590
 591 <!-- ##### FUNCTION gtk_icon_view_get_visible_range ##### -->
 592 <para>
 593
 594 </para>
 595
 596 @icon_view:
 597 @start_path:
 598 @end_path:
 599 @Returns:
 600
 601
 602 <!-- ##### FUNCTION gtk_icon_view_set_tooltip_item ##### -->
 603 <para>
 604
 605 </para>
 606
 607 @icon_view:
 608 @tooltip:
 609 @path:
 610
 611
 612 <!-- ##### FUNCTION gtk_icon_view_set_tooltip_cell ##### -->
 613 <para>
 614
 615 </para>
 616
 617 @icon_view:
 618 @tooltip:
 619 @path:
 620 @cell:
 621
 622
 623 <!-- ##### FUNCTION gtk_icon_view_get_tooltip_context ##### -->
 624 <para>
 625
 626 </para>
 627
 628 @icon_view:
 629 @x:
 630 @y:
 631 @keyboard_tip:
 632 @model:
 633 @path:
 634 @iter:
 635 @Returns:
 636
 637
 638 <!-- ##### FUNCTION gtk_icon_view_set_tooltip_column ##### -->
 639 <para>
 640
 641 </para>
 642
 643 @icon_view:
 644 @column:
 645
 646
 647 <!-- ##### FUNCTION gtk_icon_view_get_tooltip_column ##### -->
 648 <para>
 649
 650 </para>
 651
 652 @icon_view:
 653 @Returns:
 654
 655
 656 <!-- ##### ENUM GtkIconViewDropPosition ##### -->
 657 <para>
 658 An enum for determining where a dropped item goes.
 659 </para>
 660
 661 @GTK_ICON_VIEW_NO_DROP: no drop possible
 662 @GTK_ICON_VIEW_DROP_INTO: dropped item replaces the item
 663 @GTK_ICON_VIEW_DROP_LEFT: droppped item is inserted to the left
 664 @GTK_ICON_VIEW_DROP_RIGHT: dropped item is inserted to the right
 665 @GTK_ICON_VIEW_DROP_ABOVE: dropped item is inserted above
 666 @GTK_ICON_VIEW_DROP_BELOW: dropped item is inserted below
 667
 668 <!-- ##### FUNCTION gtk_icon_view_enable_model_drag_source ##### -->
 669 <para>
 670
 671 </para>
 672
 673 @icon_view:
 674 @start_button_mask:
 675 @targets:
 676 @n_targets:
 677 @actions:
 678
 679
 680 <!-- ##### FUNCTION gtk_icon_view_enable_model_drag_dest ##### -->
 681 <para>
 682
 683 </para>
 684
 685 @icon_view:
 686 @targets:
 687 @n_targets:
 688 @actions:
 689
 690
 691 <!-- ##### FUNCTION gtk_icon_view_unset_model_drag_source ##### -->
 692 <para>
 693
 694 </para>
 695
 696 @icon_view:
 697
 698
 699 <!-- ##### FUNCTION gtk_icon_view_unset_model_drag_dest ##### -->
 700 <para>
 701
 702 </para>
 703
 704 @icon_view:
 705
 706
 707 <!-- ##### FUNCTION gtk_icon_view_set_reorderable ##### -->
 708 <para>
 709
 710 </para>
 711
 712 @icon_view:
 713 @reorderable:
 714
 715
 716 <!-- ##### FUNCTION gtk_icon_view_get_reorderable ##### -->
 717 <para>
 718
 719 </para>
 720
 721 @icon_view:
 722 @Returns:
 723
 724
 725 <!-- ##### FUNCTION gtk_icon_view_set_drag_dest_item ##### -->
 726 <para>
 727
 728 </para>
 729
 730 @icon_view:
 731 @path:
 732 @pos:
 733
 734
 735 <!-- ##### FUNCTION gtk_icon_view_get_drag_dest_item ##### -->
 736 <para>
 737
 738 </para>
 739
 740 @icon_view:
 741 @path:
 742 @pos:
 743
 744
 745 <!-- ##### FUNCTION gtk_icon_view_get_dest_item_at_pos ##### -->
 746 <para>
 747
 748 </para>
 749
 750 @icon_view:
 751 @drag_x:
 752 @drag_y:
 753 @path:
 754 @pos:
 755 @Returns:
 756
 757
 758 <!-- ##### FUNCTION gtk_icon_view_create_drag_icon ##### -->
 759 <para>
 760
 761 </para>
 762
 763 @icon_view:
 764 @path:
 765 @Returns:
 766
 767