libpurple/status.h

changeset 40327
4caeb8c0b1ca
parent 40186
d7e2aba4d9f4
child 40328
45e719e8d3bc
equal deleted inserted replaced
40326:cdca03a74387 40327:4caeb8c0b1ca
93 PURPLE_STATUS_TUNE, 93 PURPLE_STATUS_TUNE,
94 PURPLE_STATUS_MOOD, 94 PURPLE_STATUS_MOOD,
95 95
96 PURPLE_STATUS_NUM_PRIMITIVES, /*< skip >*/ 96 PURPLE_STATUS_NUM_PRIMITIVES, /*< skip >*/
97 } PurpleStatusPrimitive; 97 } PurpleStatusPrimitive;
98
99 /**
100 * PurpleAttr:
101 * @id: The attribute id
102 * @data: The attribute data
103 *
104 * A name-value pair.
105 *
106 * Similar to PurpleKeyValuePair except it doesn't allocate memory for @id and @data.
107 */
108 typedef struct _PurpleAttr
109 {
110 const gchar *id;
111 gpointer data;
112 } PurpleAttr;
98 113
99 #include "presence.h" 114 #include "presence.h"
100 115
101 #define PURPLE_TUNE_ARTIST "tune_artist" 116 #define PURPLE_TUNE_ARTIST "tune_artist"
102 #define PURPLE_TUNE_TITLE "tune_title" 117 #define PURPLE_TUNE_TITLE "tune_title"
493 508
494 /** 509 /**
495 * purple_status_set_active_with_attrs_list: 510 * purple_status_set_active_with_attrs_list:
496 * @status: The status. 511 * @status: The status.
497 * @active: The active state. 512 * @active: The active state.
498 * @attrs: (element-type void): A list of attributes to set on the status. This list is 513 * @attrs: (element-type PurpleAttr): A list of attributes to set on the status. This list is
499 * composed of key/value pairs, where each key is a valid 514 * composed of key/value pairs, where each key is a valid
500 * attribute name for this PurpleStatusType. The list is 515 * attribute name for this PurpleStatusType. The list is
501 * not modified or freed by this function. 516 * not modified or freed by this function.
502 * 517 *
503 * Sets whether or not a status is active. 518 * Sets whether or not a status is active.
698 * 713 *
699 * Uninitializes the status subsystem. 714 * Uninitializes the status subsystem.
700 */ 715 */
701 void purple_statuses_uninit(void); 716 void purple_statuses_uninit(void);
702 717
718 /**************************************************************************/
719 /* PurpleAttr helpers */
720 /**************************************************************************/
721
722 /**
723 * purple_attr_new:
724 * @id: The name part of PurpleAttr
725 * @data: The value part of PurpleAttr
726 *
727 * Creates a new PurpleAttr.
728 *
729 * Returns: The created PurpleAttr
730 *
731 * Since: 3.0.0
732 */
733 PurpleAttr *purple_attr_new(const char *id, gpointer data);
734
735 /**
736 * purple_attr_list_from_vargs:
737 * @args: A list of attributes to parse. This list is
738 * composed of key/value pairs, where each key is a valid
739 * attribute name for this PurpleStatusType. The list should
740 * be NULL terminated.
741 *
742 * Returns a list of attributes constructed from args.
743 *
744 * Returns: (element-type PurpleAttr) (transfer full): The list of attributes.
745 *
746 * Since: 3.0.0
747 */
748 GList *purple_attr_list_from_vargs(va_list args);
749
703 G_END_DECLS 750 G_END_DECLS
704 751
705 #endif /* PURPLE_STATUS_H */ 752 #endif /* PURPLE_STATUS_H */

mercurial