Write documentation Write documentation

Sun Mar  3 01:36:21 2002  Jonathan Blandford  <jrb@redhat.com>

	* gtk/tmpl/gtktreeviewcolumn.sgml: Write documentation
	* gtk/tmpl/gtktreeview.sgml: Write documentation

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 5f4ca5fec1d2d4b4f9d900b429260e1bf33057a5..7a425314d54cfaf9b2d6436247ced4a86e93afea 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+Sun Mar  3 01:36:21 2002  Jonathan Blandford  <jrb@redhat.com>
+
+       * gtk/tmpl/gtktreeviewcolumn.sgml: Write documentation
+       * gtk/tmpl/gtktreeview.sgml: Write documentation
+
 Sat Mar  2 15:46:29 2002  Owen Taylor  <otaylor@redhat.com>
 
        * gtk/tmpl/gtkentry.sgml: Move a couple of function

diff --git a/docs/reference/gtk/tmpl/gtktreeview.sgml b/docs/reference/gtk/tmpl/gtktreeview.sgml
index 38eecd87490fa961ccd1486330330aa935213e5d..cf91d73575a12894225fce50c390faa935566e15 100644 (file)
--- a/docs/reference/gtk/tmpl/gtktreeview.sgml
+++ b/docs/reference/gtk/tmpl/gtktreeview.sgml
@@ -2,16 +2,17 @@
 GtkTreeView
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A widget for displaying both trees and lists.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+Widget that displays any object that implements the <link
+linkend="GtkTreeModel>GtkTreeModel</link> interface.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-
+#GtkTreeViewColumn, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
 </para>
 
 <!-- ##### STRUCT GtkTreeView ##### -->
@@ -22,7 +23,7 @@ GtkTreeView
 
 <!-- ##### ENUM GtkTreeViewDropPosition ##### -->
 <para>
-
+An enum for determining where a dropped row goes.
 </para>
 
 @GTK_TREE_VIEW_DROP_BEFORE: 
@@ -32,31 +33,39 @@ GtkTreeView
 
 <!-- ##### STRUCT GtkTreeViewPrivate ##### -->
 <para>
-
+A private struct for internal use only.  The definition of this
+structure is not publically available.
 </para>
 
 
 <!-- ##### USER_FUNCTION GtkTreeViewColumnDropFunc ##### -->
 <para>
-
+Function type for determining whether @column can be dropped in a
+particular spot (as determined by @prev_column and @next_column).  In
+left to right locales, @prev_column is on the left of the potential drop
+spot, and @next_column is on the right.  In right to left mode, this is
+reversed.  This function should return %TRUE if the spot is a valid drop
+spot.  Please note that returning %TRUE does not actually indicate that
+the column drop was made, but is meant only to indicate a possible drop
+spot to the user.
 </para>
 
-@tree_view: 
-@column: 
-@prev_column: 
-@next_column: 
-@data: 
-@Returns: 
+@tree_view: A #GtkTreeView
+@column: The #GtkTreeViewColumn being dragged
+@prev_column: A #GtkTreeViewColumn on one side of @column
+@next_column: A #GtkTreeViewColumn on the other side of @column
+@data: user data
+@Returns: %TRUE, if #column can be dropped in this spot
 
 
 <!-- ##### USER_FUNCTION GtkTreeViewMappingFunc ##### -->
 <para>
-
+Function used for #gtk_tree_view_map_expanded_rows.
 </para>
 
-@tree_view: 
-@path: 
-@user_data: 
+@tree_view: A #GtkTreeView
+@path: The path that's expanded
+@user_data: user data
 
 
 <!-- ##### USER_FUNCTION GtkTreeViewSearchEqualFunc ##### -->

diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
index dd716ce16c191e8cdace203994cc1794f682457e..800698d907a218ce682695abd6b96048b7cfc7a4 100644 (file)
--- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
+++ b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
@@ -2,37 +2,46 @@
 GtkTreeViewColumn
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A visible column in a #GtkTreeView widget
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+The GtkTreeViewColumn object is a visible column in a #GtkTreeView
+widget.  It determines the geometry, type 
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
+#GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
 
 </para>
 
 <!-- ##### ENUM GtkTreeViewColumnSizing ##### -->
 <para>
-
+The sizing method the column uses to determine it's width.  Please note
+that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and
+can make columns appear choppy.
 </para>
 
-@GTK_TREE_VIEW_COLUMN_GROW_ONLY: 
-@GTK_TREE_VIEW_COLUMN_AUTOSIZE: 
-@GTK_TREE_VIEW_COLUMN_FIXED: 
+@GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model
+@GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes.
+@GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide.
 
 <!-- ##### USER_FUNCTION GtkTreeCellDataFunc ##### -->
 <para>
-
+A function to set the properties of a cell instead of just using the
+straight mapping between the cell and the model.  This is useful for
+customizing the cell renderer.  For example, a function might get an
+integer from the @tree_model, and render it to the "text" attribute of
+"cell" by converting it to its written equivilent.  This is set by
+calling gtk_tree_view_column_set_cell_data_func()
 </para>
 
-@tree_column: 
-@cell: 
-@tree_model: 
-@iter: 
-@data: 
+@tree_column: A #GtkTreeColumn
+@cell: The #GtkCellRenderer that is being rendered by @tree_column
+@tree_model: The #GtkTreeModel being rendered
+@iter: A #GtkTreeIter of the current row rendered
+@data: user data
 
 
 <!-- ##### STRUCT GtkTreeViewColumn ##### -->