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
This commit is contained in:
Christopher James Lahey
2002-04-26 20:33:23 +00:00
committed by Chris Lahey
parent fd07f957a1
commit 24f211162b
2 changed files with 23 additions and 7 deletions

View File

@ -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)
{

View File

@ -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)
{