← Back to branch summary

~ubuntu-branches/ubuntu/precise/gtk+2.0/precise-updates

« back to all changes in this revision

Viewing changes to docs/reference/gtk/tmpl/gtkiconview.sgml

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-02-06 22:03:26 UTC
  • mfrom: (1.14.12)
  • Revision ID: package-import@ubuntu.com-20120206220326-10d7cnkpdpbi9iox
Tags: 2.24.10-0ubuntu1
https://launchpad.net/bugs/920961
* New upstream version, dropped patches included in the new version
* debian/patches/090_logging_file_saves.patch:
  - improve the logging of saved filed, thanks Siegfried Gevatter 
    (lp: #920961)

Show diffs side-by-side

added added

removed removed

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