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