finch/libgnt/gnttree.h

branch
soc.2013.gobjectification.plugins
changeset 37100
a243a5e7afb3
parent 37094
84873ce721dc
parent 35498
0858f6d91e32
child 37118
5bbf6b8c30fd
--- a/finch/libgnt/gnttree.h	Sun Feb 09 22:19:47 2014 +0530
+++ b/finch/libgnt/gnttree.h	Mon Feb 10 00:16:53 2014 +0530
@@ -206,7 +206,7 @@
  *
  * Get the key for the selected row.
  *
- * Returns:   The key for the selected row
+ * Returns: (transfer none): The key for the selected row
  */
 gpointer gnt_tree_get_selection_data(GntTree *tree);
 
@@ -226,17 +226,21 @@
  * gnt_tree_get_row_text_list:
  * @tree:  The tree
  * @key:   A key corresponding to the row in question. If key
- *              is %NULL, the text list for the selected row will
- *              be returned.
+ *         is %NULL, the text list for the selected row will
+ *         be returned.
  *
  * Get a list of text for a row.
  *
  * See gnt_tree_get_selection_text_list(), gnt_tree_get_selection_text().
  *
- * Returns: A list of texts of a row. The list and its data should be
- *         freed by the caller. The caller should make sure that if
- *         any column of the tree contains binary data, it's not freed.
+ * Returns: (transfer container) (element-type utf8): A list of texts of a row.
+ *          The list and its data should be freed by the caller. The caller
+ *          should make sure that if any column of the tree contains binary
+ *          data, it's not freed.
  */
+/* TODO This leaks when used from introspection. The transfer mode for the
+        return type here should be 'full', but that would free binary data as
+        well. */
 GList * gnt_tree_get_row_text_list(GntTree *tree, gpointer key);
 
 /**
@@ -246,7 +250,7 @@
  *
  * Get the key of a row.
  *
- * Returns: The key of the row.
+ * Returns: (transfer none): The key of the row.
  *
  * Since: 2.8.0 (gnt), 2.7.2 (pidgin)
  */
@@ -312,11 +316,14 @@
  *
  * See gnt_tree_get_row_text_list(), gnt_tree_get_selection_text().
  *
- * Returns: A list of texts of the currently selected row. The list
- *         and its data should be freed by the caller. The caller
- *         should make sure that if any column of the tree contains
- *         binary data, it's not freed.
+ * Returns: (transfer container) (element-type utf8): A list of texts of the
+ *          currently selected row. The list and its data should be freed by
+ *          the caller. The caller should make sure that if any column of the
+ *          tree contains binary data, it's not freed.
  */
+/* TODO This leaks when used from introspection. The transfer mode for the
+        return type here should be 'full', but that would free binary data as
+        well. */
 GList * gnt_tree_get_selection_text_list(GntTree *tree);
 
 /**
@@ -325,7 +332,8 @@
  *
  * Returns the list of rows in the tree.
  *
- * Returns: The list of the rows. The list should not be modified by the caller.
+ * Returns: (transfer none) (element-type Gnt.TreeRow): The list of the rows.
+ *          The list should not be modified by the caller.
  */
 GList *gnt_tree_get_rows(GntTree *tree);
 
@@ -452,15 +460,15 @@
 
 /**
  * gnt_tree_create_row_from_list:
- * @tree:  The tree
- * @list:  The list containing the text for each column
+ * @tree: The tree
+ * @list: (element-type utf8): The list containing the text for each column
  *
  * Create a row from a list of text.
  *
  * See gnt_tree_create_row(), gnt_tree_add_row_after(), gnt_tree_add_row_last(),
  *     gnt_tree_add_choice().
  *
- * Returns:   The row
+ * Returns: (transfer full): The row
  */
 GntTreeRow * gnt_tree_create_row_from_list(GntTree *tree, GList *list);
 
@@ -514,9 +522,9 @@
 
 /**
  * gnt_tree_set_compare_func:
- * @tree:  The tree
- * @func:  The comparison function, which is used to compare
- *              the keys
+ * @tree: The tree
+ * @func: (scope call): The comparison function, which is used to compare
+ *        the keys
  *
  * Set the compare function for sorting the data.
  *
@@ -687,7 +695,7 @@
  *
  * Get the parent key for a row.
  *
- * Returns: The key of the parent row.
+ * Returns: (transfer none): The key of the parent row.
  *
  * Since: 2.4.0
  */

mercurial