diff finch/libgnt/gnttree.h @ 18564:36257cac2b11

Anoter patch from Javeed Shaikh to introduce a utility function for a tree. I changed it a bit, but hopefully I didn't break the patch in the process.

--- a/finch/libgnt/gnttree.h	Thu Jul 19 21:11:37 2007 +0000
+++ b/finch/libgnt/gnttree.h	Thu Jul 19 21:34:35 2007 +0000
@@ -200,16 +200,38 @@
  * @param tree  The tree
  *
  * @return  The text, which needs to be freed by the caller
+ * @see gnt_tree_get_row_text_list
+ * @see gnt_tree_get_selection_text_list
  */
 char * gnt_tree_get_selection_text(GntTree *tree);
 
 /**
+ * Get a list of text for a row.
+ *
+ * @param tree  The tree
+ * @param key   A key corresponding to the row in question. If key
+ *              is @c NULL, the text list for the selected row will
+ *              be returned.
+ *
+ * @return 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.
+ * @see gnt_tree_get_selection_text_list 
+ * @see gnt_tree_get_selection_text
+ */
+GList * gnt_tree_get_row_text_list(GntTree *tree, gpointer key);
+
+/**
  * Get a list of text of the current row.
  *
  * @param tree  The tree
  *
  * @return A list of texts of the currently selected row. The list
- *         and its data should be freed by the caller.
+ *         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.
+ * @see gnt_tree_get_row_text_list
+ * @see gnt_tree_get_selection_text
  */
 GList * gnt_tree_get_selection_text_list(GntTree *tree);