aboutsummaryrefslogtreecommitdiffstats
path: root/widgets
diff options
context:
space:
mode:
authorChris Toshok <toshok@helixcode.com>2000-12-25 12:51:03 +0800
committerChris Toshok <toshok@src.gnome.org>2000-12-25 12:51:03 +0800
commitbb0585fe6073cb9aa7146df289284185c707c29d (patch)
treedaf5428a6bf72e5def79fad2464d8a7946a4ec45 /widgets
parentf14114756067350de0f90429fa14873744207019 (diff)
downloadgsoc2013-evolution-bb0585fe6073cb9aa7146df289284185c707c29d.tar.gz
gsoc2013-evolution-bb0585fe6073cb9aa7146df289284185c707c29d.tar.zst
gsoc2013-evolution-bb0585fe6073cb9aa7146df289284185c707c29d.zip
add api docs.
2000-12-24 Chris Toshok <toshok@helixcode.com> * e-cell-tree.c: add api docs. * e-tree-simple.c: add api docs. svn path=/trunk/; revision=7161
Diffstat (limited to 'widgets')
-rw-r--r--widgets/table/e-cell-tree.c28
-rw-r--r--widgets/table/e-tree-simple.c29
2 files changed, 57 insertions, 0 deletions
diff --git a/widgets/table/e-cell-tree.c b/widgets/table/e-cell-tree.c
index e4fe1efd99..ee8302228a 100644
--- a/widgets/table/e-cell-tree.c
+++ b/widgets/table/e-cell-tree.c
@@ -625,6 +625,18 @@ e_cell_tree_class_init (GtkObjectClass *object_class)
E_MAKE_TYPE(e_cell_tree, "ECellTree", ECellTree, e_cell_tree_class_init, NULL, PARENT_TYPE);
+/**
+ * e_cell_tree_construct:
+ * @ect: the ECellTree we're constructing.
+ * @open_pixbuf: pixbuf to be used instead of the '-' icon.
+ * @closed_pixbuf: pixbuf to be used instead of the '+' icon.
+ * @draw_lines: whether or not to draw the lines between parents/children/siblings.
+ * @subcell: the ECell to render to the right of the tree effects.
+ *
+ * Constructs an ECellTree. used by subclasses that need to
+ * initialize a nested ECellTree. See e_cell_tree_new() for more info.
+ *
+ **/
void
e_cell_tree_construct (ECellTree *ect,
GdkPixbuf *open_pixbuf,
@@ -650,6 +662,22 @@ e_cell_tree_construct (ECellTree *ect,
}
+/**
+ * e_cell_tree_new:
+ * @open_pixbuf: pixbuf to be used instead of the '-' icon.
+ * @closed_pixbuf: pixbuf to be used instead of the '+' icon.
+ * @draw_lines: whether or not to draw the lines between parents/children/siblings.
+ * @subcell: the ECell to render to the right of the tree effects.
+ *
+ * Creates a new ECell renderer that can be used to render tree
+ * effects that come from an ETreeModel. Various assumptions are made
+ * as to the fact that the ETableModel the ETable this cell is
+ * associated with is in fact an ETreeModel. The cell uses special
+ * columns to get at structural information (needed to draw the
+ * lines/icons.
+ *
+ * Return value: an ECell object that can be used to render trees.
+ **/
ECell *
e_cell_tree_new (GdkPixbuf *open_pixbuf,
GdkPixbuf *closed_pixbuf,
diff --git a/widgets/table/e-tree-simple.c b/widgets/table/e-tree-simple.c
index fa8e8babaa..1ff8b6da4c 100644
--- a/widgets/table/e-tree-simple.c
+++ b/widgets/table/e-tree-simple.c
@@ -133,6 +133,35 @@ e_tree_simple_class_init (GtkObjectClass *object_class)
E_MAKE_TYPE(e_tree_simple, "ETreeSimple", ETreeSimple, e_tree_simple_class_init, NULL, PARENT_TYPE)
+/**
+ * e_tree_simple_new:
+ * @col_count:
+ * @duplicate_value:
+ * @free_value:
+ * @initialize_value:
+ * @value_is_empty:
+ * @value_to_string:
+ * @icon_at:
+ * @value_at:
+ * @set_value_at:
+ * @is_editable:
+ * @model_data:
+ *
+ * This initializes a new ETreeSimpleModel object. ETreeSimpleModel is
+ * an implementaiton of the abstract class ETreeModel. The ETreeSimpleModel
+ * is designed to allow people to easily create ETreeModels without having
+ * to create a new GtkType derived from ETreeModel every time they need one.
+ *
+ * Instead, ETreeSimpleModel uses a setup based in callback functions, every
+ * callback function signature mimics the signature of each ETreeModel method
+ * and passes the extra @data pointer to each one of the method to provide them
+ * with any context they might want to use.
+ *
+ * ETreeSimple is to ETreeModel as ETableSimple is to ETableModel.
+ *
+ * Return value: An ETreeSimple object (which is also an ETreeModel
+ * object).
+ **/
ETreeModel *
e_tree_simple_new (ETableSimpleColumnCountFn col_count,
ETableSimpleDuplicateValueFn duplicate_value,