Make 3.0 parallel-installable to 2.x

[~andy/gtk] / docs / reference / gtk / tmpl / gtktreeview.sgml

diff --git a/docs/reference/gtk/tmpl/gtktreeview.sgml b/docs/reference/gtk/tmpl/gtktreeview.sgml
index 9ddc9cad99b83af22a0343a9825a464429fbe54f..549b2e62125802f01d4df3a3bc9dcfa2d88992cc 100644 (file)
--- a/docs/reference/gtk/tmpl/gtktreeview.sgml
+++ b/docs/reference/gtk/tmpl/gtktreeview.sgml
@@ -11,10 +11,63 @@ linkend="GtkTreeModel">GtkTreeModel</link> interface.
 </para>
 
 <para>
-Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link> 
-for an overview of all the objects and data types related to the tree widget and how 
-they work together.
-</para>
+Please refer to the <link linkend="TreeWidget">tree widget conceptual 
+overview</link> for an overview of all the objects and data types related 
+to the tree widget and how they work together.
+</para>
+
+<para>
+Several different coordinate systems are exposed in the GtkTreeView API.
+These are:
+
+<inlinegraphic fileref="tree-view-coordinates.png" format="PNG"></inlinegraphic>
+
+  <simplelist>
+    <member>Widget coordinates -- coordinates relative to the widget 
+    (usually <literal>widget-&gt;window</literal>.</member>
+    <member>Bin window coordinates -- coordinates relative to the window 
+    that GtkTreeView renders to.</member>
+    <member>Tree coordinates -- coordinates relative to the entire scrollable 
+    area of GtkTreeView.  These coordinates start at (0, 0) for row 0 of the 
+    tree.</member>
+  </simplelist>
+</para>
+
+<para>
+Several functions are available for converting between the different
+coordinate systems.  The most common translations are between widget and bin 
+window coordinates and between bin window and tree coordinates.  For the 
+former you can use gtk_tree_view_convert_widget_to_bin_window_coords()
+(and vice versa), for the latter gtk_tree_view_convert_bin_window_to_tree_coords() 
+(and vice versa).
+</para>
+
+<refsect2 id="GtkTreeView-BUILDER-UI">
+<title>GtkTreeView as GtkBuildable</title>
+<para>
+The GtkTreeView implementation of the GtkBuildable interface accepts
+GtkTreeViewColumn objects as &lt;child&gt; elements in UI definitions.
+</para>
+<example>
+<title>A UI definition fragment with GtkTreeView</title>
+<programlisting><![CDATA[
+<object class="GtkTreeView" id="treeview">
+  <property name="model">liststore1</property>
+  <child>
+    <object class="GtkTreeViewColumn" id="test-column">
+      <property name="title">Test</property>
+      <child>
+        <object class="GtkCellRendererText" id="test-renderer"/>
+        <attributes>
+          <attribute name="text">1</attribute>
+        </attributes>
+      </child>
+    </object>
+  </child>
+</object>
+]]></programlisting>
+</example>
+</refsect2>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
@@ -24,6 +77,9 @@ they work together.
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### STRUCT GtkTreeView ##### -->
 <para>
 
@@ -35,21 +91,21 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 
 <!-- ##### SIGNAL GtkTreeView::cursor-changed ##### -->
 <para>
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 
 <!-- ##### SIGNAL GtkTreeView::expand-collapse-cursor-row ##### -->
 <para>
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @arg2: 
 @arg3: 
@@ -60,7 +116,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @arg2: 
 @Returns: 
@@ -70,7 +126,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @arg2: 
 
@@ -79,7 +135,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @arg2: 
 
@@ -88,7 +144,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @arg2: 
 
@@ -97,7 +153,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @Returns: 
 
 <!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
@@ -105,7 +161,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @Returns: 
 
 <!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
@@ -113,7 +169,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @Returns: 
 
@@ -122,7 +178,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @arg2: 
 
@@ -131,7 +187,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @Returns: 
 
 <!-- ##### SIGNAL GtkTreeView::test-collapse-row ##### -->
@@ -139,7 +195,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @arg2: 
 @Returns: 
@@ -149,7 +205,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @arg1: 
 @arg2: 
 @Returns: 
@@ -159,7 +215,7 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @Returns: 
 
 <!-- ##### SIGNAL GtkTreeView::unselect-all ##### -->
@@ -167,14 +223,24 @@ they work together.
 
 </para>
 
-@treeview: the object which received the signal.
+@tree_view: the object which received the signal.
 @Returns: 
 
+<!-- ##### ARG GtkTreeView:enable-grid-lines ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkTreeView:enable-search ##### -->
 <para>
 
 </para>
 
+<!-- ##### ARG GtkTreeView:enable-tree-lines ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkTreeView:expander-column ##### -->
 <para>
 
@@ -245,6 +311,11 @@ they work together.
 
 </para>
 
+<!-- ##### ARG GtkTreeView:tooltip-column ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkTreeView:vadjustment ##### -->
 <para>
 
@@ -265,6 +336,16 @@ they work together.
 
 </para>
 
+<!-- ##### ARG GtkTreeView:grid-line-pattern ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeView:grid-line-width ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
 <para>
 
@@ -285,6 +366,16 @@ they work together.
 
 </para>
 
+<!-- ##### ARG GtkTreeView:tree-line-pattern ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeView:tree-line-width ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkTreeView:vertical-separator ##### -->
 <para>
 
@@ -359,9 +450,46 @@ has some similarity to strcmp() returning 0 for equal strings.
 
 </para>
 
+@void: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_get_level_indentation ##### -->
+<para>
+
+</para>
+
+@tree_view: 
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_tree_view_get_show_expanders ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_set_level_indentation ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@indentation: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_set_show_expanders ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@enabled: 
+
+
 <!-- ##### FUNCTION gtk_tree_view_new_with_model ##### -->
 <para>
 
@@ -829,19 +957,43 @@ has some similarity to strcmp() returning 0 for equal strings.
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
+<!-- ##### FUNCTION gtk_tree_view_convert_bin_window_to_tree_coords ##### -->
 <para>
 
 </para>
 
 @tree_view: 
+@bx: 
+@by: 
+@tx: 
+@ty: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_convert_bin_window_to_widget_coords ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@bx: 
+@by: 
 @wx: 
 @wy: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_convert_tree_to_bin_window_coords ##### -->
+<para>
+
+</para>
+
+@tree_view: 
 @tx: 
 @ty: 
+@bx: 
+@by: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
+<!-- ##### FUNCTION gtk_tree_view_convert_tree_to_widget_coords ##### -->
 <para>
 
 </para>
@@ -853,6 +1005,30 @@ has some similarity to strcmp() returning 0 for equal strings.
 @wy: 
 
 
+<!-- ##### FUNCTION gtk_tree_view_convert_widget_to_bin_window_coords ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@wx: 
+@wy: 
+@bx: 
+@by: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_convert_widget_to_tree_coords ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@wx: 
+@wy: 
+@tx: 
+@ty: 
+
+
 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_dest ##### -->
 <para>
 
@@ -1149,3 +1325,131 @@ returns.
 @destroy: 
 
 
+<!-- ##### FUNCTION gtk_tree_view_get_rubber_banding ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_set_rubber_banding ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@enable: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_is_rubber_banding_active ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_get_enable_tree_lines ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_set_enable_tree_lines ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@enabled: 
+
+
+<!-- ##### ENUM GtkTreeViewGridLines ##### -->
+<para>
+Used to indicate which grid lines to draw in a tree view.
+</para>
+
+@GTK_TREE_VIEW_GRID_LINES_NONE: No grid lines.
+@GTK_TREE_VIEW_GRID_LINES_HORIZONTAL: Horizontal grid lines.
+@GTK_TREE_VIEW_GRID_LINES_VERTICAL: Vertical grid lines.
+@GTK_TREE_VIEW_GRID_LINES_BOTH: Horizontal and vertical grid lines.
+
+<!-- ##### FUNCTION gtk_tree_view_get_grid_lines ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_set_grid_lines ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@grid_lines: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_set_tooltip_row ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@tooltip: 
+@path: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_set_tooltip_cell ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@tooltip: 
+@path: 
+@column: 
+@cell: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_get_tooltip_context ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@x: 
+@y: 
+@keyboard_tip: 
+@model: 
+@path: 
+@iter: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_get_tooltip_column ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_set_tooltip_column ##### -->
+<para>
+
+</para>
+
+@tree_view: 
+@column: 
+
+