← Back to branch summary

~ubuntu-branches/ubuntu/raring/gtk+2.0/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gtk/tmpl/gtktreeview.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/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
<para>
 
14
Please refer to the <link linkend="TreeWidget">tree widget conceptual 
 
15
overview</link> for an overview of all the objects and data types related 
 
16
to the tree widget and how they work together.
 
17
</para>
 
18
 
 
19
<para>
 
20
Several different coordinate systems are exposed in the GtkTreeView API.
 
21
These are:
 
22
 
 
23
<inlinegraphic fileref="tree-view-coordinates.png" format="PNG"></inlinegraphic>
 
24
 
 
25
  <simplelist>
 
26
    <member>Widget coordinates -- coordinates relative to the widget 
 
27
    (usually <literal>widget-&gt;window</literal>.</member>
 
28
    <member>Bin window coordinates -- coordinates relative to the window 
 
29
    that GtkTreeView renders to.</member>
 
30
    <member>Tree coordinates -- coordinates relative to the entire scrollable 
 
31
    area of GtkTreeView.  These coordinates start at (0, 0) for row 0 of the 
 
32
    tree.</member>
 
33
  </simplelist>
 
34
</para>
 
35
 
 
36
<para>
 
37
Several functions are available for converting between the different
 
38
coordinate systems.  The most common translations are between widget and bin 
 
39
window coordinates and between bin window and tree coordinates.  For the 
 
40
former you can use gtk_tree_view_convert_widget_to_bin_window_coords()
 
41
(and vice versa), for the latter gtk_tree_view_convert_bin_window_to_tree_coords() 
 
42
(and vice versa).
 
43
</para>
 
44
 
 
45
<refsect2 id="GtkTreeView-BUILDER-UI">
 
46
<title>GtkTreeView as GtkBuildable</title>
 
47
<para>
 
48
The GtkTreeView implementation of the GtkBuildable interface accepts
 
49
GtkTreeViewColumn objects as &lt;child&gt; elements and exposes the
 
50
internal GtkTreeSelection in UI definitions.
 
51
</para>
 
52
<example>
 
53
<title>A UI definition fragment with GtkTreeView</title>
 
54
<programlisting><![CDATA[
 
55
<object class="GtkTreeView" id="treeview">
 
56
  <property name="model">liststore1</property>
 
57
  <child>
 
58
    <object class="GtkTreeViewColumn" id="test-column">
 
59
      <property name="title">Test</property>
 
60
      <child>
 
61
        <object class="GtkCellRendererText" id="test-renderer"/>
 
62
        <attributes>
 
63
          <attribute name="text">1</attribute>
 
64
        </attributes>
 
65
      </child>
 
66
    </object>
 
67
  </child>
 
68
  <child internal-child="selection">
 
69
    <object class="GtkTreeSelection" id="selection">
 
70
      <signal name="changed" handler="on_treeview_selection_changed"/>
 
71
    </object>
 
72
  </child>
 
73
</object>
 
74
]]></programlisting>
 
75
</example>
 
76
</refsect2>
 
77
 
 
78
<!-- ##### SECTION See_Also ##### -->
 
79
<para>
 
80
#GtkTreeViewColumn, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
 
81
</para>
 
82
 
 
83
<!-- ##### SECTION Stability_Level ##### -->
 
84
 
 
85
 
 
86
<!-- ##### SECTION Image ##### -->
 
87
 
 
88
 
 
89
<!-- ##### STRUCT GtkTreeView ##### -->
 
90
<para>
 
91
 
 
92
</para>
 
93
 
 
94
 
 
95
<!-- ##### SIGNAL GtkTreeView::columns-changed ##### -->
 
96
<para>
 
97
 
 
98
</para>
 
99
 
 
100
@tree_view: the object which received the signal.
 
101
 
 
102
<!-- ##### SIGNAL GtkTreeView::cursor-changed ##### -->
 
103
<para>
 
104
 
 
105
</para>
 
106
 
 
107
@tree_view: the object which received the signal.
 
108
 
 
109
<!-- ##### SIGNAL GtkTreeView::expand-collapse-cursor-row ##### -->
 
110
<para>
 
111
 
 
112
</para>
 
113
 
 
114
@tree_view: the object which received the signal.
 
115
@arg1: 
 
116
@arg2: 
 
117
@arg3: 
 
118
@Returns: 
 
119
 
 
120
<!-- ##### SIGNAL GtkTreeView::move-cursor ##### -->
 
121
<para>
 
122
 
 
123
</para>
 
124
 
 
125
@tree_view: the object which received the signal.
 
126
@arg1: 
 
127
@arg2: 
 
128
@Returns: 
 
129
 
 
130
<!-- ##### SIGNAL GtkTreeView::row-activated ##### -->
 
131
<para>
 
132
 
 
133
</para>
 
134
 
 
135
@tree_view: the object which received the signal.
 
136
@arg1: 
 
137
@arg2: 
 
138
 
 
139
<!-- ##### SIGNAL GtkTreeView::row-collapsed ##### -->
 
140
<para>
 
141
 
 
142
</para>
 
143
 
 
144
@tree_view: the object which received the signal.
 
145
@arg1: 
 
146
@arg2: 
 
147
 
 
148
<!-- ##### SIGNAL GtkTreeView::row-expanded ##### -->
 
149
<para>
 
150
 
 
151
</para>
 
152
 
 
153
@tree_view: the object which received the signal.
 
154
@arg1: 
 
155
@arg2: 
 
156
 
 
157
<!-- ##### SIGNAL GtkTreeView::select-all ##### -->
 
158
<para>
 
159
 
 
160
</para>
 
161
 
 
162
@tree_view: the object which received the signal.
 
163
@Returns: 
 
164
 
 
165
<!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
 
166
<para>
 
167
 
 
168
</para>
 
169
 
 
170
@tree_view: the object which received the signal.
 
171
@Returns: 
 
172
 
 
173
<!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
 
174
<para>
 
175
 
 
176
</para>
 
177
 
 
178
@tree_view: the object which received the signal.
 
179
@arg1: 
 
180
@Returns: 
 
181
 
 
182
<!-- ##### SIGNAL GtkTreeView::set-scroll-adjustments ##### -->
 
183
<para>
 
184
 
 
185
</para>
 
186
 
 
187
@tree_view: the object which received the signal.
 
188
@arg1: 
 
189
@arg2: 
 
190
 
 
191
<!-- ##### SIGNAL GtkTreeView::start-interactive-search ##### -->
 
192
<para>
 
193
 
 
194
</para>
 
195
 
 
196
@tree_view: the object which received the signal.
 
197
@Returns: 
 
198
 
 
199
<!-- ##### SIGNAL GtkTreeView::test-collapse-row ##### -->
 
200
<para>
 
201
 
 
202
</para>
 
203
 
 
204
@tree_view: the object which received the signal.
 
205
@arg1: 
 
206
@arg2: 
 
207
@Returns: 
 
208
 
 
209
<!-- ##### SIGNAL GtkTreeView::test-expand-row ##### -->
 
210
<para>
 
211
 
 
212
</para>
 
213
 
 
214
@tree_view: the object which received the signal.
 
215
@arg1: 
 
216
@arg2: 
 
217
@Returns: 
 
218
 
 
219
<!-- ##### SIGNAL GtkTreeView::toggle-cursor-row ##### -->
 
220
<para>
 
221
 
 
222
</para>
 
223
 
 
224
@tree_view: the object which received the signal.
 
225
@Returns: 
 
226
 
 
227
<!-- ##### SIGNAL GtkTreeView::unselect-all ##### -->
 
228
<para>
 
229
 
 
230
</para>
 
231
 
 
232
@tree_view: the object which received the signal.
 
233
@Returns: 
 
234
 
 
235
<!-- ##### ARG GtkTreeView:enable-grid-lines ##### -->
 
236
<para>
 
237
 
 
238
</para>
 
239
 
 
240
<!-- ##### ARG GtkTreeView:enable-search ##### -->
 
241
<para>
 
242
 
 
243
</para>
 
244
 
 
245
<!-- ##### ARG GtkTreeView:enable-tree-lines ##### -->
 
246
<para>
 
247
 
 
248
</para>
 
249
 
 
250
<!-- ##### ARG GtkTreeView:expander-column ##### -->
 
251
<para>
 
252
 
 
253
</para>
 
254
 
 
255
<!-- ##### ARG GtkTreeView:fixed-height-mode ##### -->
 
256
<para>
 
257
 
 
258
</para>
 
259
 
 
260
<!-- ##### ARG GtkTreeView:hadjustment ##### -->
 
261
<para>
 
262
 
 
263
</para>
 
264
 
 
265
<!-- ##### ARG GtkTreeView:headers-clickable ##### -->
 
266
<para>
 
267
 
 
268
</para>
 
269
 
 
270
<!-- ##### ARG GtkTreeView:headers-visible ##### -->
 
271
<para>
 
272
 
 
273
</para>
 
274
 
 
275
<!-- ##### ARG GtkTreeView:hover-expand ##### -->
 
276
<para>
 
277
 
 
278
</para>
 
279
 
 
280
<!-- ##### ARG GtkTreeView:hover-selection ##### -->
 
281
<para>
 
282
 
 
283
</para>
 
284
 
 
285
<!-- ##### ARG GtkTreeView:level-indentation ##### -->
 
286
<para>
 
287
 
 
288
</para>
 
289
 
 
290
<!-- ##### ARG GtkTreeView:model ##### -->
 
291
<para>
 
292
 
 
293
</para>
 
294
 
 
295
<!-- ##### ARG GtkTreeView:reorderable ##### -->
 
296
<para>
 
297
 
 
298
</para>
 
299
 
 
300
<!-- ##### ARG GtkTreeView:rubber-banding ##### -->
 
301
<para>
 
302
 
 
303
</para>
 
304
 
 
305
<!-- ##### ARG GtkTreeView:rules-hint ##### -->
 
306
<para>
 
307
 
 
308
</para>
 
309
 
 
310
<!-- ##### ARG GtkTreeView:search-column ##### -->
 
311
<para>
 
312
 
 
313
</para>
 
314
 
 
315
<!-- ##### ARG GtkTreeView:show-expanders ##### -->
 
316
<para>
 
317
 
 
318
</para>
 
319
 
 
320
<!-- ##### ARG GtkTreeView:tooltip-column ##### -->
 
321
<para>
 
322
 
 
323
</para>
 
324
 
 
325
<!-- ##### ARG GtkTreeView:vadjustment ##### -->
 
326
<para>
 
327
 
 
328
</para>
 
329
 
 
330
<!-- ##### ARG GtkTreeView:allow-rules ##### -->
 
331
<para>
 
332
 
 
333
</para>
 
334
 
 
335
<!-- ##### ARG GtkTreeView:even-row-color ##### -->
 
336
<para>
 
337
 
 
338
</para>
 
339
 
 
340
<!-- ##### ARG GtkTreeView:expander-size ##### -->
 
341
<para>
 
342
 
 
343
</para>
 
344
 
 
345
<!-- ##### ARG GtkTreeView:grid-line-pattern ##### -->
 
346
<para>
 
347
 
 
348
</para>
 
349
 
 
350
<!-- ##### ARG GtkTreeView:grid-line-width ##### -->
 
351
<para>
 
352
 
 
353
</para>
 
354
 
 
355
<!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
 
356
<para>
 
357
 
 
358
</para>
 
359
 
 
360
<!-- ##### ARG GtkTreeView:indent-expanders ##### -->
 
361
<para>
 
362
 
 
363
</para>
 
364
 
 
365
<!-- ##### ARG GtkTreeView:odd-row-color ##### -->
 
366
<para>
 
367
 
 
368
</para>
 
369
 
 
370
<!-- ##### ARG GtkTreeView:row-ending-details ##### -->
 
371
<para>
 
372
 
 
373
</para>
 
374
 
 
375
<!-- ##### ARG GtkTreeView:tree-line-pattern ##### -->
 
376
<para>
 
377
 
 
378
</para>
 
379
 
 
380
<!-- ##### ARG GtkTreeView:tree-line-width ##### -->
 
381
<para>
 
382
 
 
383
</para>
 
384
 
 
385
<!-- ##### ARG GtkTreeView:vertical-separator ##### -->
 
386
<para>
 
387
 
 
388
</para>
 
389
 
 
390
<!-- ##### ENUM GtkTreeViewDropPosition ##### -->
 
391
<para>
 
392
An enum for determining where a dropped row goes.
 
393
</para>
 
394
 
 
395
@GTK_TREE_VIEW_DROP_BEFORE: dropped row is inserted before
 
396
@GTK_TREE_VIEW_DROP_AFTER: dropped row is inserted after
 
397
@GTK_TREE_VIEW_DROP_INTO_OR_BEFORE: dropped row becomes a child or is inserted before
 
398
@GTK_TREE_VIEW_DROP_INTO_OR_AFTER: dropped row becomes a child or is inserted after
 
399
 
 
400
<!-- ##### STRUCT GtkTreeViewPrivate ##### -->
 
401
<para>
 
402
A private struct for internal use only.  The definition of this
 
403
structure is not publically available.
 
404
</para>
 
405
 
 
406
 
 
407
<!-- ##### USER_FUNCTION GtkTreeViewColumnDropFunc ##### -->
 
408
<para>
 
409
Function type for determining whether @column can be dropped in a
 
410
particular spot (as determined by @prev_column and @next_column).  In
 
411
left to right locales, @prev_column is on the left of the potential drop
 
412
spot, and @next_column is on the right.  In right to left mode, this is
 
413
reversed.  This function should return %TRUE if the spot is a valid drop
 
414
spot.  Please note that returning %TRUE does not actually indicate that
 
415
the column drop was made, but is meant only to indicate a possible drop
 
416
spot to the user.
 
417
</para>
 
418
 
 
419
@tree_view: A #GtkTreeView
 
420
@column: The #GtkTreeViewColumn being dragged
 
421
@prev_column: A #GtkTreeViewColumn on one side of @column
 
422
@next_column: A #GtkTreeViewColumn on the other side of @column
 
423
@data: user data
 
424
@Returns: %TRUE, if #column can be dropped in this spot
 
425
 
 
426
 
 
427
<!-- ##### USER_FUNCTION GtkTreeViewMappingFunc ##### -->
 
428
<para>
 
429
Function used for #gtk_tree_view_map_expanded_rows.
 
430
</para>
 
431
 
 
432
@tree_view: A #GtkTreeView
 
433
@path: The path that's expanded
 
434
@user_data: user data
 
435
 
 
436
 
 
437
<!-- ##### USER_FUNCTION GtkTreeViewSearchEqualFunc ##### -->
 
438
<para>
 
439
A function used for checking whether a row in @model matches
 
440
a search key string entered by the user. Note the return value
 
441
is reversed from what you would normally expect, though it
 
442
has some similarity to strcmp() returning 0 for equal strings.
 
443
</para>
 
444
 
 
445
@model: the #GtkTreeModel being searched
 
446
@column: the search column set by gtk_tree_view_set_search_column()
 
447
@key: the key string to compare with
 
448
@iter: a #GtkTreeIter pointing the row of @model that should be compared
 
449
  with @key.
 
450
@search_data: user data from gtk_tree_view_set_search_equal_func()
 
451
@Returns: %FALSE if the row matches, %TRUE otherwise.
 
452
 
 
453
 
 
454
<!-- ##### FUNCTION gtk_tree_view_new ##### -->
 
455
<para>
 
456
 
 
457
</para>
 
458
 
 
459
@void: 
 
460
@Returns: 
 
461
 
 
462
 
 
463
<!-- ##### FUNCTION gtk_tree_view_get_level_indentation ##### -->
 
464
<para>
 
465
 
 
466
</para>
 
467
 
 
468
@tree_view: 
 
469
@Returns: 
 
470
 
 
471
 
 
472
<!-- ##### FUNCTION gtk_tree_view_get_show_expanders ##### -->
 
473
<para>
 
474
 
 
475
</para>
 
476
 
 
477
@tree_view: 
 
478
@Returns: 
 
479
 
 
480
 
 
481
<!-- ##### FUNCTION gtk_tree_view_set_level_indentation ##### -->
 
482
<para>
 
483
 
 
484
</para>
 
485
 
 
486
@tree_view: 
 
487
@indentation: 
 
488
 
 
489
 
 
490
<!-- ##### FUNCTION gtk_tree_view_set_show_expanders ##### -->
 
491
<para>
 
492
 
 
493
</para>
 
494
 
 
495
@tree_view: 
 
496
@enabled: 
 
497
 
 
498
 
 
499
<!-- ##### FUNCTION gtk_tree_view_new_with_model ##### -->
 
500
<para>
 
501
 
 
502
</para>
 
503
 
 
504
@model: 
 
505
@Returns: 
 
506
 
 
507
 
 
508
<!-- ##### FUNCTION gtk_tree_view_get_model ##### -->
 
509
<para>
 
510
 
 
511
</para>
 
512
 
 
513
@tree_view: 
 
514
@Returns: 
 
515
 
 
516
 
 
517
<!-- ##### FUNCTION gtk_tree_view_set_model ##### -->
 
518
<para>
 
519
 
 
520
</para>
 
521
 
 
522
@tree_view: 
 
523
@model: 
 
524
 
 
525
 
 
526
<!-- ##### FUNCTION gtk_tree_view_get_selection ##### -->
 
527
<para>
 
528
 
 
529
</para>
 
530
 
 
531
@tree_view: 
 
532
@Returns: 
 
533
 
 
534
 
 
535
<!-- ##### FUNCTION gtk_tree_view_get_hadjustment ##### -->
 
536
<para>
 
537
 
 
538
</para>
 
539
 
 
540
@tree_view: 
 
541
@Returns: 
 
542
 
 
543
 
 
544
<!-- ##### FUNCTION gtk_tree_view_set_hadjustment ##### -->
 
545
<para>
 
546
 
 
547
</para>
 
548
 
 
549
@tree_view: 
 
550
@adjustment: 
 
551
 
 
552
 
 
553
<!-- ##### FUNCTION gtk_tree_view_get_vadjustment ##### -->
 
554
<para>
 
555
 
 
556
</para>
 
557
 
 
558
@tree_view: 
 
559
@Returns: 
 
560
 
 
561
 
 
562
<!-- ##### FUNCTION gtk_tree_view_set_vadjustment ##### -->
 
563
<para>
 
564
 
 
565
</para>
 
566
 
 
567
@tree_view: 
 
568
@adjustment: 
 
569
 
 
570
 
 
571
<!-- ##### FUNCTION gtk_tree_view_get_headers_visible ##### -->
 
572
<para>
 
573
 
 
574
</para>
 
575
 
 
576
@tree_view: 
 
577
@Returns: 
 
578
 
 
579
 
 
580
<!-- ##### FUNCTION gtk_tree_view_set_headers_visible ##### -->
 
581
<para>
 
582
 
 
583
</para>
 
584
 
 
585
@tree_view: 
 
586
@headers_visible: 
 
587
 
 
588
 
 
589
<!-- ##### FUNCTION gtk_tree_view_columns_autosize ##### -->
 
590
<para>
 
591
 
 
592
</para>
 
593
 
 
594
@tree_view: 
 
595
 
 
596
 
 
597
<!-- ##### FUNCTION gtk_tree_view_get_headers_clickable ##### -->
 
598
<para>
 
599
 
 
600
</para>
 
601
 
 
602
@tree_view: 
 
603
@Returns: 
 
604
 
 
605
 
 
606
<!-- ##### FUNCTION gtk_tree_view_set_headers_clickable ##### -->
 
607
<para>
 
608
 
 
609
</para>
 
610
 
 
611
@tree_view: 
 
612
@setting: 
 
613
 
 
614
 
 
615
<!-- ##### FUNCTION gtk_tree_view_set_rules_hint ##### -->
 
616
<para>
 
617
 
 
618
</para>
 
619
 
 
620
@tree_view: 
 
621
@setting: 
 
622
 
 
623
 
 
624
<!-- ##### FUNCTION gtk_tree_view_get_rules_hint ##### -->
 
625
<para>
 
626
 
 
627
</para>
 
628
 
 
629
@tree_view: 
 
630
@Returns: 
 
631
 
 
632
 
 
633
<!-- ##### FUNCTION gtk_tree_view_append_column ##### -->
 
634
<para>
 
635
 
 
636
</para>
 
637
 
 
638
@tree_view: 
 
639
@column: 
 
640
@Returns: 
 
641
 
 
642
 
 
643
<!-- ##### FUNCTION gtk_tree_view_remove_column ##### -->
 
644
<para>
 
645
 
 
646
</para>
 
647
 
 
648
@tree_view: 
 
649
@column: 
 
650
@Returns: 
 
651
 
 
652
 
 
653
<!-- ##### FUNCTION gtk_tree_view_insert_column ##### -->
 
654
<para>
 
655
 
 
656
</para>
 
657
 
 
658
@tree_view: 
 
659
@column: 
 
660
@position: 
 
661
@Returns: 
 
662
 
 
663
 
 
664
<!-- ##### FUNCTION gtk_tree_view_insert_column_with_attributes ##### -->
 
665
<para>
 
666
 
 
667
</para>
 
668
 
 
669
@tree_view: 
 
670
@position: 
 
671
@title: 
 
672
@cell: 
 
673
@...: 
 
674
@Returns: 
 
675
 
 
676
 
 
677
<!-- ##### FUNCTION gtk_tree_view_insert_column_with_data_func ##### -->
 
678
<para>
 
679
 
 
680
</para>
 
681
 
 
682
@tree_view: 
 
683
@position: 
 
684
@title: 
 
685
@cell: 
 
686
@func: 
 
687
@data: 
 
688
@dnotify: 
 
689
@Returns: 
 
690
 
 
691
 
 
692
<!-- ##### FUNCTION gtk_tree_view_get_column ##### -->
 
693
<para>
 
694
 
 
695
</para>
 
696
 
 
697
@tree_view: 
 
698
@n: 
 
699
@Returns: 
 
700
 
 
701
 
 
702
<!-- ##### FUNCTION gtk_tree_view_get_columns ##### -->
 
703
<para>
 
704
 
 
705
</para>
 
706
 
 
707
@tree_view: 
 
708
@Returns: 
 
709
 
 
710
 
 
711
<!-- ##### FUNCTION gtk_tree_view_move_column_after ##### -->
 
712
<para>
 
713
 
 
714
</para>
 
715
 
 
716
@tree_view: 
 
717
@column: 
 
718
@base_column: 
 
719
 
 
720
 
 
721
<!-- ##### FUNCTION gtk_tree_view_set_expander_column ##### -->
 
722
<para>
 
723
 
 
724
</para>
 
725
 
 
726
@tree_view: 
 
727
@column: 
 
728
 
 
729
 
 
730
<!-- ##### FUNCTION gtk_tree_view_get_expander_column ##### -->
 
731
<para>
 
732
 
 
733
</para>
 
734
 
 
735
@tree_view: 
 
736
@Returns: 
 
737
 
 
738
 
 
739
<!-- ##### FUNCTION gtk_tree_view_set_column_drag_function ##### -->
 
740
<para>
 
741
 
 
742
</para>
 
743
 
 
744
@tree_view: 
 
745
@func: 
 
746
@user_data: 
 
747
@destroy: 
 
748
 
 
749
 
 
750
<!-- ##### FUNCTION gtk_tree_view_scroll_to_point ##### -->
 
751
<para>
 
752
 
 
753
</para>
 
754
 
 
755
@tree_view: 
 
756
@tree_x: 
 
757
@tree_y: 
 
758
 
 
759
 
 
760
<!-- ##### FUNCTION gtk_tree_view_scroll_to_cell ##### -->
 
761
<para>
 
762
 
 
763
</para>
 
764
 
 
765
@tree_view: 
 
766
@path: 
 
767
@column: 
 
768
@use_align: 
 
769
@row_align: 
 
770
@col_align: 
 
771
 
 
772
 
 
773
<!-- ##### FUNCTION gtk_tree_view_set_cursor ##### -->
 
774
<para>
 
775
 
 
776
</para>
 
777
 
 
778
@tree_view: 
 
779
@path: 
 
780
@focus_column: 
 
781
@start_editing: 
 
782
 
 
783
 
 
784
<!-- ##### FUNCTION gtk_tree_view_set_cursor_on_cell ##### -->
 
785
<para>
 
786
 
 
787
</para>
 
788
 
 
789
@tree_view: 
 
790
@path: 
 
791
@focus_column: 
 
792
@focus_cell: 
 
793
@start_editing: 
 
794
 
 
795
 
 
796
<!-- ##### FUNCTION gtk_tree_view_get_cursor ##### -->
 
797
<para>
 
798
 
 
799
</para>
 
800
 
 
801
@tree_view: 
 
802
@path: 
 
803
@focus_column: 
 
804
 
 
805
 
 
806
<!-- ##### FUNCTION gtk_tree_view_row_activated ##### -->
 
807
<para>
 
808
 
 
809
</para>
 
810
 
 
811
@tree_view: 
 
812
@path: 
 
813
@column: 
 
814
 
 
815
 
 
816
<!-- ##### FUNCTION gtk_tree_view_expand_all ##### -->
 
817
<para>
 
818
 
 
819
</para>
 
820
 
 
821
@tree_view: 
 
822
 
 
823
 
 
824
<!-- ##### FUNCTION gtk_tree_view_collapse_all ##### -->
 
825
<para>
 
826
 
 
827
</para>
 
828
 
 
829
@tree_view: 
 
830
 
 
831
 
 
832
<!-- ##### FUNCTION gtk_tree_view_expand_to_path ##### -->
 
833
<para>
 
834
 
 
835
</para>
 
836
 
 
837
@tree_view: 
 
838
@path: 
 
839
 
 
840
 
 
841
<!-- ##### FUNCTION gtk_tree_view_expand_row ##### -->
 
842
<para>
 
843
 
 
844
</para>
 
845
 
 
846
@tree_view: 
 
847
@path: 
 
848
@open_all: 
 
849
@Returns: 
 
850
 
 
851
 
 
852
<!-- ##### FUNCTION gtk_tree_view_collapse_row ##### -->
 
853
<para>
 
854
 
 
855
</para>
 
856
 
 
857
@tree_view: 
 
858
@path: 
 
859
@Returns: 
 
860
 
 
861
 
 
862
<!-- ##### FUNCTION gtk_tree_view_map_expanded_rows ##### -->
 
863
<para>
 
864
 
 
865
</para>
 
866
 
 
867
@tree_view: 
 
868
@func: 
 
869
@data: 
 
870
 
 
871
 
 
872
<!-- ##### FUNCTION gtk_tree_view_row_expanded ##### -->
 
873
<para>
 
874
 
 
875
</para>
 
876
 
 
877
@tree_view: 
 
878
@path: 
 
879
@Returns: 
 
880
 
 
881
 
 
882
<!-- ##### FUNCTION gtk_tree_view_set_reorderable ##### -->
 
883
<para>
 
884
 
 
885
</para>
 
886
 
 
887
@tree_view: 
 
888
@reorderable: 
 
889
 
 
890
 
 
891
<!-- ##### FUNCTION gtk_tree_view_get_reorderable ##### -->
 
892
<para>
 
893
 
 
894
</para>
 
895
 
 
896
@tree_view: 
 
897
@Returns: 
 
898
 
 
899
 
 
900
<!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### -->
 
901
<para>
 
902
 
 
903
</para>
 
904
 
 
905
@tree_view: 
 
906
@x: 
 
907
@y: 
 
908
@path: 
 
909
@column: 
 
910
@cell_x: 
 
911
@cell_y: 
 
912
@Returns: 
 
913
 
 
914
 
 
915
<!-- ##### FUNCTION gtk_tree_view_get_cell_area ##### -->
 
916
<para>
 
917
 
 
918
</para>
 
919
 
 
920
@tree_view: 
 
921
@path: 
 
922
@column: 
 
923
@rect: 
 
924
 
 
925
 
 
926
<!-- ##### FUNCTION gtk_tree_view_get_background_area ##### -->
 
927
<para>
 
928
 
 
929
</para>
 
930
 
 
931
@tree_view: 
 
932
@path: 
 
933
@column: 
 
934
@rect: 
 
935
 
 
936
 
 
937
<!-- ##### FUNCTION gtk_tree_view_get_visible_rect ##### -->
 
938
<para>
 
939
 
 
940
</para>
 
941
 
 
942
@tree_view: 
 
943
@visible_rect: 
 
944
 
 
945
 
 
946
<!-- ##### FUNCTION gtk_tree_view_get_visible_range ##### -->
 
947
<para>
 
948
 
 
949
</para>
 
950
 
 
951
@tree_view: 
 
952
@start_path: 
 
953
@end_path: 
 
954
@Returns: 
 
955
 
 
956
 
 
957
<!-- ##### FUNCTION gtk_tree_view_get_bin_window ##### -->
 
958
<para>
 
959
 
 
960
</para>
 
961
 
 
962
@tree_view: 
 
963
@Returns: 
 
964
 
 
965
 
 
966
<!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
 
967
<para>
 
968
 
 
969
</para>
 
970
 
 
971
@tree_view: 
 
972
@wx: 
 
973
@wy: 
 
974
@tx: 
 
975
@ty: 
 
976
 
 
977
 
 
978
<!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
 
979
<para>
 
980
 
 
981
</para>
 
982
 
 
983
@tree_view: 
 
984
@tx: 
 
985
@ty: 
 
986
@wx: 
 
987
@wy: 
 
988
 
 
989
 
 
990
<!-- ##### FUNCTION gtk_tree_view_convert_bin_window_to_tree_coords ##### -->
 
991
<para>
 
992
 
 
993
</para>
 
994
 
 
995
@tree_view: 
 
996
@bx: 
 
997
@by: 
 
998
@tx: 
 
999
@ty: 
 
1000
 
 
1001
 
 
1002
<!-- ##### FUNCTION gtk_tree_view_convert_bin_window_to_widget_coords ##### -->
 
1003
<para>
 
1004
 
 
1005
</para>
 
1006
 
 
1007
@tree_view: 
 
1008
@bx: 
 
1009
@by: 
 
1010
@wx: 
 
1011
@wy: 
 
1012
 
 
1013
 
 
1014
<!-- ##### FUNCTION gtk_tree_view_convert_tree_to_bin_window_coords ##### -->
 
1015
<para>
 
1016
 
 
1017
</para>
 
1018
 
 
1019
@tree_view: 
 
1020
@tx: 
 
1021
@ty: 
 
1022
@bx: 
 
1023
@by: 
 
1024
 
 
1025
 
 
1026
<!-- ##### FUNCTION gtk_tree_view_convert_tree_to_widget_coords ##### -->
 
1027
<para>
 
1028
 
 
1029
</para>
 
1030
 
 
1031
@tree_view: 
 
1032
@tx: 
 
1033
@ty: 
 
1034
@wx: 
 
1035
@wy: 
 
1036
 
 
1037
 
 
1038
<!-- ##### FUNCTION gtk_tree_view_convert_widget_to_bin_window_coords ##### -->
 
1039
<para>
 
1040
 
 
1041
</para>
 
1042
 
 
1043
@tree_view: 
 
1044
@wx: 
 
1045
@wy: 
 
1046
@bx: 
 
1047
@by: 
 
1048
 
 
1049
 
 
1050
<!-- ##### FUNCTION gtk_tree_view_convert_widget_to_tree_coords ##### -->
 
1051
<para>
 
1052
 
 
1053
</para>
 
1054
 
 
1055
@tree_view: 
 
1056
@wx: 
 
1057
@wy: 
 
1058
@tx: 
 
1059
@ty: 
 
1060
 
 
1061
 
 
1062
<!-- ##### FUNCTION gtk_tree_view_enable_model_drag_dest ##### -->
 
1063
<para>
 
1064
 
 
1065
</para>
 
1066
 
 
1067
@tree_view: 
 
1068
@targets: 
 
1069
@n_targets: 
 
1070
@actions: 
 
1071
 
 
1072
 
 
1073
<!-- ##### FUNCTION gtk_tree_view_enable_model_drag_source ##### -->
 
1074
<para>
 
1075
 
 
1076
</para>
 
1077
 
 
1078
@tree_view: 
 
1079
@start_button_mask: 
 
1080
@targets: 
 
1081
@n_targets: 
 
1082
@actions: 
 
1083
 
 
1084
 
 
1085
<!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_source ##### -->
 
1086
<para>
 
1087
 
 
1088
</para>
 
1089
 
 
1090
@tree_view: 
 
1091
 
 
1092
 
 
1093
<!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_dest ##### -->
 
1094
<para>
 
1095
 
 
1096
</para>
 
1097
 
 
1098
@tree_view: 
 
1099
 
 
1100
 
 
1101
<!-- ##### FUNCTION gtk_tree_view_set_drag_dest_row ##### -->
 
1102
<para>
 
1103
 
 
1104
</para>
 
1105
 
 
1106
@tree_view: 
 
1107
@path: 
 
1108
@pos: 
 
1109
 
 
1110
 
 
1111
<!-- ##### FUNCTION gtk_tree_view_get_drag_dest_row ##### -->
 
1112
<para>
 
1113
 
 
1114
</para>
 
1115
 
 
1116
@tree_view: 
 
1117
@path: 
 
1118
@pos: 
 
1119
 
 
1120
 
 
1121
<!-- ##### FUNCTION gtk_tree_view_get_dest_row_at_pos ##### -->
 
1122
<para>
 
1123
 
 
1124
</para>
 
1125
 
 
1126
@tree_view: 
 
1127
@drag_x: 
 
1128
@drag_y: 
 
1129
@path: 
 
1130
@pos: 
 
1131
@Returns: 
 
1132
 
 
1133
 
 
1134
<!-- ##### FUNCTION gtk_tree_view_create_row_drag_icon ##### -->
 
1135
<para>
 
1136
 
 
1137
</para>
 
1138
 
 
1139
@tree_view: 
 
1140
@path: 
 
1141
@Returns: 
 
1142
 
 
1143
 
 
1144
<!-- ##### FUNCTION gtk_tree_view_set_enable_search ##### -->
 
1145
<para>
 
1146
 
 
1147
</para>
 
1148
 
 
1149
@tree_view: 
 
1150
@enable_search: 
 
1151
 
 
1152
 
 
1153
<!-- ##### FUNCTION gtk_tree_view_get_enable_search ##### -->
 
1154
<para>
 
1155
 
 
1156
</para>
 
1157
 
 
1158
@tree_view: 
 
1159
@Returns: 
 
1160
 
 
1161
 
 
1162
<!-- ##### FUNCTION gtk_tree_view_get_search_column ##### -->
 
1163
<para>
 
1164
 
 
1165
</para>
 
1166
 
 
1167
@tree_view: 
 
1168
@Returns: 
 
1169
 
 
1170
 
 
1171
<!-- ##### FUNCTION gtk_tree_view_set_search_column ##### -->
 
1172
<para>
 
1173
 
 
1174
</para>
 
1175
 
 
1176
@tree_view: 
 
1177
@column: 
 
1178
 
 
1179
 
 
1180
<!-- ##### FUNCTION gtk_tree_view_get_search_equal_func ##### -->
 
1181
<para>
 
1182
 
 
1183
</para>
 
1184
 
 
1185
@tree_view: 
 
1186
@Returns: 
 
1187
 
 
1188
 
 
1189
<!-- ##### FUNCTION gtk_tree_view_set_search_equal_func ##### -->
 
1190
<para>
 
1191
 
 
1192
</para>
 
1193
 
 
1194
@tree_view: 
 
1195
@search_equal_func: 
 
1196
@search_user_data: 
 
1197
@search_destroy: 
 
1198
 
 
1199
 
 
1200
<!-- ##### FUNCTION gtk_tree_view_get_search_entry ##### -->
 
1201
<para>
 
1202
 
 
1203
</para>
 
1204
 
 
1205
@tree_view: 
 
1206
@Returns: 
 
1207
 
 
1208
 
 
1209
<!-- ##### FUNCTION gtk_tree_view_set_search_entry ##### -->
 
1210
<para>
 
1211
 
 
1212
</para>
 
1213
 
 
1214
@tree_view: 
 
1215
@entry: 
 
1216
 
 
1217
 
 
1218
<!-- ##### USER_FUNCTION GtkTreeViewSearchPositionFunc ##### -->
 
1219
<para>
 
1220
 
 
1221
</para>
 
1222
 
 
1223
@tree_view: 
 
1224
@search_dialog: 
 
1225
@user_data: 
 
1226
 
 
1227
 
 
1228
<!-- ##### FUNCTION gtk_tree_view_get_search_position_func ##### -->
 
1229
<para>
 
1230
 
 
1231
</para>
 
1232
 
 
1233
@tree_view: 
 
1234
@Returns: 
 
1235
 
 
1236
 
 
1237
<!-- ##### FUNCTION gtk_tree_view_set_search_position_func ##### -->
 
1238
<para>
 
1239
 
 
1240
</para>
 
1241
 
 
1242
@tree_view: 
 
1243
@func: 
 
1244
@data: 
 
1245
@destroy: 
 
1246
 
 
1247
 
 
1248
<!-- ##### FUNCTION gtk_tree_view_get_fixed_height_mode ##### -->
 
1249
<para>
 
1250
 
 
1251
</para>
 
1252
 
 
1253
@tree_view: 
 
1254
@Returns: 
 
1255
 
 
1256
 
 
1257
<!-- ##### FUNCTION gtk_tree_view_set_fixed_height_mode ##### -->
 
1258
<para>
 
1259
 
 
1260
</para>
 
1261
 
 
1262
@tree_view: 
 
1263
@enable: 
 
1264
 
 
1265
 
 
1266
<!-- ##### FUNCTION gtk_tree_view_get_hover_selection ##### -->
 
1267
<para>
 
1268
 
 
1269
</para>
 
1270
 
 
1271
@tree_view: 
 
1272
@Returns: 
 
1273
 
 
1274
 
 
1275
<!-- ##### FUNCTION gtk_tree_view_set_hover_selection ##### -->
 
1276
<para>
 
1277
 
 
1278
</para>
 
1279
 
 
1280
@tree_view: 
 
1281
@hover: 
 
1282
 
 
1283
 
 
1284
<!-- ##### FUNCTION gtk_tree_view_get_hover_expand ##### -->
 
1285
<para>
 
1286
 
 
1287
</para>
 
1288
 
 
1289
@tree_view: 
 
1290
@Returns: 
 
1291
 
 
1292
 
 
1293
<!-- ##### FUNCTION gtk_tree_view_set_hover_expand ##### -->
 
1294
<para>
 
1295
 
 
1296
</para>
 
1297
 
 
1298
@tree_view: 
 
1299
@expand: 
 
1300
 
 
1301
 
 
1302
<!-- ##### USER_FUNCTION GtkTreeDestroyCountFunc ##### -->
 
1303
<para>
 
1304
 
 
1305
</para>
 
1306
 
 
1307
@tree_view: 
 
1308
@path: 
 
1309
@children: 
 
1310
@user_data: 
 
1311
 
 
1312
 
 
1313
<!-- ##### FUNCTION gtk_tree_view_set_destroy_count_func ##### -->
 
1314
<para>
 
1315
 
 
1316
</para>
 
1317
 
 
1318
@tree_view: 
 
1319
@func: 
 
1320
@data: 
 
1321
@destroy: 
 
1322
 
 
1323
 
 
1324
<!-- ##### USER_FUNCTION GtkTreeViewRowSeparatorFunc ##### -->
 
1325
<para>
 
1326
Function type for determining whether the row pointed to by @iter should
 
1327
be rendered as a separator. A common way to implement this is to have a
 
1328
boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc
 
1329
returns.
 
1330
</para>
 
1331
 
 
1332
@model: the #GtkTreeModel
 
1333
@iter: a #GtkTreeIter pointing at a row in @model
 
1334
@data: user data
 
1335
@Returns: %TRUE if the row is a separator
 
1336
 
 
1337
 
 
1338
<!-- ##### FUNCTION gtk_tree_view_get_row_separator_func ##### -->
 
1339
<para>
 
1340
 
 
1341
</para>
 
1342
 
 
1343
@tree_view: 
 
1344
@Returns: 
 
1345
 
 
1346
 
 
1347
<!-- ##### FUNCTION gtk_tree_view_set_row_separator_func ##### -->
 
1348
<para>
 
1349
 
 
1350
</para>
 
1351
 
 
1352
@tree_view: 
 
1353
@func: 
 
1354
@data: 
 
1355
@destroy: 
 
1356
 
 
1357
 
 
1358
<!-- ##### FUNCTION gtk_tree_view_get_rubber_banding ##### -->
 
1359
<para>
 
1360
 
 
1361
</para>
 
1362
 
 
1363
@tree_view: 
 
1364
@Returns: 
 
1365
 
 
1366
 
 
1367
<!-- ##### FUNCTION gtk_tree_view_set_rubber_banding ##### -->
 
1368
<para>
 
1369
 
 
1370
</para>
 
1371
 
 
1372
@tree_view: 
 
1373
@enable: 
 
1374
 
 
1375
 
 
1376
<!-- ##### FUNCTION gtk_tree_view_is_rubber_banding_active ##### -->
 
1377
<para>
 
1378
 
 
1379
</para>
 
1380
 
 
1381
@tree_view: 
 
1382
@Returns: 
 
1383
 
 
1384
 
 
1385
<!-- ##### FUNCTION gtk_tree_view_get_enable_tree_lines ##### -->
 
1386
<para>
 
1387
 
 
1388
</para>
 
1389
 
 
1390
@tree_view: 
 
1391
@Returns: 
 
1392
 
 
1393
 
 
1394
<!-- ##### FUNCTION gtk_tree_view_set_enable_tree_lines ##### -->
 
1395
<para>
 
1396
 
 
1397
</para>
 
1398
 
 
1399
@tree_view: 
 
1400
@enabled: 
 
1401
 
 
1402
 
 
1403
<!-- ##### ENUM GtkTreeViewGridLines ##### -->
 
1404
<para>
 
1405
Used to indicate which grid lines to draw in a tree view.
 
1406
</para>
 
1407
 
 
1408
@GTK_TREE_VIEW_GRID_LINES_NONE: No grid lines.
 
1409
@GTK_TREE_VIEW_GRID_LINES_HORIZONTAL: Horizontal grid lines.
 
1410
@GTK_TREE_VIEW_GRID_LINES_VERTICAL: Vertical grid lines.
 
1411
@GTK_TREE_VIEW_GRID_LINES_BOTH: Horizontal and vertical grid lines.
 
1412
 
 
1413
<!-- ##### FUNCTION gtk_tree_view_get_grid_lines ##### -->
 
1414
<para>
 
1415
 
 
1416
</para>
 
1417
 
 
1418
@tree_view: 
 
1419
@Returns: 
 
1420
 
 
1421
 
 
1422
<!-- ##### FUNCTION gtk_tree_view_set_grid_lines ##### -->
 
1423
<para>
 
1424
 
 
1425
</para>
 
1426
 
 
1427
@tree_view: 
 
1428
@grid_lines: 
 
1429
 
 
1430
 
 
1431
<!-- ##### FUNCTION gtk_tree_view_set_tooltip_row ##### -->
 
1432
<para>
 
1433
 
 
1434
</para>
 
1435
 
 
1436
@tree_view: 
 
1437
@tooltip: 
 
1438
@path: 
 
1439
 
 
1440
 
 
1441
<!-- ##### FUNCTION gtk_tree_view_set_tooltip_cell ##### -->
 
1442
<para>
 
1443
 
 
1444
</para>
 
1445
 
 
1446
@tree_view: 
 
1447
@tooltip: 
 
1448
@path: 
 
1449
@column: 
 
1450
@cell: 
 
1451
 
 
1452
 
 
1453
<!-- ##### FUNCTION gtk_tree_view_get_tooltip_context ##### -->
 
1454
<para>
 
1455
 
 
1456
</para>
 
1457
 
 
1458
@tree_view: 
 
1459
@x: 
 
1460
@y: 
 
1461
@keyboard_tip: 
 
1462
@model: 
 
1463
@path: 
 
1464
@iter: 
 
1465
@Returns: 
 
1466
 
 
1467
 
 
1468
<!-- ##### FUNCTION gtk_tree_view_get_tooltip_column ##### -->
 
1469
<para>
 
1470
 
 
1471
</para>
 
1472
 
 
1473
@tree_view: 
 
1474
@Returns: 
 
1475
 
 
1476
 
 
1477
<!-- ##### FUNCTION gtk_tree_view_set_tooltip_column ##### -->
 
1478
<para>
 
1479
 
 
1480
</para>
 
1481
 
 
1482
@tree_view: 
 
1483
@column: 
 
1484
 
 
1485