gtkiconview.sgml 8.77 KB
Newer Older
1 2 3 4 5 6 7 8
<!-- ##### SECTION Title ##### -->
GtkIconView

<!-- ##### SECTION Short_Description ##### -->
A widget which displays a list of icons in a grid

<!-- ##### SECTION Long_Description ##### -->
<para>
Matthias Clasen's avatar
Updates  
Matthias Clasen committed
9 10 11 12 13 14
#GtkIconView provides an alternative view on a list model. 
It displays the model as a grid of icons with labels. Like 
#GtkTreeView, it allows to select one or multiple items 
(depending on the selection mode, see gtk_icon_view_set_selection_mode()).
In addition to selection with the arrow keys, #GtkIconView supports
rubberband selection, which is controlled by dragging the pointer.
15 16 17 18 19 20 21
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
22 23 24
<!-- ##### SECTION Stability_Level ##### -->


25 26
<!-- ##### STRUCT GtkIconView ##### -->
<para>
Matthias Clasen's avatar
Updates  
Matthias Clasen committed
27 28
The <structname>GtkIconView</structname> struct contains only
private fields and should not be directly accessed.
29 30 31
</para>


Soeren Sandmann's avatar
Soeren Sandmann committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
<!-- ##### SIGNAL GtkIconView::activate-cursor-item ##### -->
<para>

</para>

@iconview: the object which received the signal.
@Returns: 

<!-- ##### SIGNAL GtkIconView::item-activated ##### -->
<para>

</para>

@iconview: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL GtkIconView::move-cursor ##### -->
<para>

</para>

@iconview: the object which received the signal.
@arg1: 
@arg2: 
@Returns: 

<!-- ##### SIGNAL GtkIconView::select-all ##### -->
<para>

</para>

@iconview: the object which received the signal.

<!-- ##### SIGNAL GtkIconView::select-cursor-item ##### -->
<para>

</para>

@iconview: the object which received the signal.

<!-- ##### SIGNAL GtkIconView::selection-changed ##### -->
<para>

</para>

@iconview: the object which received the signal.

<!-- ##### SIGNAL GtkIconView::set-scroll-adjustments ##### -->
<para>

</para>

@iconview: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL GtkIconView::toggle-cursor-item ##### -->
<para>

</para>

@iconview: the object which received the signal.

<!-- ##### SIGNAL GtkIconView::unselect-all ##### -->
<para>

</para>

@iconview: the object which received the signal.

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
<!-- ##### ARG GtkIconView:column-spacing ##### -->
<para>

</para>

<!-- ##### ARG GtkIconView:columns ##### -->
<para>

</para>

<!-- ##### ARG GtkIconView:item-width ##### -->
<para>

</para>

<!-- ##### ARG GtkIconView:margin ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
<!-- ##### ARG GtkIconView:markup-column ##### -->
<para>

</para>

<!-- ##### ARG GtkIconView:model ##### -->
<para>

</para>

<!-- ##### ARG GtkIconView:orientation ##### -->
<para>

</para>

<!-- ##### ARG GtkIconView:pixbuf-column ##### -->
<para>

</para>

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
142 143 144 145 146
<!-- ##### ARG GtkIconView:reorderable ##### -->
<para>

</para>

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
147 148 149 150 151
<!-- ##### ARG GtkIconView:row-spacing ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
152 153 154 155 156
<!-- ##### ARG GtkIconView:selection-mode ##### -->
<para>

</para>

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
157 158 159 160 161
<!-- ##### ARG GtkIconView:spacing ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
<!-- ##### ARG GtkIconView:text-column ##### -->
<para>

</para>

<!-- ##### ARG GtkIconView:selection-box-alpha ##### -->
<para>

</para>

<!-- ##### ARG GtkIconView:selection-box-color ##### -->
<para>

</para>

177
<!-- ##### USER_FUNCTION GtkIconViewForeachFunc ##### -->
178
<para>
179 180
A function used by gtk_icon_view_selected_foreach() to map all
selected rows.  It will be called on every selected row in the view.
181 182
</para>

183 184 185 186 187
@icon_view: 
@path: The #GtkTreePath of a selected row
@data: user data
<!-- # Unused Parameters # -->
@model: The #GtkTreeModel being viewed
188

189 190

<!-- ##### FUNCTION gtk_icon_view_new ##### -->
191 192 193 194 195 196
<para>

</para>

@Returns: 

197 198

<!-- ##### FUNCTION gtk_icon_view_new_with_model ##### -->
199 200 201 202
<para>

</para>

203 204
@model: 
@Returns: 
205

206 207

<!-- ##### FUNCTION gtk_icon_view_set_model ##### -->
208 209 210 211
<para>

</para>

212 213
@icon_view: 
@model: 
214

215 216

<!-- ##### FUNCTION gtk_icon_view_get_model ##### -->
217 218 219 220
<para>

</para>

221 222
@icon_view: 
@Returns: 
223

224 225

<!-- ##### FUNCTION gtk_icon_view_set_text_column ##### -->
226 227 228 229
<para>

</para>

230 231
@icon_view: 
@column: 
232

233 234

<!-- ##### FUNCTION gtk_icon_view_get_text_column ##### -->
235 236 237 238
<para>

</para>

239 240
@icon_view: 
@Returns: 
241

242 243

<!-- ##### FUNCTION gtk_icon_view_set_markup_column ##### -->
244 245 246 247
<para>

</para>

248 249
@icon_view: 
@column: 
250 251


252
<!-- ##### FUNCTION gtk_icon_view_get_markup_column ##### -->
253 254 255 256
<para>

</para>

257 258
@icon_view: 
@Returns: 
259 260


261
<!-- ##### FUNCTION gtk_icon_view_set_pixbuf_column ##### -->
262 263 264 265
<para>

</para>

266 267
@icon_view: 
@column: 
268 269


270
<!-- ##### FUNCTION gtk_icon_view_get_pixbuf_column ##### -->
271 272 273 274
<para>

</para>

275 276
@icon_view: 
@Returns: 
277 278


279
<!-- ##### FUNCTION gtk_icon_view_get_path_at_pos ##### -->
280 281 282 283
<para>

</para>

284 285 286 287
@icon_view: 
@x: 
@y: 
@Returns: 
288

289

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
<!-- ##### FUNCTION gtk_icon_view_get_item_at_pos ##### -->
<para>

</para>

@icon_view: 
@x: 
@y: 
@path: 
@cell: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_view_set_cursor ##### -->
<para>

</para>

@icon_view: 
@path: 
@cell: 
@start_editing: 


<!-- ##### FUNCTION gtk_icon_view_get_cursor ##### -->
<para>

</para>

@icon_view: 
@path: 
@cell: 
@Returns: 


325
<!-- ##### FUNCTION gtk_icon_view_selected_foreach ##### -->
326
<para>
327

328 329
</para>

330 331 332
@icon_view: 
@func: 
@data: 
333 334


335
<!-- ##### FUNCTION gtk_icon_view_set_selection_mode ##### -->
336 337 338 339
<para>

</para>

340 341
@icon_view: 
@mode: 
342 343


344
<!-- ##### FUNCTION gtk_icon_view_get_selection_mode ##### -->
345 346 347 348
<para>

</para>

349
@icon_view: 
350 351 352
@Returns: 


353
<!-- ##### FUNCTION gtk_icon_view_set_orientation ##### -->
354 355 356 357 358
<para>

</para>

@icon_view: 
359
@orientation: 
360 361


362
<!-- ##### FUNCTION gtk_icon_view_get_orientation ##### -->
363 364 365 366 367 368 369 370
<para>

</para>

@icon_view: 
@Returns: 


Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
<!-- ##### FUNCTION gtk_icon_view_set_columns ##### -->
<para>

</para>

@icon_view: 
@columns: 


<!-- ##### FUNCTION gtk_icon_view_get_columns ##### -->
<para>

</para>

@icon_view: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_view_set_item_width ##### -->
<para>

</para>

@icon_view: 
@item_width: 


<!-- ##### FUNCTION gtk_icon_view_get_item_width ##### -->
<para>

</para>

@icon_view: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_view_set_spacing ##### -->
<para>

</para>

@icon_view: 
@spacing: 


<!-- ##### FUNCTION gtk_icon_view_get_spacing ##### -->
<para>

</para>

@icon_view: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_view_set_row_spacing ##### -->
<para>

</para>

@icon_view: 
@row_spacing: 


<!-- ##### FUNCTION gtk_icon_view_get_row_spacing ##### -->
<para>

</para>

@icon_view: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_view_set_column_spacing ##### -->
<para>

</para>

@icon_view: 
@column_spacing: 


<!-- ##### FUNCTION gtk_icon_view_get_column_spacing ##### -->
<para>

</para>

@icon_view: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_view_set_margin ##### -->
<para>

</para>

@icon_view: 
@margin: 


<!-- ##### FUNCTION gtk_icon_view_get_margin ##### -->
<para>

</para>

@icon_view: 
@Returns: 


479
<!-- ##### FUNCTION gtk_icon_view_select_path ##### -->
480 481 482 483 484
<para>

</para>

@icon_view: 
485
@path: 
486 487


488
<!-- ##### FUNCTION gtk_icon_view_unselect_path ##### -->
489 490 491 492 493
<para>

</para>

@icon_view: 
494
@path: 
495 496


497
<!-- ##### FUNCTION gtk_icon_view_path_is_selected ##### -->
498 499 500 501 502
<para>

</para>

@icon_view: 
503 504
@path: 
@Returns: 
505 506


507
<!-- ##### FUNCTION gtk_icon_view_get_selected_items ##### -->
508 509 510 511 512 513 514 515
<para>

</para>

@icon_view: 
@Returns: 


516
<!-- ##### FUNCTION gtk_icon_view_select_all ##### -->
517 518 519 520 521 522 523
<para>

</para>

@icon_view: 


524
<!-- ##### FUNCTION gtk_icon_view_unselect_all ##### -->
525 526 527 528 529 530 531
<para>

</para>

@icon_view: 


532
<!-- ##### FUNCTION gtk_icon_view_item_activated ##### -->
533 534 535 536 537
<para>

</para>

@icon_view: 
538
@path: 
539 540


Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
<!-- ##### FUNCTION gtk_icon_view_scroll_to_path ##### -->
<para>

</para>

@icon_view: 
@path: 
@use_align: 
@row_align: 
@col_align: 


<!-- ##### FUNCTION gtk_icon_view_get_visible_range ##### -->
<para>

</para>

@icon_view: 
@start_path: 
@end_path: 
@Returns: 


Matthias Clasen's avatar
2.7.1  
Matthias Clasen committed
564 565 566 567 568 569 570 571 572 573 574 575
<!-- ##### ENUM GtkIconViewDropPosition ##### -->
<para>

</para>

@GTK_ICON_VIEW_NO_DROP: 
@GTK_ICON_VIEW_DROP_INTO: 
@GTK_ICON_VIEW_DROP_LEFT: 
@GTK_ICON_VIEW_DROP_RIGHT: 
@GTK_ICON_VIEW_DROP_ABOVE: 
@GTK_ICON_VIEW_DROP_BELOW: 

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
<!-- ##### FUNCTION gtk_icon_view_enable_model_drag_source ##### -->
<para>

</para>

@icon_view: 
@start_button_mask: 
@targets: 
@n_targets: 
@actions: 


<!-- ##### FUNCTION gtk_icon_view_enable_model_drag_dest ##### -->
<para>

</para>

@icon_view: 
@targets: 
@n_targets: 
@actions: 


<!-- ##### FUNCTION gtk_icon_view_unset_model_drag_source ##### -->
<para>

</para>

@icon_view: 


<!-- ##### FUNCTION gtk_icon_view_unset_model_drag_dest ##### -->
<para>

</para>

@icon_view: 


<!-- ##### FUNCTION gtk_icon_view_set_reorderable ##### -->
<para>

</para>

@icon_view: 
@reorderable: 


<!-- ##### FUNCTION gtk_icon_view_get_reorderable ##### -->
<para>

</para>

@icon_view: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_view_set_drag_dest_item ##### -->
<para>

</para>

@icon_view: 
@path: 
@pos: 


<!-- ##### FUNCTION gtk_icon_view_get_drag_dest_item ##### -->
<para>

</para>

@icon_view: 
@path: 
@pos: 


<!-- ##### FUNCTION gtk_icon_view_get_dest_item_at_pos ##### -->
<para>

</para>

@icon_view: 
@drag_x: 
@drag_y: 
@path: 
@pos: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_view_create_drag_icon ##### -->
<para>

</para>

@icon_view: 
@path: 
@Returns: