]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtktreeview.sgml
=== Released 2.5.0 ===
[~andy/gtk] / docs / reference / gtk / tmpl / gtktreeview.sgml
1 <!-- ##### SECTION Title ##### -->
2 GtkTreeView
3
4 <!-- ##### SECTION Short_Description ##### -->
5 A widget for displaying both trees and lists.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 Widget that displays any object that implements the <link
10 linkend="GtkTreeModel">GtkTreeModel</link> interface.
11 </para>
12
13 <!-- ##### SECTION See_Also ##### -->
14 <para>
15 #GtkTreeViewColumn, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
16 </para>
17
18 <!-- ##### STRUCT GtkTreeView ##### -->
19 <para>
20
21 </para>
22
23
24 <!-- ##### SIGNAL GtkTreeView::columns-changed ##### -->
25 <para>
26
27 </para>
28
29 @treeview: the object which received the signal.
30
31 <!-- ##### SIGNAL GtkTreeView::cursor-changed ##### -->
32 <para>
33
34 </para>
35
36 @treeview: the object which received the signal.
37
38 <!-- ##### SIGNAL GtkTreeView::expand-collapse-cursor-row ##### -->
39 <para>
40
41 </para>
42
43 @treeview: the object which received the signal.
44 @arg1: 
45 @arg2: 
46 @arg3: 
47 @Returns: 
48
49 <!-- ##### SIGNAL GtkTreeView::move-cursor ##### -->
50 <para>
51
52 </para>
53
54 @treeview: the object which received the signal.
55 @arg1: 
56 @arg2: 
57 @Returns: 
58
59 <!-- ##### SIGNAL GtkTreeView::row-activated ##### -->
60 <para>
61
62 </para>
63
64 @treeview: the object which received the signal.
65 @arg1: 
66 @arg2: 
67
68 <!-- ##### SIGNAL GtkTreeView::row-collapsed ##### -->
69 <para>
70
71 </para>
72
73 @treeview: the object which received the signal.
74 @arg1: 
75 @arg2: 
76
77 <!-- ##### SIGNAL GtkTreeView::row-expanded ##### -->
78 <para>
79
80 </para>
81
82 @treeview: the object which received the signal.
83 @arg1: 
84 @arg2: 
85
86 <!-- ##### SIGNAL GtkTreeView::select-all ##### -->
87 <para>
88
89 </para>
90
91 @treeview: the object which received the signal.
92 @Returns: 
93
94 <!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
95 <para>
96
97 </para>
98
99 @treeview: the object which received the signal.
100 @Returns: 
101
102 <!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
103 <para>
104
105 </para>
106
107 @treeview: the object which received the signal.
108 @arg1: 
109 @Returns: 
110
111 <!-- ##### SIGNAL GtkTreeView::set-scroll-adjustments ##### -->
112 <para>
113
114 </para>
115
116 @treeview: the object which received the signal.
117 @arg1: 
118 @arg2: 
119
120 <!-- ##### SIGNAL GtkTreeView::start-interactive-search ##### -->
121 <para>
122
123 </para>
124
125 @treeview: the object which received the signal.
126 @Returns: 
127
128 <!-- ##### SIGNAL GtkTreeView::test-collapse-row ##### -->
129 <para>
130
131 </para>
132
133 @treeview: the object which received the signal.
134 @arg1: 
135 @arg2: 
136 @Returns: 
137
138 <!-- ##### SIGNAL GtkTreeView::test-expand-row ##### -->
139 <para>
140
141 </para>
142
143 @treeview: the object which received the signal.
144 @arg1: 
145 @arg2: 
146 @Returns: 
147
148 <!-- ##### SIGNAL GtkTreeView::toggle-cursor-row ##### -->
149 <para>
150
151 </para>
152
153 @treeview: the object which received the signal.
154 @Returns: 
155
156 <!-- ##### SIGNAL GtkTreeView::unselect-all ##### -->
157 <para>
158
159 </para>
160
161 @treeview: the object which received the signal.
162 @Returns: 
163
164 <!-- ##### ARG GtkTreeView:enable-search ##### -->
165 <para>
166
167 </para>
168
169 <!-- ##### ARG GtkTreeView:expander-column ##### -->
170 <para>
171
172 </para>
173
174 <!-- ##### ARG GtkTreeView:fixed-height-mode ##### -->
175 <para>
176
177 </para>
178
179 <!-- ##### ARG GtkTreeView:hadjustment ##### -->
180 <para>
181
182 </para>
183
184 <!-- ##### ARG GtkTreeView:headers-clickable ##### -->
185 <para>
186
187 </para>
188
189 <!-- ##### ARG GtkTreeView:headers-visible ##### -->
190 <para>
191
192 </para>
193
194 <!-- ##### ARG GtkTreeView:hover-selection ##### -->
195 <para>
196
197 </para>
198
199 <!-- ##### ARG GtkTreeView:model ##### -->
200 <para>
201
202 </para>
203
204 <!-- ##### ARG GtkTreeView:reorderable ##### -->
205 <para>
206
207 </para>
208
209 <!-- ##### ARG GtkTreeView:rules-hint ##### -->
210 <para>
211
212 </para>
213
214 <!-- ##### ARG GtkTreeView:search-column ##### -->
215 <para>
216
217 </para>
218
219 <!-- ##### ARG GtkTreeView:vadjustment ##### -->
220 <para>
221
222 </para>
223
224 <!-- ##### ARG GtkTreeView:allow-rules ##### -->
225 <para>
226
227 </para>
228
229 <!-- ##### ARG GtkTreeView:even-row-color ##### -->
230 <para>
231
232 </para>
233
234 <!-- ##### ARG GtkTreeView:expander-size ##### -->
235 <para>
236
237 </para>
238
239 <!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
240 <para>
241
242 </para>
243
244 <!-- ##### ARG GtkTreeView:indent-expanders ##### -->
245 <para>
246
247 </para>
248
249 <!-- ##### ARG GtkTreeView:odd-row-color ##### -->
250 <para>
251
252 </para>
253
254 <!-- ##### ARG GtkTreeView:vertical-separator ##### -->
255 <para>
256
257 </para>
258
259 <!-- ##### ENUM GtkTreeViewDropPosition ##### -->
260 <para>
261 An enum for determining where a dropped row goes.
262 </para>
263
264 @GTK_TREE_VIEW_DROP_BEFORE: 
265 @GTK_TREE_VIEW_DROP_AFTER: 
266 @GTK_TREE_VIEW_DROP_INTO_OR_BEFORE: 
267 @GTK_TREE_VIEW_DROP_INTO_OR_AFTER: 
268
269 <!-- ##### STRUCT GtkTreeViewPrivate ##### -->
270 <para>
271 A private struct for internal use only.  The definition of this
272 structure is not publically available.
273 </para>
274
275
276 <!-- ##### USER_FUNCTION GtkTreeViewColumnDropFunc ##### -->
277 <para>
278 Function type for determining whether @column can be dropped in a
279 particular spot (as determined by @prev_column and @next_column).  In
280 left to right locales, @prev_column is on the left of the potential drop
281 spot, and @next_column is on the right.  In right to left mode, this is
282 reversed.  This function should return %TRUE if the spot is a valid drop
283 spot.  Please note that returning %TRUE does not actually indicate that
284 the column drop was made, but is meant only to indicate a possible drop
285 spot to the user.
286 </para>
287
288 @tree_view: A #GtkTreeView
289 @column: The #GtkTreeViewColumn being dragged
290 @prev_column: A #GtkTreeViewColumn on one side of @column
291 @next_column: A #GtkTreeViewColumn on the other side of @column
292 @data: user data
293 @Returns: %TRUE, if #column can be dropped in this spot
294
295
296 <!-- ##### USER_FUNCTION GtkTreeViewMappingFunc ##### -->
297 <para>
298 Function used for #gtk_tree_view_map_expanded_rows.
299 </para>
300
301 @tree_view: A #GtkTreeView
302 @path: The path that's expanded
303 @user_data: user data
304
305
306 <!-- ##### USER_FUNCTION GtkTreeViewSearchEqualFunc ##### -->
307 <para>
308 A function used for checking whether a row in @model matches
309 a search key string entered by the user. Note the return value
310 is reversed from what you would normally expect, though it
311 has some similarity to strcmp() returning 0 for equal strings.
312 </para>
313
314 @model: the #GtkTreeModel being searched
315 @column: the search column set by gtk_tree_view_set_search_column()
316 @key: the key string to compare with
317 @iter: a #GtkTreeIter pointing the row of @model that should be compared
318   with @key.
319 @search_data: user data from gtk_tree_view_set_search_equal_func()
320 @Returns: %FALSE if the row matches, %TRUE otherwise.
321
322
323 <!-- ##### FUNCTION gtk_tree_view_new ##### -->
324 <para>
325
326 </para>
327
328 @Returns: 
329
330
331 <!-- ##### FUNCTION gtk_tree_view_new_with_model ##### -->
332 <para>
333
334 </para>
335
336 @model: 
337 @Returns: 
338
339
340 <!-- ##### FUNCTION gtk_tree_view_get_model ##### -->
341 <para>
342
343 </para>
344
345 @tree_view: 
346 @Returns: 
347
348
349 <!-- ##### FUNCTION gtk_tree_view_set_model ##### -->
350 <para>
351
352 </para>
353
354 @tree_view: 
355 @model: 
356 <!-- # Unused Parameters # -->
357 @tree_model: 
358
359
360 <!-- ##### FUNCTION gtk_tree_view_get_selection ##### -->
361 <para>
362
363 </para>
364
365 @tree_view: 
366 @Returns: 
367
368
369 <!-- ##### FUNCTION gtk_tree_view_get_hadjustment ##### -->
370 <para>
371
372 </para>
373
374 @tree_view: 
375 @Returns: 
376 <!-- # Unused Parameters # -->
377 @layout: 
378
379
380 <!-- ##### FUNCTION gtk_tree_view_set_hadjustment ##### -->
381 <para>
382
383 </para>
384
385 @tree_view: 
386 @adjustment: 
387 <!-- # Unused Parameters # -->
388 @layout: 
389
390
391 <!-- ##### FUNCTION gtk_tree_view_get_vadjustment ##### -->
392 <para>
393
394 </para>
395
396 @tree_view: 
397 @Returns: 
398 <!-- # Unused Parameters # -->
399 @layout: 
400
401
402 <!-- ##### FUNCTION gtk_tree_view_set_vadjustment ##### -->
403 <para>
404
405 </para>
406
407 @tree_view: 
408 @adjustment: 
409 <!-- # Unused Parameters # -->
410 @layout: 
411
412
413 <!-- ##### FUNCTION gtk_tree_view_get_headers_visible ##### -->
414 <para>
415
416 </para>
417
418 @tree_view: 
419 @Returns: 
420
421
422 <!-- ##### FUNCTION gtk_tree_view_set_headers_visible ##### -->
423 <para>
424
425 </para>
426
427 @tree_view: 
428 @headers_visible: 
429
430
431 <!-- ##### FUNCTION gtk_tree_view_columns_autosize ##### -->
432 <para>
433
434 </para>
435
436 @tree_view: 
437
438
439 <!-- ##### FUNCTION gtk_tree_view_set_headers_clickable ##### -->
440 <para>
441
442 </para>
443
444 @tree_view: 
445 @setting: 
446 <!-- # Unused Parameters # -->
447 @active: 
448
449
450 <!-- ##### FUNCTION gtk_tree_view_set_rules_hint ##### -->
451 <para>
452
453 </para>
454
455 @tree_view: 
456 @setting: 
457
458
459 <!-- ##### FUNCTION gtk_tree_view_get_rules_hint ##### -->
460 <para>
461
462 </para>
463
464 @tree_view: 
465 @Returns: 
466
467
468 <!-- ##### FUNCTION gtk_tree_view_append_column ##### -->
469 <para>
470
471 </para>
472
473 @tree_view: 
474 @column: 
475 @Returns: 
476
477
478 <!-- ##### FUNCTION gtk_tree_view_remove_column ##### -->
479 <para>
480
481 </para>
482
483 @tree_view: 
484 @column: 
485 @Returns: 
486
487
488 <!-- ##### FUNCTION gtk_tree_view_insert_column ##### -->
489 <para>
490
491 </para>
492
493 @tree_view: 
494 @column: 
495 @position: 
496 @Returns: 
497
498
499 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_attributes ##### -->
500 <para>
501
502 </para>
503
504 @tree_view: 
505 @position: 
506 @title: 
507 @cell: 
508 @Varargs: 
509 @Returns: 
510
511
512 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_data_func ##### -->
513 <para>
514
515 </para>
516
517 @tree_view: 
518 @position: 
519 @title: 
520 @cell: 
521 @func: 
522 @data: 
523 @dnotify: 
524 @Returns: 
525
526
527 <!-- ##### FUNCTION gtk_tree_view_get_column ##### -->
528 <para>
529
530 </para>
531
532 @tree_view: 
533 @n: 
534 @Returns: 
535
536
537 <!-- ##### FUNCTION gtk_tree_view_get_columns ##### -->
538 <para>
539
540 </para>
541
542 @tree_view: 
543 @Returns: 
544
545
546 <!-- ##### FUNCTION gtk_tree_view_move_column_after ##### -->
547 <para>
548
549 </para>
550
551 @tree_view: 
552 @column: 
553 @base_column: 
554
555
556 <!-- ##### FUNCTION gtk_tree_view_set_expander_column ##### -->
557 <para>
558
559 </para>
560
561 @tree_view: 
562 @column: 
563
564
565 <!-- ##### FUNCTION gtk_tree_view_get_expander_column ##### -->
566 <para>
567
568 </para>
569
570 @tree_view: 
571 @Returns: 
572
573
574 <!-- ##### FUNCTION gtk_tree_view_set_column_drag_function ##### -->
575 <para>
576
577 </para>
578
579 @tree_view: 
580 @func: 
581 @user_data: 
582 @destroy: 
583
584
585 <!-- ##### FUNCTION gtk_tree_view_scroll_to_point ##### -->
586 <para>
587
588 </para>
589
590 @tree_view: 
591 @tree_x: 
592 @tree_y: 
593
594
595 <!-- ##### FUNCTION gtk_tree_view_scroll_to_cell ##### -->
596 <para>
597
598 </para>
599
600 @tree_view: 
601 @path: 
602 @column: 
603 @use_align: 
604 @row_align: 
605 @col_align: 
606
607
608 <!-- ##### FUNCTION gtk_tree_view_set_cursor ##### -->
609 <para>
610
611 </para>
612
613 @tree_view: 
614 @path: 
615 @focus_column: 
616 @start_editing: 
617
618
619 <!-- ##### FUNCTION gtk_tree_view_set_cursor_on_cell ##### -->
620 <para>
621
622 </para>
623
624 @tree_view: 
625 @path: 
626 @focus_column: 
627 @focus_cell: 
628 @start_editing: 
629
630
631 <!-- ##### FUNCTION gtk_tree_view_get_cursor ##### -->
632 <para>
633
634 </para>
635
636 @tree_view: 
637 @path: 
638 @focus_column: 
639
640
641 <!-- ##### FUNCTION gtk_tree_view_row_activated ##### -->
642 <para>
643
644 </para>
645
646 @tree_view: 
647 @path: 
648 @column: 
649
650
651 <!-- ##### FUNCTION gtk_tree_view_expand_all ##### -->
652 <para>
653
654 </para>
655
656 @tree_view: 
657
658
659 <!-- ##### FUNCTION gtk_tree_view_collapse_all ##### -->
660 <para>
661
662 </para>
663
664 @tree_view: 
665
666
667 <!-- ##### FUNCTION gtk_tree_view_expand_to_path ##### -->
668 <para>
669
670 </para>
671
672 @tree_view: 
673 @path: 
674
675
676 <!-- ##### FUNCTION gtk_tree_view_expand_row ##### -->
677 <para>
678
679 </para>
680
681 @tree_view: 
682 @path: 
683 @open_all: 
684 @Returns: 
685
686
687 <!-- ##### FUNCTION gtk_tree_view_collapse_row ##### -->
688 <para>
689
690 </para>
691
692 @tree_view: 
693 @path: 
694 @Returns: 
695
696
697 <!-- ##### FUNCTION gtk_tree_view_map_expanded_rows ##### -->
698 <para>
699
700 </para>
701
702 @tree_view: 
703 @func: 
704 @data: 
705
706
707 <!-- ##### FUNCTION gtk_tree_view_row_expanded ##### -->
708 <para>
709
710 </para>
711
712 @tree_view: 
713 @path: 
714 @Returns: 
715
716
717 <!-- ##### FUNCTION gtk_tree_view_set_reorderable ##### -->
718 <para>
719
720 </para>
721
722 @tree_view: 
723 @reorderable: 
724
725
726 <!-- ##### FUNCTION gtk_tree_view_get_reorderable ##### -->
727 <para>
728
729 </para>
730
731 @tree_view: 
732 @Returns: 
733
734
735 <!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### -->
736 <para>
737
738 </para>
739
740 @tree_view: 
741 @x: 
742 @y: 
743 @path: 
744 @column: 
745 @cell_x: 
746 @cell_y: 
747 @Returns: 
748 <!-- # Unused Parameters # -->
749 @window: 
750
751
752 <!-- ##### FUNCTION gtk_tree_view_get_cell_area ##### -->
753 <para>
754
755 </para>
756
757 @tree_view: 
758 @path: 
759 @column: 
760 @rect: 
761
762
763 <!-- ##### FUNCTION gtk_tree_view_get_background_area ##### -->
764 <para>
765
766 </para>
767
768 @tree_view: 
769 @path: 
770 @column: 
771 @rect: 
772
773
774 <!-- ##### FUNCTION gtk_tree_view_get_visible_rect ##### -->
775 <para>
776
777 </para>
778
779 @tree_view: 
780 @visible_rect: 
781
782
783 <!-- ##### FUNCTION gtk_tree_view_get_bin_window ##### -->
784 <para>
785
786 </para>
787
788 @tree_view: 
789 @Returns: 
790
791
792 <!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
793 <para>
794
795 </para>
796
797 @tree_view: 
798 @wx: 
799 @wy: 
800 @tx: 
801 @ty: 
802
803
804 <!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
805 <para>
806
807 </para>
808
809 @tree_view: 
810 @tx: 
811 @ty: 
812 @wx: 
813 @wy: 
814
815
816 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_dest ##### -->
817 <para>
818
819 </para>
820
821 @tree_view: 
822 @targets: 
823 @n_targets: 
824 @actions: 
825
826
827 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_source ##### -->
828 <para>
829
830 </para>
831
832 @tree_view: 
833 @start_button_mask: 
834 @targets: 
835 @n_targets: 
836 @actions: 
837
838
839 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_source ##### -->
840 <para>
841
842 </para>
843
844 @tree_view: 
845
846
847 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_dest ##### -->
848 <para>
849
850 </para>
851
852 @tree_view: 
853
854
855 <!-- ##### FUNCTION gtk_tree_view_set_drag_dest_row ##### -->
856 <para>
857
858 </para>
859
860 @tree_view: 
861 @path: 
862 @pos: 
863
864
865 <!-- ##### FUNCTION gtk_tree_view_get_drag_dest_row ##### -->
866 <para>
867
868 </para>
869
870 @tree_view: 
871 @path: 
872 @pos: 
873
874
875 <!-- ##### FUNCTION gtk_tree_view_get_dest_row_at_pos ##### -->
876 <para>
877
878 </para>
879
880 @tree_view: 
881 @drag_x: 
882 @drag_y: 
883 @path: 
884 @pos: 
885 @Returns: 
886
887
888 <!-- ##### FUNCTION gtk_tree_view_create_row_drag_icon ##### -->
889 <para>
890
891 </para>
892
893 @tree_view: 
894 @path: 
895 @Returns: 
896
897
898 <!-- ##### FUNCTION gtk_tree_view_set_enable_search ##### -->
899 <para>
900
901 </para>
902
903 @tree_view: 
904 @enable_search: 
905 <!-- # Unused Parameters # -->
906 @use_search: 
907
908
909 <!-- ##### FUNCTION gtk_tree_view_get_enable_search ##### -->
910 <para>
911
912 </para>
913
914 @tree_view: 
915 @Returns: 
916
917
918 <!-- ##### FUNCTION gtk_tree_view_get_search_column ##### -->
919 <para>
920
921 </para>
922
923 @tree_view: 
924 @Returns: 
925
926
927 <!-- ##### FUNCTION gtk_tree_view_set_search_column ##### -->
928 <para>
929
930 </para>
931
932 @tree_view: 
933 @column: 
934
935
936 <!-- ##### FUNCTION gtk_tree_view_get_search_equal_func ##### -->
937 <para>
938
939 </para>
940
941 @tree_view: 
942 @Returns: 
943
944
945 <!-- ##### FUNCTION gtk_tree_view_set_search_equal_func ##### -->
946 <para>
947
948 </para>
949
950 @tree_view: 
951 @search_equal_func: 
952 @search_user_data: 
953 @search_destroy: 
954
955
956 <!-- ##### FUNCTION gtk_tree_view_get_fixed_height_mode ##### -->
957 <para>
958
959 </para>
960
961 @tree_view: 
962 @Returns: 
963
964
965 <!-- ##### FUNCTION gtk_tree_view_set_fixed_height_mode ##### -->
966 <para>
967
968 </para>
969
970 @tree_view: 
971 @enable: 
972
973
974 <!-- ##### FUNCTION gtk_tree_view_get_hover_selection ##### -->
975 <para>
976
977 </para>
978
979 @tree_view: 
980 @Returns: 
981
982
983 <!-- ##### FUNCTION gtk_tree_view_set_hover_selection ##### -->
984 <para>
985
986 </para>
987
988 @tree_view: 
989 @hover: 
990
991
992 <!-- ##### USER_FUNCTION GtkTreeDestroyCountFunc ##### -->
993 <para>
994
995 </para>
996
997 @tree_view: 
998 @path: 
999 @children: 
1000 @user_data: 
1001
1002
1003 <!-- ##### FUNCTION gtk_tree_view_set_destroy_count_func ##### -->
1004 <para>
1005
1006 </para>
1007
1008 @tree_view: 
1009 @func: 
1010 @data: 
1011 @destroy: 
1012
1013
1014 <!-- ##### USER_FUNCTION GtkTreeViewRowSeparatorFunc ##### -->
1015 <para>
1016 Function type for determining whether the row pointed to by @iter should
1017 be rendered as a separator. A common way to implement this is to have a
1018 boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc
1019 returns.
1020 </para>
1021
1022 @model: the #GtkTreeModel
1023 @iter: a #GtkTreeIter pointing at a row in @model
1024 @data: user data
1025 @Returns: %TRUE if the row is a separator
1026
1027
1028 <!-- ##### FUNCTION gtk_tree_view_get_row_separator_func ##### -->
1029 <para>
1030
1031 </para>
1032
1033 @tree_view: 
1034 @Returns: 
1035
1036
1037 <!-- ##### FUNCTION gtk_tree_view_set_row_separator_func ##### -->
1038 <para>
1039
1040 </para>
1041
1042 @tree_view: 
1043 @func: 
1044 @data: 
1045 @destroy: 
1046
1047