diff libpurple/request.h @ 29427:50dbd779f1bb

Deprecate purple_request_field_list_add() in favor of the new purple_request_field_list_add_icon() which now works whether or not icons are being provided.
author Richard Laager <rlaager@wiktel.com>
date Sun, 16 Nov 2008 10:10:17 +0000
parents 2d04fb25c6db
children cc1e35fa774d
line wrap: on
line diff
--- a/libpurple/request.h	Sun Nov 16 10:06:26 2008 +0000
+++ b/libpurple/request.h	Sun Nov 16 10:10:17 2008 +0000
@@ -146,8 +146,8 @@
 		struct
 		{
 			GList *items;
+			GList *icons;
 			GHashTable *item_data;
-			GList *icons;
 			GList *selected;
 			GHashTable *selected_table;
 
@@ -914,6 +914,8 @@
  * @param field The list field.
  * @param item  The list item.
  * @param data  The associated data.
+ *
+ * @deprecated Use purple_request_field_list_add_icon() instead.
  */
 void purple_request_field_list_add(PurpleRequestField *field,
 								 const char *item, void *data);
@@ -990,9 +992,12 @@
 /**
  * Returns a list of icons in a list field.
  *
+ * The icons will correspond with the items, in order.
+ *
  * @param field The field.
  *
- * @constreturn The list of icons.
+ * @constreturn The list of icons or @c NULL (i.e. the empty GList) if no
+ *              items have icons.
  */
 GList *purple_request_field_list_get_icons(const PurpleRequestField *field);