gtkiconview.sgml 8.94 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>

Matthias Clasen's avatar
Matthias Clasen committed
183
@icon_view: a #GtkIconView 
184 185
@path: The #GtkTreePath of a selected row
@data: user data
186

187 188

<!-- ##### FUNCTION gtk_icon_view_new ##### -->
189 190 191 192 193 194
<para>

</para>

@Returns: 

195 196

<!-- ##### FUNCTION gtk_icon_view_new_with_model ##### -->
197 198 199 200
<para>

</para>

201 202
@model: 
@Returns: 
203

204 205

<!-- ##### FUNCTION gtk_icon_view_set_model ##### -->
206 207 208 209
<para>

</para>

210 211
@icon_view: 
@model: 
212

213 214

<!-- ##### FUNCTION gtk_icon_view_get_model ##### -->
215 216 217 218
<para>

</para>

219 220
@icon_view: 
@Returns: 
221

222 223

<!-- ##### FUNCTION gtk_icon_view_set_text_column ##### -->
224 225 226 227
<para>

</para>

228 229
@icon_view: 
@column: 
230

231 232

<!-- ##### FUNCTION gtk_icon_view_get_text_column ##### -->
233 234 235 236
<para>

</para>

237 238
@icon_view: 
@Returns: 
239

240 241

<!-- ##### FUNCTION gtk_icon_view_set_markup_column ##### -->
242 243 244 245
<para>

</para>

246 247
@icon_view: 
@column: 
248 249


250
<!-- ##### FUNCTION gtk_icon_view_get_markup_column ##### -->
251 252 253 254
<para>

</para>

255 256
@icon_view: 
@Returns: 
257 258


259
<!-- ##### FUNCTION gtk_icon_view_set_pixbuf_column ##### -->
260 261 262 263
<para>

</para>

264 265
@icon_view: 
@column: 
266 267


268
<!-- ##### FUNCTION gtk_icon_view_get_pixbuf_column ##### -->
269 270 271 272
<para>

</para>

273 274
@icon_view: 
@Returns: 
275 276


277
<!-- ##### FUNCTION gtk_icon_view_get_path_at_pos ##### -->
278 279 280 281
<para>

</para>

282 283 284 285
@icon_view: 
@x: 
@y: 
@Returns: 
286

287

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
288 289 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
<!-- ##### 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: 


323
<!-- ##### FUNCTION gtk_icon_view_selected_foreach ##### -->
324
<para>
325

326 327
</para>

328 329 330
@icon_view: 
@func: 
@data: 
331 332


333
<!-- ##### FUNCTION gtk_icon_view_set_selection_mode ##### -->
334 335 336 337
<para>

</para>

338 339
@icon_view: 
@mode: 
340 341


342
<!-- ##### FUNCTION gtk_icon_view_get_selection_mode ##### -->
343 344 345 346
<para>

</para>

347
@icon_view: 
348 349 350
@Returns: 


351
<!-- ##### FUNCTION gtk_icon_view_set_orientation ##### -->
352 353 354 355 356
<para>

</para>

@icon_view: 
357
@orientation: 
358 359


360
<!-- ##### FUNCTION gtk_icon_view_get_orientation ##### -->
361 362 363 364 365 366 367 368
<para>

</para>

@icon_view: 
@Returns: 


Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
369 370 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
<!-- ##### 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: 


477
<!-- ##### FUNCTION gtk_icon_view_select_path ##### -->
478 479 480 481 482
<para>

</para>

@icon_view: 
483
@path: 
484 485


486
<!-- ##### FUNCTION gtk_icon_view_unselect_path ##### -->
487 488 489 490 491
<para>

</para>

@icon_view: 
492
@path: 
493 494


495
<!-- ##### FUNCTION gtk_icon_view_path_is_selected ##### -->
496 497 498 499 500
<para>

</para>

@icon_view: 
501 502
@path: 
@Returns: 
503 504


505
<!-- ##### FUNCTION gtk_icon_view_get_selected_items ##### -->
506 507 508 509 510 511 512 513
<para>

</para>

@icon_view: 
@Returns: 


514
<!-- ##### FUNCTION gtk_icon_view_select_all ##### -->
515 516 517 518 519 520 521
<para>

</para>

@icon_view: 


522
<!-- ##### FUNCTION gtk_icon_view_unselect_all ##### -->
523 524 525 526 527 528 529
<para>

</para>

@icon_view: 


530
<!-- ##### FUNCTION gtk_icon_view_item_activated ##### -->
531 532 533 534 535
<para>

</para>

@icon_view: 
536
@path: 
537 538


Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
<!-- ##### 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
562 563
<!-- ##### ENUM GtkIconViewDropPosition ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
564
An enum for determining where a dropped item goes.
Matthias Clasen's avatar
2.7.1  
Matthias Clasen committed
565 566
</para>

Matthias Clasen's avatar
Matthias Clasen committed
567 568 569 570 571 572
@GTK_ICON_VIEW_NO_DROP: no drop possible
@GTK_ICON_VIEW_DROP_INTO: dropped item replaces the item 
@GTK_ICON_VIEW_DROP_LEFT: droppped item is inserted to the left 
@GTK_ICON_VIEW_DROP_RIGHT: dropped item is inserted to the right
@GTK_ICON_VIEW_DROP_ABOVE: dropped item is inserted above
@GTK_ICON_VIEW_DROP_BELOW: dropped item is inserted below
Matthias Clasen's avatar
2.7.1  
Matthias Clasen committed
573

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
574 575 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
<!-- ##### 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: