summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkctree.sgml
blob: 370120efe26bfd27b758334d62aef43a4ff6871d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
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
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
<!-- ##### SECTION Title ##### -->
GtkCTree

<!-- ##### SECTION Short_Description ##### -->
A widget displaying a hierarchical tree

<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkCTree widget is used for showing a hierarchical tree 
to the user, for example a directory tree.
</para>
<para>
The tree is internally represented as a set of #GtkCTreeNode structures.
</para>
<para>
The interface has much in common with the #GtkCList widget: rows (nodes)
can be selected by the user etc.
</para>
<para> 
Positions in the tree are often indicated by two arguments, a
parent and a sibling, both #GtkCTreeNode pointers. If the parent
is %NULL, the position is at the root of the tree and if the sibling
is %NULL, it will be the last child of parent, otherwise it will be
inserted just before the sibling.
</para>
<para>
GtkCTree has been deprecated since GTK+ 2.0 and should not be used
in newly written code. Use #GtkTreeView instead.
</para>

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

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkCTree ##### -->
<para>
The #GtkCTree-struct contains the following user-accessible fields.
These fields should be considered read-only; to set the values,
use the methods below.

<informaltable pgwide="1" frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>

<row>
<entry>#gint <structfield>tree_indent</structfield>;</entry>
<entry>The number of pixels each successive level of the tree is
indented in the display.</entry>
</row>

<row>
<entry>#gint <structfield>tree_spacing</structfield>;</entry>
<entry>The space in pixels between the graphical tree and the text in the
node.</entry>
</row>

<row>
<entry>#gint <structfield>tree_column</structfield>;</entry>
<entry>The index of the column for which the tree graphics is drawn. </entry>
</row>

<row>
<entry>#GtkCTreeLineStyle <structfield>line_style</structfield>;</entry>
<entry>The style in which the lines in the tree graphics are drawn.</entry>
</row>

<row>
<entry>#GtkCTreeExpanderStyle <structfield>expander_style</structfield>;</entry>
<entry>The style in which the expander buttons are drawn.</entry>
</row>

<row>
<entry>#GtkCTreeExpanderStyle <structfield>expander_style</structfield>;</entry>
<entry>FIXME.</entry>
</row>

</tbody></tgroup></informaltable>
</para>


<!-- ##### SIGNAL GtkCTree::change-focus-row-expansion ##### -->
<para>
The row which has the focus is either collapsed or expanded
or toggled.
</para>

@ctree: the object which received the signal.
@expansion: What is being done.

<!-- ##### SIGNAL GtkCTree::tree-collapse ##### -->
<para>
Emitted when a node is collapsed.
</para>

@ctree: the object which received the signal.
@node: 

<!-- ##### SIGNAL GtkCTree::tree-expand ##### -->
<para>
Emitted when a node is expanded.
</para>

@ctree: the object which received the signal.
@node: 

<!-- ##### SIGNAL GtkCTree::tree-move ##### -->
<para>
Emitted when a node is moved.
</para>

@ctree: the object which received the signal.
@node: The node that is moved.
@new_parent: The new parent of the node.
@new_sibling: The new sibling of the node.

<!-- ##### SIGNAL GtkCTree::tree-select-row ##### -->
<para>
Emitted when a row is selected.
</para>

@ctree: the object which received the signal.
@node: The node corresponding to the selected row.
@column: The column which was selected.

<!-- ##### SIGNAL GtkCTree::tree-unselect-row ##### -->
<para>
Emitted when a node is unselected.
</para>

@ctree: the object which received the signal.
@node: The node  corresponding to the selected row.
@column: 

<!-- ##### ARG GtkCTree:expander-style ##### -->
<para>
The style of the expander buttons.
</para>

<!-- ##### ARG GtkCTree:indent ##### -->
<para>
The number of pixels to indent the tree levels.
</para>

<!-- ##### ARG GtkCTree:line-style ##### -->
<para>
The style of the lines in the tree graphic.
</para>

<!-- ##### ARG GtkCTree:n-columns ##### -->
<para>
The number of columns in the tree.
</para>

<!-- ##### ARG GtkCTree:show-stub ##### -->
<para>
FIXME
</para>

<!-- ##### ARG GtkCTree:spacing ##### -->
<para>
The number of pixels between the tree and the columns.
</para>

<!-- ##### ARG GtkCTree:tree-column ##### -->
<para>
The column in which the actual tree graphic appears.
</para>

<!-- ##### MACRO GTK_CTREE_ROW ##### -->
<para>
Used to get the #GtkCTreeRow structure corresponding to the given #GtkCTreeNode.
</para>

@_node_: 


<!-- ##### MACRO GTK_CTREE_NODE ##### -->
<para>

</para>

@_node_: 


<!-- ##### MACRO GTK_CTREE_NODE_NEXT ##### -->
<para>
FIXME
</para>

@_nnode_: 


<!-- ##### MACRO GTK_CTREE_NODE_PREV ##### -->
<para>
FIXME
</para>

@_pnode_: 


<!-- ##### MACRO GTK_CTREE_FUNC ##### -->
<para>

</para>

@_func_: 


<!-- ##### ENUM GtkCTreePos ##### -->
<para>
A value specifying the position of a new node relative to an old one.

<informaltable pgwide="1" frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>

<row>
<entry>GTK_CTREE_POS_BEFORE</entry>
<entry>As a sibling, before the specified node.</entry>
</row>

<row>
<entry>GTK_CTREE_POS_AS_CHILD</entry>
<entry>As a child of the specified node.</entry>
</row>

<row>
<entry>GTK_CTREE_POS_AFTER</entry>
<entry>As a sibling, after the specified node.</entry>
</row>

</tbody></tgroup></informaltable>

</para>

@GTK_CTREE_POS_BEFORE: 
@GTK_CTREE_POS_AS_CHILD: 
@GTK_CTREE_POS_AFTER: 

<!-- ##### ENUM GtkCTreeLineStyle ##### -->
<para>
The appearance of the lines in the tree graphics.

<informaltable pgwide="1" frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>

<row>
<entry>GTK_CTREE_LINES_NONE</entry>
<entry>No lines.</entry>
</row>

<row>
<entry>GTK_CTREE_LINES_SOLID</entry>
<entry>Solid lines.</entry>
</row>

<row>
<entry>GTK_CTREE_LINES_DOTTED</entry>
<entry>Dotted lines.</entry>
</row>

<row>
<entry>GTK_CTREE_LINES_TABBED</entry>
<entry>FIXME.</entry>
</row>

</tbody></tgroup></informaltable>


</para>

@GTK_CTREE_LINES_NONE: 
@GTK_CTREE_LINES_SOLID: 
@GTK_CTREE_LINES_DOTTED: 
@GTK_CTREE_LINES_TABBED: 

<!-- ##### ENUM GtkCTreeExpanderStyle ##### -->
<para>
The appearance of the expander buttons, i.e. the small buttons
which expand or contract parts of the tree when pressed.


<informaltable pgwide="1" frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>

<row>
<entry>GTK_CTREE_EXPANDER_NONE</entry>
<entry>No expanders.</entry>
</row>

<row>
<entry>GTK_CTREE_EXPANDER_SQUARE</entry>
<entry>Square expanders.</entry>
</row>

<row>
<entry>GTK_CTREE_EXPANDER_TRIANGLE</entry>
<entry>Triangular expanders.</entry>
</row>

<row>
<entry>GTK_CTREE_EXPANDER_CIRCULAR</entry>
<entry>Round expanders.</entry>
</row>

</tbody></tgroup></informaltable>


</para>

@GTK_CTREE_EXPANDER_NONE: 
@GTK_CTREE_EXPANDER_SQUARE: 
@GTK_CTREE_EXPANDER_TRIANGLE: 
@GTK_CTREE_EXPANDER_CIRCULAR: 

<!-- ##### ENUM GtkCTreeExpansionType ##### -->
<para>
How to expand or collapse a part of a tree.

<informaltable pgwide="1" frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>

<row>
<entry>GTK_CTREE_EXPANSION_EXPAND</entry>
<entry>Expand this node.</entry>
</row>

<row>
<entry>GTK_CTREE_EXPANSION_EXPAND_RECURSIVE</entry>
<entry>Expand this node and everything below it in the hierarchy.</entry>
</row>

<row>
<entry>GTK_CTREE_EXPANSION_COLLAPSE</entry>
<entry>Collapse this node.</entry>
</row>

<row>
<entry>GTK_CTREE_EXPANSION_COLLAPSE_RECURSIVE</entry>
<entry>Collapse this node and everything below it in the hierarchy.</entry>
</row>

<row>
<entry>GTK_CTREE_EXPANSION_TOGGLE</entry>
<entry>Toggle this node (i.e. expand if collapsed and vice versa).</entry>
</row>

<row>
<entry>GTK_CTREE_EXPANSION_TOGGLE_RECURSIVE</entry>
<entry>Toggle this node and everything below it in the hierarchy.</entry>
</row>


</tbody></tgroup></informaltable>


</para>

@GTK_CTREE_EXPANSION_EXPAND: 
@GTK_CTREE_EXPANSION_EXPAND_RECURSIVE: 
@GTK_CTREE_EXPANSION_COLLAPSE: 
@GTK_CTREE_EXPANSION_COLLAPSE_RECURSIVE: 
@GTK_CTREE_EXPANSION_TOGGLE: 
@GTK_CTREE_EXPANSION_TOGGLE_RECURSIVE: 

<!-- ##### USER_FUNCTION GtkCTreeFunc ##### -->
<para>
A generic callback type to do something with a particular node.
</para>

@ctree: The #GtkCTree object.
@node: The #GtkCTreeNode in the tree.
@data: The user data associated with the node.


<!-- ##### USER_FUNCTION GtkCTreeGNodeFunc ##### -->
<para>
FIXME
</para>

@ctree: 
@depth: 
@gnode: 
@cnode: 
@data: 
@Returns: 


<!-- ##### USER_FUNCTION GtkCTreeCompareDragFunc ##### -->
<para>
FIXME
</para>

@ctree: 
@source_node: 
@new_parent: 
@new_sibling: 
@Returns: 


<!-- ##### STRUCT GtkCTreeRow ##### -->
<para>
A structure representing a single row in the tree graph.
The values inside the structure should be considered read-only.
This structure is derived from the #GtkCListRow structure.

<informaltable pgwide="1" frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>

<row>
<entry>#GtkCTreeNode *<structfield>parent</structfield>;</entry>
<entry>The parent node of the node corresponding to this row.
</entry>
</row>

<row>
<entry>#GtkCTreeNode *<structfield>sibling</structfield>;</entry>
<entry>The next sibling node of the node corresponding to this row.
</entry>
</row>

<row>
<entry>#GtkCTreeNode *<structfield>children</structfield>;</entry>
<entry>The first child node corresponding to this row; to access
the other children, just use the siblings of that node.
</entry>
</row>

<row>
<entry>#GdkPixmap *<structfield>pixmap_closed</structfield>;</entry>
<entry> The pixmap to be shown when the node is collapsed.
</entry>
</row>

<row>
<entry>#GdkBitmap *<structfield>mask_closed</structfield>;</entry>
<entry> The mask for the above pixmap.
</entry>
</row>

<row>
<entry>#GdkPixmap *<structfield>pixmap_opened</structfield>;</entry>
<entry> The pixmap to be shown when the node is expanded.
</entry>
</row>

<row>
<entry>#GdkBitmap *<structfield>mask_opened</structfield>;</entry>
<entry> The mask for the above pixmap.
</entry>
</row>

<row>
<entry>#guint16 <structfield>level</structfield>;</entry>
<entry>The level of this node in the tree.
</entry>
</row>


<row>
<entry>#guint <structfield>is_leaf</structfield> : 1;</entry>
<entry>Whether this row is a leaf.
</entry>
</row>

<row>
<entry>#guint <structfield>expanded</structfield> : 1;</entry>
<entry>Whether the children of this row are visible.
</entry>
</row>
</tbody></tgroup></informaltable>

</para>

@row: 
@parent: 
@sibling: 
@children: 
@pixmap_closed: 
@mask_closed: 
@pixmap_opened: 
@mask_opened: 
@level: 
@is_leaf: 
@expanded: 

<!-- ##### STRUCT GtkCTreeNode ##### -->
<para>
This structure is opaque - you should use the
macros #GTK_CTREE_ROW, #GTK_CTREE_NODE_NEXT etc. as well
as the functions below to access it.
</para>

@list: 

<!-- ##### MACRO GTK_TYPE_CTREE_NODE ##### -->
<para>

</para>



<!-- ##### FUNCTION gtk_ctree_new_with_titles ##### -->
<para>
Create a new #GtkCTree widget with the given titles for the columns.
</para>

@columns: Number of columns.
@tree_column: Which column has the tree graphic; 0 = leftmost.
@titles: The titles for the columns.
@Returns: The #GtkCTree widget.


<!-- ##### FUNCTION gtk_ctree_new ##### -->
<para>
Create a new #GtkCTree widget.
</para>

@columns: Number of columns.
@tree_column: Which columns has the tree graphic.
@Returns: The new #GtkCTree widget.


<!-- ##### FUNCTION gtk_ctree_insert_node ##### -->
<para>
Insert a new node to the tree. The position is specified through
the parent-sibling notation, as explained in the introduction above.
</para>

@ctree: The #GtkCTree widget.
@parent: The parent node to be.
@sibling: The sibling node to be.
@text: The texts to be shown in each column.
@spacing: The extra space between the pixmap and the text.
@pixmap_closed: The pixmap to be used when the node is collapsed. Can be %NULL.
@mask_closed: The mask for the above pixmap. Can be %NULL.
@pixmap_opened: The pixmap to be used when the children are visible. Can be %NULL.
@mask_opened: The mask for the above pixmap. Can be %NULL.
@is_leaf: Whether this node is going to be a leaf.
@expanded: Whether this node should start out expanded or not.
@Returns: 


<!-- ##### FUNCTION gtk_ctree_remove_node ##### -->
<para>
Remove the node and all nodes underneath it from the tree.
</para>

@ctree: The widget.
@node: The node to be removed.


<!-- ##### FUNCTION gtk_ctree_insert_gnode ##### -->
<para>
FIXME
</para>

@ctree: 
@parent: 
@sibling: 
@gnode: 
@func: 
@data: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_export_to_gnode ##### -->
<para>
FIXME
</para>

@ctree: 
@parent: 
@sibling: 
@node: 
@func: 
@data: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_post_recursive ##### -->
<para>
Recursively apply a function to all nodes of the tree at or below a certain
node. 
The function is called for each node after it has been called
for that node's children.
</para>

@ctree: 
@node: The node where to start. %NULL means to start at the root.
@func: The function to apply to each node.
@data: A closure argument given to each invocation of the function.


<!-- ##### FUNCTION gtk_ctree_post_recursive_to_depth ##### -->
<para>
Recursively apply a function to nodes up to a certain depth.
The function is called for each node after it has been called
for that node's children.
</para>

@ctree: 
@node: The node where to start.
@depth: The maximum absolute depth for applying the function.  If depth is negative, this function just calls #gtk_ctree_post_recursive.
@func: The function to apply to each node.
@data: A closure argument given to each invocation of the function.


<!-- ##### FUNCTION gtk_ctree_pre_recursive ##### -->
<para>
Recursively apply a function to all nodes of the tree at or below a certain
node.
The function is called for each node after it has been called
for its parent.
</para>

@ctree: 
@node: The node where to start. %NULL means to start at the root.
@func: The function to apply to each node.
@data: A closure argument given to each invocation of the function.


<!-- ##### FUNCTION gtk_ctree_pre_recursive_to_depth ##### -->
<para>
Recursively apply a function to nodes up to a certain depth.
The function is called for each node after it has been called
for that node's children.
</para>

@ctree: 
@node: The node where to start.
@depth: The maximum absolute depth for applying the function.  If depth is negative, this function just calls #gtk_ctree_post_recursive.
@func: The function to apply to each node.
@data: A closure argument given to each invocation of the function.


<!-- ##### FUNCTION gtk_ctree_is_viewable ##### -->
<para>
This function checks whether the given node is viewable i.e. so that
all of its parent nodes are expanded.  This is different from being
actually visible: the node can be viewable but outside the scrolling
area of the window.
</para>

@ctree: 
@node: 
@Returns: Whether the node is viewable.


<!-- ##### FUNCTION gtk_ctree_last ##### -->
<para>
Returns the last child of the last child of the last child...
of the given node.
</para>

@ctree: 
@node: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_find_node_ptr ##### -->
<para>
Finds the node pointer given a #GtkCTreeRow structure.
</para>

@ctree: 
@ctree_row: 
@Returns: The node pointer.


<!-- ##### FUNCTION gtk_ctree_find ##### -->
<para>

</para>

@ctree: 
@node: The node to start searching from. May be %NULL.
@child: 
@Returns: True if @child is on some level a child (grandchild...) of the @node.


<!-- ##### FUNCTION gtk_ctree_is_ancestor ##### -->
<para>

</para>

@ctree: 
@node: 
@child: 
@Returns: True is @node is an ancestor of @child.


<!-- ##### FUNCTION gtk_ctree_find_by_row_data ##### -->
<para>
Finds a node in the tree under @node that has the given user data pointer.
</para>

@ctree: 
@node: 
@data: 
@Returns: The node, or %NULL if not found.


<!-- ##### FUNCTION gtk_ctree_find_all_by_row_data ##### -->
<para>
Finds all nodes in the tree under @node that have the given user data pointer.
</para>

@ctree: 
@node: 
@data: 
@Returns: A list of nodes that have the given data pointer.


<!-- ##### FUNCTION gtk_ctree_find_by_row_data_custom ##### -->
<para>
Find the first node under @node whose row data pointer fulfills 
a custom criterion.
</para>

@ctree: 
@node: The node where to start searching.
@data: User data for the criterion function.
@func: The criterion function.
@Returns: The first node found.


<!-- ##### FUNCTION gtk_ctree_find_all_by_row_data_custom ##### -->
<para>
Find all nodes under @node whose row data pointer fulfills 
a custom criterion.

</para>

@ctree: 
@node: The node where to start searching.
@data: User data for the criterion function.
@func: The criterion function.
@Returns: A list of all nodes found.


<!-- ##### FUNCTION gtk_ctree_is_hot_spot ##### -->
<para>
</para>

@ctree: 
@x: 
@y: 
@Returns: True if the given coordinates lie on an expander button.


<!-- ##### FUNCTION gtk_ctree_move ##### -->
<para>
Move a node in the tree to another location.
</para>

@ctree: 
@node: The node to be moved.
@new_parent: The new parent-to-be of the node.
@new_sibling: The new sibling-to-be of the node.


<!-- ##### FUNCTION gtk_ctree_expand ##### -->
<para>
Expand one node.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_expand_recursive ##### -->
<para>
Expand one node and all nodes underneath.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_expand_to_depth ##### -->
<para>
Expand a node and its children up to the depth given.
</para>

@ctree: 
@node: 
@depth: The (absolute) depth up to which to expand nodes.


<!-- ##### FUNCTION gtk_ctree_collapse ##### -->
<para>
Collapse one node.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_collapse_recursive ##### -->
<para>
Collapse one node and all its subnodes.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_collapse_to_depth ##### -->
<para>
Collapse a node and its children up to the depth given.
</para>

@ctree: 
@node: 
@depth: The (absolute) depth up to which to collapse nodes.


<!-- ##### FUNCTION gtk_ctree_toggle_expansion ##### -->
<para>
Toggle a node, i.e. if it is collapsed, expand it and vice versa.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_toggle_expansion_recursive ##### -->
<para>
Toggle the expansion of a node and all its children.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_select ##### -->
<para>
Cause the given node to be selected and emit the appropriate signal.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_select_recursive ##### -->
<para>
Cause the given node and its subnodes to be selected and emit the appropriate signal(s).
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_unselect ##### -->
<para>
Unselect the given node and emit the appropriate signal.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_unselect_recursive ##### -->
<para>
Unselect the given node and its subnodes and emit the appropriate signal(s).
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_real_select_recursive ##### -->
<para>
The function that implements both #gtk_ctree_select_recursive and
#gtk_ctree_unselect_recursive.
</para>

@ctree: 
@node: 
@state: True for selecting, false for unselecting.


<!-- ##### FUNCTION gtk_ctree_node_set_text ##### -->
<para>
Set the text in a node.
</para>

@ctree: 
@node: 
@column: The column whose text to change.
@text: The new text.


<!-- ##### FUNCTION gtk_ctree_node_set_pixmap ##### -->
<para>
FIXME
</para>

@ctree: 
@node: 
@column: 
@pixmap: 
@mask: 


<!-- ##### FUNCTION gtk_ctree_node_set_pixtext ##### -->
<para>
FIXME
</para>

@ctree: 
@node: 
@column: 
@text: 
@spacing: 
@pixmap: 
@mask: 


<!-- ##### FUNCTION gtk_ctree_set_node_info ##### -->
<para>
Change the information. Most parameters correspond 
to the parameters of #gtk_ctree_insert_node.
</para>

@ctree: 
@node: 
@text: The text to be in the tree column.
@spacing: 
@pixmap_closed: 
@mask_closed: 
@pixmap_opened: 
@mask_opened: 
@is_leaf: 
@expanded: 


<!-- ##### FUNCTION gtk_ctree_node_set_shift ##### -->
<para>
Shift the given cell the given amounts in pixels.
</para>

@ctree: 
@node: 
@column: 
@vertical: 
@horizontal: 


<!-- ##### FUNCTION gtk_ctree_node_set_selectable ##### -->
<para>

</para>

@ctree: 
@node: 
@selectable: Whether this node can be selected by the user.


<!-- ##### FUNCTION gtk_ctree_node_get_selectable ##### -->
<para>

</para>

@ctree: 
@node: 
@Returns: Whether this node can be selected by the user.


<!-- ##### FUNCTION gtk_ctree_node_get_cell_type ##### -->
<para>

</para>

@ctree: 
@node: 
@column: 
@Returns: The type of the given cell.


<!-- ##### FUNCTION gtk_ctree_node_get_text ##### -->
<para>

</para>

@ctree: 
@node: 
@column: 
@text: If nonnull, the pointer to the text string is assigned to *@text.
@Returns: True if the given cell has text in it.


<!-- ##### FUNCTION gtk_ctree_node_get_pixmap ##### -->
<para>

</para>

@ctree: 
@node: 
@column: 
@pixmap: If nonnull, the pointer to the pixmap is returned through this.
@mask: If nonnull, the pointer to the mask is returned through this.
@Returns: True if the given cell contains a pixmap.


<!-- ##### FUNCTION gtk_ctree_node_get_pixtext ##### -->
<para>
Get the parameters of a cell containing both a pixmap and text.
</para>

@ctree: 
@node: 
@column: 
@text: 
@spacing: 
@pixmap: 
@mask: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_get_node_info ##### -->
<para>
Get information corresponding to a node.
Any of the return parameters can be null. 
</para>

@ctree: 
@node: 
@text: 
@spacing: 
@pixmap_closed: 
@mask_closed: 
@pixmap_opened: 
@mask_opened: 
@is_leaf: 
@expanded: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_node_set_row_style ##### -->
<para>
Set the style of a row.
</para>

@ctree: 
@node: 
@style: 


<!-- ##### FUNCTION gtk_ctree_node_get_row_style ##### -->
<para>
Get the style of a row.
</para>

@ctree: 
@node: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_node_set_cell_style ##### -->
<para>
Set the style of an individual cell.
</para>

@ctree: 
@node: 
@column: 
@style: 


<!-- ##### FUNCTION gtk_ctree_node_get_cell_style ##### -->
<para>
Get the style of an individual cell.
</para>

@ctree: 
@node: 
@column: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_node_set_foreground ##### -->
<para>

</para>

@ctree: 
@node: 
@color: 


<!-- ##### FUNCTION gtk_ctree_node_set_background ##### -->
<para>

</para>

@ctree: 
@node: 
@color: 


<!-- ##### FUNCTION gtk_ctree_node_set_row_data ##### -->
<para>
Set the custom data associated with a node.
</para>

@ctree: 
@node: 
@data: 


<!-- ##### FUNCTION gtk_ctree_node_set_row_data_full ##### -->
<para>
This is the full interface to setting row data, so that a destructor
can be given for the data.
</para>

@ctree: 
@node: 
@data: 
@destroy: The routine to be called when @data is no longer needed.


<!-- ##### FUNCTION gtk_ctree_node_get_row_data ##### -->
<para>

</para>

@ctree: 
@node: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_node_moveto ##### -->
<para>
This function makes the given column of the given node visible by
scrolling.
</para>

@ctree: 
@node: The node to be made visible.
@column: The column to be made visible.
@row_align: Where in the window the row should appear.
@col_align: Where in the window the column should appear.


<!-- ##### FUNCTION gtk_ctree_node_is_visible ##### -->
<para>

</para>

@ctree: 
@node: 
@Returns: True if the node is currently inside the bounds of the window.
Note that this function can return true even if the node is not
viewable, if the node's ancestor is visible.


<!-- ##### FUNCTION gtk_ctree_set_indent ##### -->
<para>

</para>

@ctree: 
@indent: The number of pixels to shift the levels of the tree.


<!-- ##### FUNCTION gtk_ctree_set_spacing ##### -->
<para>
The spacing between the tree graphic and the actual node content.
</para>

@ctree: 
@spacing: 


<!-- ##### MACRO gtk_ctree_set_reorderable ##### -->
<para>

</para>

@t: 
@r: 


<!-- ##### FUNCTION gtk_ctree_set_line_style ##### -->
<para>

</para>

@ctree: 
@line_style: 


<!-- ##### FUNCTION gtk_ctree_set_expander_style ##### -->
<para>

</para>

@ctree: 
@expander_style: 


<!-- ##### FUNCTION gtk_ctree_set_drag_compare_func ##### -->
<para>
FIXME
</para>

@ctree: 
@cmp_func: 


<!-- ##### FUNCTION gtk_ctree_sort_node ##### -->
<para>
Sort the children of a node. See #GtkCList for how to set the sorting
criteria etc.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_sort_recursive ##### -->
<para>
Sort the descendants of a node. See #GtkCList for how to set the sorting
criteria etc.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_node_nth ##### -->
<para>

</para>

@ctree: 
@row: 
@Returns: The node corresponding to the @row th row.


<!-- ##### FUNCTION gtk_ctree_set_show_stub ##### -->
<para>

</para>

@ctree: 
@show_stub: