Mercurial > pidgin
comparison 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.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Thu, 19 Jul 2007 21:34:35 +0000 |
parents | dba4edbde4a7 |
children | 44b4e8bd759b |
comparison
equal
deleted
inserted
replaced
18563:dba4edbde4a7 | 18564:36257cac2b11 |
---|---|
198 * Get the text displayed for the selected row. | 198 * Get the text displayed for the selected row. |
199 * | 199 * |
200 * @param tree The tree | 200 * @param tree The tree |
201 * | 201 * |
202 * @return The text, which needs to be freed by the caller | 202 * @return The text, which needs to be freed by the caller |
203 * @see gnt_tree_get_row_text_list | |
204 * @see gnt_tree_get_selection_text_list | |
203 */ | 205 */ |
204 char * gnt_tree_get_selection_text(GntTree *tree); | 206 char * gnt_tree_get_selection_text(GntTree *tree); |
205 | 207 |
206 /** | 208 /** |
209 * Get a list of text for a row. | |
210 * | |
211 * @param tree The tree | |
212 * @param key A key corresponding to the row in question. If key | |
213 * is @c NULL, the text list for the selected row will | |
214 * be returned. | |
215 * | |
216 * @return A list of texts of a row. The list and its data should be | |
217 * freed by the caller. The caller should make sure that if | |
218 * any column of the tree contains binary data, it's not freed. | |
219 * @see gnt_tree_get_selection_text_list | |
220 * @see gnt_tree_get_selection_text | |
221 */ | |
222 GList * gnt_tree_get_row_text_list(GntTree *tree, gpointer key); | |
223 | |
224 /** | |
207 * Get a list of text of the current row. | 225 * Get a list of text of the current row. |
208 * | 226 * |
209 * @param tree The tree | 227 * @param tree The tree |
210 * | 228 * |
211 * @return A list of texts of the currently selected row. The list | 229 * @return A list of texts of the currently selected row. The list |
212 * and its data should be freed by the caller. | 230 * and its data should be freed by the caller. The caller |
231 * should make sure that if any column of the tree contains | |
232 * binary data, it's not freed. | |
233 * @see gnt_tree_get_row_text_list | |
234 * @see gnt_tree_get_selection_text | |
213 */ | 235 */ |
214 GList * gnt_tree_get_selection_text_list(GntTree *tree); | 236 GList * gnt_tree_get_selection_text_list(GntTree *tree); |
215 | 237 |
216 /** | 238 /** |
217 * Returns the list of rows in the tree. | 239 * Returns the list of rows in the tree. |