comparison libpurple/status.h @ 18684:5c1ed6296b56

propagate from branch 'im.pidgin.pidgin' (head b195e262642015df66e36d33e9dd16ecae5df9d5) to branch 'im.pidgin.soc.2007.xmpp' (head 06f9dbd73b69e26dc9f56873a9ce106146bb1b18)
author Andreas Monitzer <pidgin@monitzer.com>
date Wed, 11 Jul 2007 22:27:44 +0000
parents 759cd72bd2ff 72906c5ac037
children 481749fc0b6b
comparison
equal deleted inserted replaced
17634:8d2ea5072f6f 18684:5c1ed6296b56
235 gboolean saveable, 235 gboolean saveable,
236 gboolean user_settable, 236 gboolean user_settable,
237 gboolean independent, 237 gboolean independent,
238 const char *attr_id, 238 const char *attr_id,
239 const char *attr_name, 239 const char *attr_name,
240 PurpleValue *attr_value, ...); 240 PurpleValue *attr_value, ...) G_GNUC_NULL_TERMINATED;
241 241
242 /** 242 /**
243 * Destroys a status type. 243 * Destroys a status type.
244 * 244 *
245 * @param status_type The status type to destroy. 245 * @param status_type The status type to destroy.
278 * @param name The description of the first attribute. 278 * @param name The description of the first attribute.
279 * @param value The value type of the first attribute attribute. 279 * @param value The value type of the first attribute attribute.
280 * @param ... Additional attribute information. 280 * @param ... Additional attribute information.
281 */ 281 */
282 void purple_status_type_add_attrs(PurpleStatusType *status_type, const char *id, 282 void purple_status_type_add_attrs(PurpleStatusType *status_type, const char *id,
283 const char *name, PurpleValue *value, ...); 283 const char *name, PurpleValue *value, ...) G_GNUC_NULL_TERMINATED;
284 284
285 /** 285 /**
286 * Adds multiple attributes to a status type using a va_list. 286 * Adds multiple attributes to a status type using a va_list.
287 * 287 *
288 * @param status_type The status type to add the attribute to. 288 * @param status_type The status type to add the attribute to.
395 /** 395 /**
396 * Returns a list of all attributes in a status type. 396 * Returns a list of all attributes in a status type.
397 * 397 *
398 * @param status_type The status type. 398 * @param status_type The status type.
399 * 399 *
400 * @return The list of attributes. 400 * @constreturn The list of attributes.
401 */ 401 */
402 const GList *purple_status_type_get_attrs(const PurpleStatusType *status_type); 402 GList *purple_status_type_get_attrs(const PurpleStatusType *status_type);
403 403
404 /** 404 /**
405 * Find the PurpleStatusType with the given id. 405 * Find the PurpleStatusType with the given id.
406 * 406 *
407 * @param status_types A list of status types. Often account->status_types. 407 * @param status_types A list of status types. Often account->status_types.
523 * 523 *
524 * @param status The status. 524 * @param status The status.
525 * @param active The active state. 525 * @param active The active state.
526 * @param attrs A list of attributes to set on the status. This list is 526 * @param attrs A list of attributes to set on the status. This list is
527 * composed of key/value pairs, where each key is a valid 527 * composed of key/value pairs, where each key is a valid
528 * attribute name for this PurpleStatusType. 528 * attribute name for this PurpleStatusType. The list is
529 * not modified or freed by this function.
529 */ 530 */
530 void purple_status_set_active_with_attrs_list(PurpleStatus *status, gboolean active, 531 void purple_status_set_active_with_attrs_list(PurpleStatus *status, gboolean active,
531 const GList *attrs); 532 GList *attrs);
532 533
533 /** 534 /**
534 * Sets the boolean value of an attribute in a status with the specified ID. 535 * Sets the boolean value of an attribute in a status with the specified ID.
535 * 536 *
536 * @param status The status. 537 * @param status The status.
776 777
777 /** 778 /**
778 * Adds a list of statuses to the presence. 779 * Adds a list of statuses to the presence.
779 * 780 *
780 * @param presence The presence. 781 * @param presence The presence.
781 * @param source_list The source list of statuses to add. 782 * @param source_list The source list of statuses to add, which is not
782 */ 783 * modified or freed by this function.
783 void purple_presence_add_list(PurplePresence *presence, const GList *source_list); 784 */
785 void purple_presence_add_list(PurplePresence *presence, GList *source_list);
784 786
785 /** 787 /**
786 * Sets the active state of a status in a presence. 788 * Sets the active state of a status in a presence.
787 * 789 *
788 * Only independent statuses can be set unactive. Normal statuses can only 790 * Only independent statuses can be set unactive. Normal statuses can only
877 /** 879 /**
878 * Returns all the statuses in a presence. 880 * Returns all the statuses in a presence.
879 * 881 *
880 * @param presence The presence. 882 * @param presence The presence.
881 * 883 *
882 * @return The statuses. 884 * @constreturn The statuses.
883 */ 885 */
884 const GList *purple_presence_get_statuses(const PurplePresence *presence); 886 GList *purple_presence_get_statuses(const PurplePresence *presence);
885 887
886 /** 888 /**
887 * Returns the status with the specified ID from a presence. 889 * Returns the status with the specified ID from a presence.
888 * 890 *
889 * @param presence The presence. 891 * @param presence The presence.