From 658a41d41075b38d7be51acc55ffe112fb0a0929 Mon Sep 17 00:00:00 2001 From: Shane Landrum Date: Fri, 13 Aug 2004 16:36:59 +0000 Subject: [PATCH] 2004-08-13 Shane Landrum * en/Gtk/TreeCellDataFunc.xml * en/Gtk/TreeDataList.xml * en/Gtk/TreeDestroyCountFunc.xml * en/Gtk/TreeIter.xml * en/Gtk/TreeIterCompareFunc.xml * en/Gtk/TreeModel.xml * en/Gtk/TreeModelForeachFunc.xml * en/Gtk/TreeSelectionFunc.xml * en/Gtk/TreeSortable.xml * en/Gtk/TreeView.xml: Various updates to tree object docs. svn path=/trunk/gtk-sharp/; revision=32313 --- doc/ChangeLog | 13 +++++++++ doc/en/Gtk/TreeCellDataFunc.xml | 6 ++--- doc/en/Gtk/TreeDataList.xml | 6 ++--- doc/en/Gtk/TreeDestroyCountFunc.xml | 6 ++--- doc/en/Gtk/TreeIter.xml | 18 ++++++------- doc/en/Gtk/TreeIterCompareFunc.xml | 6 ++--- doc/en/Gtk/TreeModel.xml | 41 ++++++++++++++--------------- doc/en/Gtk/TreeModelForeachFunc.xml | 7 ++--- doc/en/Gtk/TreeSelectionFunc.xml | 6 ++--- doc/en/Gtk/TreeSortable.xml | 6 ++--- doc/en/Gtk/TreeView.xml | 22 ++++++++-------- 11 files changed, 75 insertions(+), 62 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index a974657d4..33a0b8c94 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,16 @@ +2004-08-13 Shane Landrum + + * en/Gtk/TreeCellDataFunc.xml + * en/Gtk/TreeDataList.xml + * en/Gtk/TreeDestroyCountFunc.xml + * en/Gtk/TreeIter.xml + * en/Gtk/TreeIterCompareFunc.xml + * en/Gtk/TreeModel.xml + * en/Gtk/TreeModelForeachFunc.xml + * en/Gtk/TreeSelectionFunc.xml + * en/Gtk/TreeSortable.xml + * en/Gtk/TreeView.xml: Various updates to tree object docs. + 2004-08-13 Shane Landrum * en/Gtk/*Args.xml: Documented many handler arguments classes. diff --git a/doc/en/Gtk/TreeCellDataFunc.xml b/doc/en/Gtk/TreeCellDataFunc.xml index fcc9b48c4..7052d25a6 100644 --- a/doc/en/Gtk/TreeCellDataFunc.xml +++ b/doc/en/Gtk/TreeCellDataFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A delegate for methods that handle tree cell data. + Methods with this shape are used to specify how to fill in tree data; see for example for one place where this class is used as a parameter. System.Delegate @@ -32,4 +32,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeDataList.xml b/doc/en/Gtk/TreeDataList.xml index 6998dffd7..c644a44b2 100644 --- a/doc/en/Gtk/TreeDataList.xml +++ b/doc/en/Gtk/TreeDataList.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A class for handling the underlying data of a tree like a list. + System.ValueType @@ -95,4 +95,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeDestroyCountFunc.xml b/doc/en/Gtk/TreeDestroyCountFunc.xml index 2a63935a0..9dc759588 100644 --- a/doc/en/Gtk/TreeDestroyCountFunc.xml +++ b/doc/en/Gtk/TreeDestroyCountFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate class for use by . Almost never used; see that method's docs to find out why you might want to use it. + System.Delegate @@ -31,4 +31,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeIter.xml b/doc/en/Gtk/TreeIter.xml index 8d50fd114..c1eed5c65 100644 --- a/doc/en/Gtk/TreeIter.xml +++ b/doc/en/Gtk/TreeIter.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - The is the primary structure for accessing a structure. + The is the primary structure for accessing a tree row. Models are expected to put a unique integer in the field, and put model-specific data in the three fields. @@ -27,8 +27,8 @@ - To be added - To be added + Makes a new TreeIter with empty/default values. + @@ -42,9 +42,9 @@ Creates a new object. - an object of type + an object of type , a pointer to the underlying C object. an object of type - This is usually called indirectly by other methods. + This is usually called indirectly by other methods. Not for use by application developers. @@ -55,8 +55,8 @@ - To be added - To be added + Disposes of memory used by this TreeIter object. + @@ -67,7 +67,7 @@ - copy the TreeIter by value. + Copy the TreeIter by value. the copy of the @@ -142,4 +142,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeIterCompareFunc.xml b/doc/en/Gtk/TreeIterCompareFunc.xml index 2d24c3e06..e83773daa 100644 --- a/doc/en/Gtk/TreeIterCompareFunc.xml +++ b/doc/en/Gtk/TreeIterCompareFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate function to specify the shape of comparison functions for tree iterators. + Functions with this call syntax are usually used for comparison between two tree iterators as part of a sort. (FIXME: provide better examples.) System.Delegate @@ -31,4 +31,4 @@ System.Int32 - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeModel.xml b/doc/en/Gtk/TreeModel.xml index 1468f9494..d874cd52e 100644 --- a/doc/en/Gtk/TreeModel.xml +++ b/doc/en/Gtk/TreeModel.xml @@ -254,10 +254,10 @@ - To be added + Gets the values of child properties for the row pointed to by . an object of type - an object of type - To be added + a , pointer to the va_list data structure of arguments (FIXME: clarify what va_lists look like) + @@ -504,11 +504,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a boolean. a a a - To be added + @@ -523,11 +523,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is a . a a a - To be added + @@ -542,11 +542,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is an . a a a - To be added + @@ -561,11 +561,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is an . a a a - To be added + @@ -580,11 +580,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is an . a a a - To be added + @@ -599,11 +599,10 @@ - To be added + Sets the value of column in the row pointed to by to if the value is an . a a a - To be added @@ -618,11 +617,11 @@ - To be added + Sets the value of column in the row pointed to by to if the value is an . a a a - To be added + @@ -636,11 +635,11 @@ - To be added + Gets the value stored in column of the row pointed to by . a a a - To be added + @@ -689,11 +688,11 @@ - To be added + Gets the value stored in column of the row pointed to by and stores it in a a a - To be added + diff --git a/doc/en/Gtk/TreeModelForeachFunc.xml b/doc/en/Gtk/TreeModelForeachFunc.xml index 2bcb8976e..36494572a 100644 --- a/doc/en/Gtk/TreeModelForeachFunc.xml +++ b/doc/en/Gtk/TreeModelForeachFunc.xml @@ -7,8 +7,9 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A delegate class for functions that can be run on every row of a . + This class specifies the standard interface for functions used +as parameters to . System.Delegate @@ -31,4 +32,4 @@ System.Boolean - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeSelectionFunc.xml b/doc/en/Gtk/TreeSelectionFunc.xml index 6332ffeb7..e47479c44 100644 --- a/doc/en/Gtk/TreeSelectionFunc.xml +++ b/doc/en/Gtk/TreeSelectionFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A delegate for specifying the shape of functions passed as parameters to . + This function will get called on select and unselect of widget text. It should return if the state of the tree node may be toggled and if the state of the node should not be changed. System.Delegate @@ -32,4 +32,4 @@ System.Boolean - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeSortable.xml b/doc/en/Gtk/TreeSortable.xml index 704397a28..8f5a20364 100644 --- a/doc/en/Gtk/TreeSortable.xml +++ b/doc/en/Gtk/TreeSortable.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An interface for specifying a tree model that is sortable. + @@ -134,4 +134,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeView.xml b/doc/en/Gtk/TreeView.xml index 453b3f19b..3eb663264 100644 --- a/doc/en/Gtk/TreeView.xml +++ b/doc/en/Gtk/TreeView.xml @@ -456,7 +456,7 @@ public class TreeViewDemo { - This function should almost never be used. + This function should almost never be used. It is meant for private use by ATK for determining the number of visible children that are removed when the user collapses a row, or a row is deleted. an object of type an object of type an object of type @@ -932,7 +932,7 @@ public class TreeViewDemo { To be added - To be added + @@ -944,7 +944,7 @@ public class TreeViewDemo { To be added - To be added + @@ -968,7 +968,7 @@ public class TreeViewDemo { To be added - To be added + @@ -980,7 +980,7 @@ public class TreeViewDemo { To be added - To be added + @@ -992,7 +992,7 @@ public class TreeViewDemo { To be added - To be added + @@ -1004,7 +1004,7 @@ public class TreeViewDemo { To be added - To be added + @@ -1016,7 +1016,7 @@ public class TreeViewDemo { To be added - To be added + @@ -1070,7 +1070,7 @@ public class TreeViewDemo { To be added - To be added + @@ -1082,7 +1082,7 @@ public class TreeViewDemo { To be added - To be added + @@ -1366,7 +1366,7 @@ tree_view.AppendColumn ("title", text, "text", 0); To be added a - To be added +