aboutsummaryrefslogtreecommitdiffstats
path: root/widgets
diff options
context:
space:
mode:
authorChristopher James Lahey <clahey@ximian.com>2002-04-27 04:33:23 +0800
committerChris Lahey <clahey@src.gnome.org>2002-04-27 04:33:23 +0800
commit24f211162b3d6e6f7b3adca1071b76382bb96c2a (patch)
tree4e41219020d8a800d68f138d8439b96a31b0520d /widgets
parentfd07f957a16fc313371e9f4c09e7937d381e96af (diff)
downloadgsoc2013-evolution-24f211162b3d6e6f7b3adca1071b76382bb96c2a.tar.gz
gsoc2013-evolution-24f211162b3d6e6f7b3adca1071b76382bb96c2a.tar.zst
gsoc2013-evolution-24f211162b3d6e6f7b3adca1071b76382bb96c2a.zip
Documented the life cycle requirements of the return value of these
2002-04-26 Christopher James Lahey <clahey@ximian.com> * e-table-model.c (e_table_model_value_at), e-tree-model.c (e_tree_model_value_at): Documented the life cycle requirements of the return value of these functions. svn path=/trunk/; revision=16602
Diffstat (limited to 'widgets')
-rw-r--r--widgets/table/e-table-model.c10
-rw-r--r--widgets/table/e-tree-model.c20
2 files changed, 23 insertions, 7 deletions
diff --git a/widgets/table/e-table-model.c b/widgets/table/e-table-model.c
index 258c16ac10..f731dc396a 100644
--- a/widgets/table/e-table-model.c
+++ b/widgets/table/e-table-model.c
@@ -110,8 +110,14 @@ e_table_model_append_row (ETableModel *e_table_model, ETableModel *source, int r
* returned can be a pointer or any data value that can be stored
* inside a pointer.
*
- * The data returned is typically used by an ECell renderer
- */
+ * The data returned is typically used by an ECell renderer.
+ *
+ * The data returned must be valid until the model sends a signal that
+ * affect that piece of data. model_changed affects all data.
+ * row_changed affects the data in that row. cell_changed affects the
+ * data in that cell. rows_deleted affects all data in those rows.
+ * rows_inserted and no_change don't affect any data in this way.
+ **/
void *
e_table_model_value_at (ETableModel *e_table_model, int col, int row)
{
diff --git a/widgets/table/e-tree-model.c b/widgets/table/e-tree-model.c
index 9b205bbc51..13f203974f 100644
--- a/widgets/table/e-tree-model.c
+++ b/widgets/table/e-tree-model.c
@@ -749,14 +749,24 @@ e_tree_model_has_change_pending (ETreeModel *etree)
}
/**
- * e_tree_model_icon_of_node
+ * e_tree_model_value_at:
* @etree: The ETreeModel.
- * @path: The ETreePath to the node we're getting the icon of.
+ * @node: The ETreePath to the node we're getting the data from.
+ * @col: the column to retrieve data from
+ *
+ * Return value: This function returns the value that is stored by the
+ * @etree in column @col and node @node. The data returned can be a
+ * pointer or any data value that can be stored inside a pointer.
*
- * XXX docs here.
+ * The data returned is typically used by an ECell renderer.
*
- * return values: the GdkPixbuf associated with this node.
- */
+ * The data returned must be valid until the model sends a signal that
+ * affect that piece of data. node_changed and node_deleted affect
+ * all data in tha t node and all nodes under that node.
+ * node_data_changed affects the data in that node. node_col_changed
+ * affects the data in that node for that column. node_inserted,
+ * node_removed, and no_change don't affect any data in this way.
+ **/
void *
e_tree_model_value_at (ETreeModel *etree, ETreePath node, int col)
{