libpurple/status.h

Mon, 11 Jan 2021 01:51:14 -0600

author
Gary Kramlich <grim@reaperworld.com>
date
Mon, 11 Jan 2021 01:51:14 -0600
changeset 40697
81f81f5d2f39
parent 40613
55230eededd8
child 41199
72afb5d62f12
permissions
-rw-r--r--

Split PurpleProtocolChat to its own file and clean up the API.

Testing Done:
* Compiled and tested bonjour (not affected) and irc locally.
* Built and verified the docs.
* verified `ninja pidgin-pot` was successful.

Bugs closed: 17457

Reviewed at https://reviews.imfreedom.org/r/406/

11035
c10c382f4896 [gaim-migrate @ 12922]
Gary Kramlich <grim@reaperworld.com>
parents: 10860
diff changeset
1 /*
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
2 * Purple - Internet Messaging Library
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
3 * Copyright (C) Pidgin Developers <devel@pidgin.im>
6065
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
4 *
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
5 * Purple is the legal property of its developers, whose names are too numerous
8046
c581b20a47d6 [gaim-migrate @ 8730]
Sean Egan <seanegan@pidgin.im>
parents: 6065
diff changeset
6 * to list here. Please refer to the COPYRIGHT file distributed with this
c581b20a47d6 [gaim-migrate @ 8730]
Sean Egan <seanegan@pidgin.im>
parents: 6065
diff changeset
7 * source distribution.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
8 *
6065
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
9 * This program is free software; you can redistribute it and/or modify
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
10 * it under the terms of the GNU General Public License as published by
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
11 * the Free Software Foundation; either version 2 of the License, or
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
12 * (at your option) any later version.
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
13 *
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful,
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
17 * GNU General Public License for more details.
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
18 *
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
19 * You should have received a copy of the GNU General Public License
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
20 * along with this program; if not, see <https://www.gnu.org/licenses/>.
6065
ccd9672f9636 [gaim-migrate @ 6515]
Sean Egan <seanegan@pidgin.im>
parents:
diff changeset
21 */
35487
494f09f7f331 Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents: 35486
diff changeset
22
40474
1341be8e3402 Make it so only libpurple can directly include libpurple header files.
Gary Kramlich <grim@reaperworld.com>
parents: 40332
diff changeset
23 #if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
1341be8e3402 Make it so only libpurple can directly include libpurple header files.
Gary Kramlich <grim@reaperworld.com>
parents: 40332
diff changeset
24 # error "only <purple.h> may be included directly"
1341be8e3402 Make it so only libpurple can directly include libpurple header files.
Gary Kramlich <grim@reaperworld.com>
parents: 40332
diff changeset
25 #endif
1341be8e3402 Make it so only libpurple can directly include libpurple header files.
Gary Kramlich <grim@reaperworld.com>
parents: 40332
diff changeset
26
39659
e4dfb99b0cef Fix libpurple header guards using reserved names.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39556
diff changeset
27 #ifndef PURPLE_STATUS_H
e4dfb99b0cef Fix libpurple header guards using reserved names.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39556
diff changeset
28 #define PURPLE_STATUS_H
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
29
35442
84e906df98dd Add section blocks for purple-socket.h to xmlnode.h
Ankit Vani <a@nevitus.org>
parents: 35401
diff changeset
30 /**
84e906df98dd Add section blocks for purple-socket.h to xmlnode.h
Ankit Vani <a@nevitus.org>
parents: 35401
diff changeset
31 * SECTION:status
84e906df98dd Add section blocks for purple-socket.h to xmlnode.h
Ankit Vani <a@nevitus.org>
parents: 35401
diff changeset
32 * @section_id: libpurple-status
84e906df98dd Add section blocks for purple-socket.h to xmlnode.h
Ankit Vani <a@nevitus.org>
parents: 35401
diff changeset
33 * @short_description: <filename>status.h</filename>
35444
a4ece5a5565a Use upper-case first letters
Ankit Vani <a@nevitus.org>
parents: 35442
diff changeset
34 * @title: Status Object API
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
35 *
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
36 * The status API is what keeps track of all status for all accounts as well as
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
37 * all contacts.
35442
84e906df98dd Add section blocks for purple-socket.h to xmlnode.h
Ankit Vani <a@nevitus.org>
parents: 35401
diff changeset
38 */
84e906df98dd Add section blocks for purple-socket.h to xmlnode.h
Ankit Vani <a@nevitus.org>
parents: 35401
diff changeset
39
40524
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
40 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
41 * PURPLE_TYPE_STATUS:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
42 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
43 * The standard _get_type macro for #PurpleStatus.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
44 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
45 #define PURPLE_TYPE_STATUS (purple_status_get_type())
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
46 typedef struct _PurpleStatus PurpleStatus;
34785
99bcdb44c75f Added boxed types for PurpleStatus and PurpleSavedStatus
Ankit Vani <a@nevitus.org>
parents: 34778
diff changeset
47
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
48 /*
40524
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
49 * PURPLE_TYPE_STATUS_TYPE:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
50 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
51 * The standard _get_type macro for #PurpleStatusType.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
52 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
53 #define PURPLE_TYPE_STATUS_TYPE (purple_status_type_get_type())
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
54
35088
a156686b58eb Moved the status API documentation to the appropriate structures
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
55 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
56 * PurpleStatusType:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
57 *
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
58 * PurpleStatusType's are created by each protocol. They outline the
35088
a156686b58eb Moved the status API documentation to the appropriate structures
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
59 * available statuses of the protocol. AIM, for example, supports
a156686b58eb Moved the status API documentation to the appropriate structures
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
60 * an available state with an optional available message, an away
a156686b58eb Moved the status API documentation to the appropriate structures
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
61 * state with a mandatory message, and an invisible state (which is
a156686b58eb Moved the status API documentation to the appropriate structures
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
62 * technically "independent" of the other two, but we'll get into
a156686b58eb Moved the status API documentation to the appropriate structures
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
63 * that later). PurpleStatusTypes are very permanent. They are
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
64 * hardcoded in each protocol and will not change often. And because
35088
a156686b58eb Moved the status API documentation to the appropriate structures
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
65 * they are hardcoded, they do not need to be saved to any XML file.
a156686b58eb Moved the status API documentation to the appropriate structures
Ankit Vani <a@nevitus.org>
parents: 35024
diff changeset
66 */
40524
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
67 typedef struct _PurpleStatusType PurpleStatusType;
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
68
40524
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
69 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
70 * PURPLE_TYPE_STATUS_ATTRIBUTE:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
71 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
72 * The standard _get_type macro for #PurpleStatusAttribute.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
73 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
74 #define PURPLE_TYPE_STATUS_ATTRIBUTE (purple_status_attribute_get_type())
40613
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
75
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
76 /**
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
77 * PurpleStatus:
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
78 *
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
79 * A PurpleStatus can be thought of as an "instance" of a PurpleStatusType.
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
80 * If you're familiar with object-oriented programming languages
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
81 * then this should be immediately clear. Say, for example, that
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
82 * one of your AIM buddies has set himself as "away." You have a
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
83 * PurpleBuddy node for this person in your buddy list. Purple wants
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
84 * to mark this buddy as "away," so it creates a new PurpleStatus.
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
85 * The PurpleStatus has its PurpleStatusType set to the "away" state
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
86 * for the oscar protocol. The PurpleStatus also contains the buddy's
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
87 * away message. PurpleStatuses are sometimes saved, depending on
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
88 * the context. The current PurpleStatuses associated with each of
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
89 * your accounts are saved so that the next time you start Purple,
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
90 * your accounts will be set to their last known statuses. There
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
91 * is also a list of saved statuses that are written to the
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
92 * status.xml file. Also, each PurpleStatus has a "saveable" boolean.
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
93 * If "saveable" is set to FALSE then the status is NEVER saved.
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
94 * All PurpleStatuses should be inside a PurplePresence.
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
95 *
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
96 * A PurpleStatus is either "independent" or "exclusive."
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
97 * Independent statuses can be active or inactive and they don't
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
98 * affect anything else. However, you can only have one exclusive
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
99 * status per PurplePresence. If you activate one exclusive status,
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
100 * then the previous exclusive status is automatically deactivated.
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
101 *
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
102 * A PurplePresence is like a collection of PurpleStatuses (plus some
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
103 * other random info).
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
104 *
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
105 * See <link linkend="libpurple-purplepresence">Presence API</link>
55230eededd8 Clean up a bunch doc issues.
Gary Kramlich <grim@reaperworld.com>
parents: 40584
diff changeset
106 */
40524
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
107 typedef struct _PurpleStatusAttribute PurpleStatusAttribute;
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
108
40524
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
109 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
110 * PURPLE_TYPE_MOOD:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
111 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
112 * The standard _get_type macro for #PurpleMood.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
113 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
114 #define PURPLE_TYPE_MOOD (purple_mood_get_type())
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
115
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
116 /**
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
117 * PurpleMood:
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
118 * @mood: A string representing the mood.
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
119 * @description: A short description of the mood.
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
120 *
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
121 * A structure to represent a mood.
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
122 */
39556
622bf98df0ac Remove unnecessary struct tags.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39543
diff changeset
123 typedef struct {
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
124 /*< public >*/
24912
9ae8349f0353 Move the mood UI for ICQ into Pidgin. It still uses the new request API
Richard Laager <rlaager@pidgin.im>
parents: 24911
diff changeset
125 const char *mood;
9ae8349f0353 Move the mood UI for ICQ into Pidgin. It still uses the new request API
Richard Laager <rlaager@pidgin.im>
parents: 24911
diff changeset
126 const char *description;
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
127
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
128 /*< private >*/
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
129 gpointer padding[4];
24912
9ae8349f0353 Move the mood UI for ICQ into Pidgin. It still uses the new request API
Richard Laager <rlaager@pidgin.im>
parents: 24911
diff changeset
130 } PurpleMood;
9ae8349f0353 Move the mood UI for ICQ into Pidgin. It still uses the new request API
Richard Laager <rlaager@pidgin.im>
parents: 24911
diff changeset
131
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
132 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
133 * PurpleStatusPrimitive:
38018
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
134 * @PURPLE_STATUS_UNSET: The status is not set
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
135 * @PURPLE_STATUS_OFFLINE: The status is offline
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
136 * @PURPLE_STATUS_AVAILABLE: The status is available
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
137 * @PURPLE_STATUS_UNAVAILABLE: The status is unavailable
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
138 * @PURPLE_STATUS_INVISIBLE: The stuatus is invisible
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
139 * @PURPLE_STATUS_AWAY: The status is away
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
140 * @PURPLE_STATUS_EXTENDED_AWAY: The status is extended away/do not disturb
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
141 * @PURPLE_STATUS_MOBILE: The status is mobile
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
142 * @PURPLE_STATUS_TUNE: The status includes a song title
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
143 * @PURPLE_STATUS_MOOD: The status includes a mood
39300
af611557a710 status: Silence glib-mkenums warning
Mike Ruprecht <cmaiku@gmail.com>
parents: 38716
diff changeset
144 * @PURPLE_STATUS_NUM_PRIMITIVES: The number of #PurpleStatusPrimitive<!-- -->s
38563
57f76ef581c8 status: Tweak PurpleStatusPrimitive's documentation
Mike Ruprecht <cmaiku@gmail.com>
parents: 38055
diff changeset
145 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
146 * A primitive defining the basic structure of a status type.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
147 */
21201
493e5846c38d Add PURPLE_STATUS_TUNE to status_primitive_map so that it has a name
Mark Doliner <markdoliner@pidgin.im>
parents: 21193
diff changeset
148 /*
493e5846c38d Add PURPLE_STATUS_TUNE to status_primitive_map so that it has a name
Mark Doliner <markdoliner@pidgin.im>
parents: 21193
diff changeset
149 * If you add a value to this enum, make sure you update
24907
13118548c74c Add a PURPLE_STATUS_MOOD primitive and change ICQ to use it.
Richard Laager <rlaager@pidgin.im>
parents: 22793
diff changeset
150 * the status_primitive_map and primitive_scores arrays in status.c.
21201
493e5846c38d Add PURPLE_STATUS_TUNE to status_primitive_map so that it has a name
Mark Doliner <markdoliner@pidgin.im>
parents: 21193
diff changeset
151 */
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
152 typedef enum
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
153 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
154 PURPLE_STATUS_UNSET = 0,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
155 PURPLE_STATUS_OFFLINE,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
156 PURPLE_STATUS_AVAILABLE,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
157 PURPLE_STATUS_UNAVAILABLE,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
158 PURPLE_STATUS_INVISIBLE,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
159 PURPLE_STATUS_AWAY,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
160 PURPLE_STATUS_EXTENDED_AWAY,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
161 PURPLE_STATUS_MOBILE,
21193
e918a1846d03 Use an independant status type for 'current media' stuff, instead of using
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 19897
diff changeset
162 PURPLE_STATUS_TUNE,
24907
13118548c74c Add a PURPLE_STATUS_MOOD primitive and change ICQ to use it.
Richard Laager <rlaager@pidgin.im>
parents: 22793
diff changeset
163 PURPLE_STATUS_MOOD,
38018
926551540b3b Cleanup documentation issues for status.h
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
164
38055
99e670730bf7 This is more correct but it doesn't fix the warning from glib-mkenums
Gary Kramlich <grim@reaperworld.com>
parents: 38054
diff changeset
165 PURPLE_STATUS_NUM_PRIMITIVES, /*< skip >*/
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
166 } PurpleStatusPrimitive;
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
167
40575
b82c365e04e8 Rename presence.[ch] to purplepresence.[ch], fix some docs, and other tweaks.
Gary Kramlich <grim@reaperworld.com>
parents: 40524
diff changeset
168 #include "purplepresence.h"
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
169
40524
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
170 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
171 * PURPLE_TUNE_ALBUM:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
172 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
173 * A constant for a status attribute that represents the album of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
174 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
175 #define PURPLE_TUNE_ALBUM "tune_album"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
176
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
177 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
178 * PURPLE_TUNE_ARTIST:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
179 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
180 * A constant for a status attribute that represents the artists of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
181 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
182 #define PURPLE_TUNE_ARTIST "tune_artist"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
183
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
184 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
185 * PURPLE_TUNE_COMMENT:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
186 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
187 * A constant for a status attribute that represents the comment of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
188 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
189 #define PURPLE_TUNE_COMMENT "tune_comment"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
190
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
191 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
192 * PURPLE_TUNE_FULL:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
193 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
194 * A constant for a status attribute that represents the full details of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
195 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
196 #define PURPLE_TUNE_FULL "tune_full"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
197
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
198 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
199 * PURPLE_TUNE_GENRE:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
200 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
201 * A constant for a status attribute that represents the genre of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
202 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
203 #define PURPLE_TUNE_GENRE "tune_genre"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
204
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
205 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
206 * PURPLE_TUNE_TIME:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
207 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
208 * A constant for a status attribute that represents the duration of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
209 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
210 #define PURPLE_TUNE_TIME "tune_time"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
211
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
212 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
213 * PURPLE_TUNE_TITLE:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
214 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
215 * A constant for a status attribute that represents the title of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
216 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
217 #define PURPLE_TUNE_TITLE "tune_title"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
218
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
219 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
220 * PURPLE_TUNE_TRACK:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
221 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
222 * A constant for a status attribute that represents the track number of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
223 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
224 #define PURPLE_TUNE_TRACK "tune_track"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
225
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
226 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
227 * PURPLE_TUNE_URL:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
228 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
229 * A constant for a status attribute that represents the url of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
230 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
231 #define PURPLE_TUNE_URL "tune_url"
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
232
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
233 /**
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
234 * PURPLE_TUNE_YEAR:
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
235 *
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
236 * A constant for a status attribute that represents the release year of a song.
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
237 */
a3b1cde8d2d8 Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Gary Kramlich <grim@reaperworld.com>
parents: 40474
diff changeset
238 #define PURPLE_TUNE_YEAR "tune_year"
17800
39a0f9ed0e26 Replaced a clean and simple API with a very weird hack due to vivid request on #pidgin by multiple devs. This avoids the change in PurplePluginProtocolInfo, but requires complicated change tracking in every prpl. The others prpl should add this change tracking, too (since otherwise the status gets changed even though nothing they care about changed), but that's not up to me.
Andreas Monitzer <am@adiumx.com>
parents: 16870
diff changeset
239
24907
13118548c74c Add a PURPLE_STATUS_MOOD primitive and change ICQ to use it.
Richard Laager <rlaager@pidgin.im>
parents: 22793
diff changeset
240 #define PURPLE_MOOD_NAME "mood"
13118548c74c Add a PURPLE_STATUS_MOOD primitive and change ICQ to use it.
Richard Laager <rlaager@pidgin.im>
parents: 22793
diff changeset
241 #define PURPLE_MOOD_COMMENT "moodtext"
13118548c74c Add a PURPLE_STATUS_MOOD primitive and change ICQ to use it.
Richard Laager <rlaager@pidgin.im>
parents: 22793
diff changeset
242
32787
7072f190d6ad Use G_BEGIN/END_DECLS in public libpurple files. This was
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32303
diff changeset
243 G_BEGIN_DECLS
14988
66b34458d49e [gaim-migrate @ 17698]
Richard Laager <rlaager@pidgin.im>
parents: 14254
diff changeset
244
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
245 /**************************************************************************/
35472
474e26199560 Removed @name
Ankit Vani <a@nevitus.org>
parents: 35471
diff changeset
246 /* PurpleStatusPrimitive API */
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
247 /**************************************************************************/
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
248
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
249 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
250 * purple_primitive_get_id_from_type:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
251 * @type: A primitive status type.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
252 *
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
253 * Lookup the id of a primitive status type based on the type. This
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
254 * ID is a unique plain-text name of the status, without spaces.
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
255 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
256 * Returns: The unique ID for this type.
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
257 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
258 const char *purple_primitive_get_id_from_type(PurpleStatusPrimitive type);
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
259
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
260 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
261 * purple_primitive_get_name_from_type:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
262 * @type: A primitive status type.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
263 *
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
264 * Lookup the name of a primitive status type based on the type. This
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
265 * name is the plain-English name of the status type. It is usually one
12037
0f1e1fa4b601 [gaim-migrate @ 14330]
Evan Schoenberg <evands@pidgin.im>
parents: 11696
diff changeset
266 * or two words.
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
267 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
268 * Returns: The name of this type, suitable for users to see.
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
269 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
270 const char *purple_primitive_get_name_from_type(PurpleStatusPrimitive type);
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
271
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
272 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
273 * purple_primitive_get_type_from_id:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
274 * @id: The unique ID of a primitive status type.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
275 *
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
276 * Lookup the value of a primitive status type based on the id. The
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
277 * ID is a unique plain-text name of the status, without spaces.
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
278 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
279 * Returns: The PurpleStatusPrimitive value.
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
280 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
281 PurpleStatusPrimitive purple_primitive_get_type_from_id(const char *id);
10419
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
282
cb6b7316fdba [gaim-migrate @ 11670]
Mark Doliner <markdoliner@pidgin.im>
parents: 10418
diff changeset
283 /**************************************************************************/
35472
474e26199560 Removed @name
Ankit Vani <a@nevitus.org>
parents: 35471
diff changeset
284 /* PurpleStatusType API */
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
285 /**************************************************************************/
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
286
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
287 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
288 * purple_status_type_get_type:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
289 *
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
290 * The standard _get_type function for #PurpleStatusType.
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
291 *
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
292 * Returns: The #GType for #PurpleStatusType.
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
293 */
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
294 GType purple_status_type_get_type(void);
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
295
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
296 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
297 * purple_status_type_new_full:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
298 * @primitive: The primitive status type.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
299 * @id: The ID of the status type, or %NULL to use the id of
12595
8108c22aa723 [gaim-migrate @ 14925]
Richard Laager <rlaager@pidgin.im>
parents: 12484
diff changeset
300 * the primitive status type.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
301 * @name: The name presented to the user, or %NULL to use the
12595
8108c22aa723 [gaim-migrate @ 14925]
Richard Laager <rlaager@pidgin.im>
parents: 12484
diff changeset
302 * name of the primitive status type.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
303 * @saveable: TRUE if the information set for this status by the
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
304 * user can be saved for future sessions.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
305 * @user_settable: TRUE if this is a status the user can manually set.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
306 * @independent: TRUE if this is an independent (non-exclusive)
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
307 * status type.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
308 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
309 * Creates a new status type.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
310 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
311 * Returns: A new status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
312 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
313 PurpleStatusType *purple_status_type_new_full(PurpleStatusPrimitive primitive,
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
314 const char *id, const char *name,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
315 gboolean saveable,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
316 gboolean user_settable,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
317 gboolean independent);
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
318
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
319 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
320 * purple_status_type_new:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
321 * @primitive: The primitive status type.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
322 * @id: The ID of the status type, or %NULL to use the id of
12595
8108c22aa723 [gaim-migrate @ 14925]
Richard Laager <rlaager@pidgin.im>
parents: 12484
diff changeset
323 * the primitive status type.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
324 * @name: The name presented to the user, or %NULL to use the
12595
8108c22aa723 [gaim-migrate @ 14925]
Richard Laager <rlaager@pidgin.im>
parents: 12484
diff changeset
325 * name of the primitive status type.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
326 * @user_settable: TRUE if this is a status the user can manually set.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
327 *
25445
b36f23e05c50 Thomas Gibson-Robinson noticed that the "saveable" attribute of a status type
Daniel Atallah <datallah@pidgin.im>
parents: 25231
diff changeset
328 * Creates a new status type with some default values (
24911
624850f5e6a7 s/savable/saveable/
Richard Laager <rlaager@pidgin.im>
parents: 24907
diff changeset
329 * saveable and not independent).
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
330 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
331 * Returns: A new status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
332 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
333 PurpleStatusType *purple_status_type_new(PurpleStatusPrimitive primitive,
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
334 const char *id, const char *name,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
335 gboolean user_settable);
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
336
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
337 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
338 * purple_status_type_new_with_attrs:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
339 * @primitive: The primitive status type.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
340 * @id: The ID of the status type, or %NULL to use the id of
12595
8108c22aa723 [gaim-migrate @ 14925]
Richard Laager <rlaager@pidgin.im>
parents: 12484
diff changeset
341 * the primitive status type.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
342 * @name: The name presented to the user, or %NULL to use the
12595
8108c22aa723 [gaim-migrate @ 14925]
Richard Laager <rlaager@pidgin.im>
parents: 12484
diff changeset
343 * name of the primitive status type.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
344 * @saveable: TRUE if the information set for this status by the
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
345 * user can be saved for future sessions.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
346 * @user_settable: TRUE if this is a status the user can manually set.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
347 * @independent: TRUE if this is an independent (non-exclusive)
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
348 * status type.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
349 * @attr_id: The ID of the first attribute.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
350 * @attr_name: The name of the first attribute.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
351 * @attr_value: The value type of the first attribute.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
352 * @...: Additional attribute information.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
353 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
354 * Creates a new status type with attributes.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
355 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
356 * Returns: A new status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
357 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
358 PurpleStatusType *purple_status_type_new_with_attrs(PurpleStatusPrimitive primitive,
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
359 const char *id,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
360 const char *name,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
361 gboolean saveable,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
362 gboolean user_settable,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
363 gboolean independent,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
364 const char *attr_id,
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
365 const char *attr_name,
34801
08c49f30e4a1 Replaced PurpleValue with GType in plugin.h, signals.h. Replaced with GValue in status.h.
Ankit Vani <a@nevitus.org>
parents: 34799
diff changeset
366 GValue *attr_value, ...) G_GNUC_NULL_TERMINATED;
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
367
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
368 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
369 * purple_status_type_destroy:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
370 * @status_type: The status type to destroy.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
371 *
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
372 * Destroys a status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
373 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
374 void purple_status_type_destroy(PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
375
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
376 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
377 * purple_status_type_get_primitive:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
378 * @status_type: The status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
379 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
380 * Returns the primitive type of a status type.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
381 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
382 * Returns: The primitive type of the status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
383 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
384 PurpleStatusPrimitive purple_status_type_get_primitive(
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
385 const PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
386
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
387 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
388 * purple_status_type_get_id:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
389 * @status_type: The status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
390 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
391 * Returns the ID of a status type.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
392 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
393 * Returns: The ID of the status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
394 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
395 const char *purple_status_type_get_id(const PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
396
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
397 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
398 * purple_status_type_get_name:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
399 * @status_type: The status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
400 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
401 * Returns the name of a status type.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
402 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
403 * Returns: The name of the status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
404 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
405 const char *purple_status_type_get_name(const PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
406
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
407 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
408 * purple_status_type_is_saveable:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
409 * @status_type: The status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
410 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
411 * Returns whether or not the status type is saveable.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
412 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
413 * Returns: TRUE if user-defined statuses based off this type are saveable.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
414 * FALSE otherwise.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
415 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
416 gboolean purple_status_type_is_saveable(const PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
417
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
418 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
419 * purple_status_type_is_user_settable:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
420 * @status_type: The status type.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
421 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
422 * Returns whether or not the status type can be set or modified by the
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
423 * user.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
424 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
425 * Returns: TRUE if the status type can be set or modified by the user.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
426 * FALSE if it's a protocol-set setting.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
427 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
428 gboolean purple_status_type_is_user_settable(const PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
429
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
430 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
431 * purple_status_type_is_independent:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
432 * @status_type: The status type.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
433 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
434 * Returns whether or not the status type is independent.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
435 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
436 * Independent status types are non-exclusive. If other status types on
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
437 * the same hierarchy level are set, this one will not be affected.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
438 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
439 * Returns: TRUE if the status type is independent, or FALSE otherwise.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
440 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
441 gboolean purple_status_type_is_independent(const PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
442
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
443 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
444 * purple_status_type_is_exclusive:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
445 * @status_type: The status type.
10067
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
446 *
10071
d2ba11541693 [gaim-migrate @ 11047]
Jonathan Champ <royanee@users.sourceforge.net>
parents: 10067
diff changeset
447 * Returns whether the status type is exclusive.
10067
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
448 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
449 * Returns: TRUE if the status type is exclusive, FALSE otherwise.
10067
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
450 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
451 gboolean purple_status_type_is_exclusive(const PurpleStatusType *status_type);
10067
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
452
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
453 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
454 * purple_status_type_is_available:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
455 * @status_type: The status type.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
456 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
457 * Returns whether or not a status type is available.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
458 *
12595
8108c22aa723 [gaim-migrate @ 14925]
Richard Laager <rlaager@pidgin.im>
parents: 12484
diff changeset
459 * Available status types are online and possibly invisible, but not away.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
460 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
461 * Returns: TRUE if the status is available, or FALSE otherwise.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
462 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
463 gboolean purple_status_type_is_available(const PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
464
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
465 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
466 * purple_status_type_get_attr:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
467 * @status_type: The status type containing the attribute.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
468 * @id: The ID of the desired attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
469 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
470 * Returns the attribute with the specified ID.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
471 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
472 * Returns: The attribute, if found. NULL otherwise.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
473 */
34858
28ac3a0418f1 Renamed PurpleStatusAttr to PurpleStatusAttribute for simplicity.
Ankit Vani <a@nevitus.org>
parents: 34857
diff changeset
474 PurpleStatusAttribute *purple_status_type_get_attr(const PurpleStatusType *status_type,
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
475 const char *id);
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
476
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
477 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
478 * purple_status_type_get_attrs:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
479 * @status_type: The status type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
480 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
481 * Returns a list of all attributes in a status type.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
482 *
38716
b9bed228745a Add many libpurple element-type annotations.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 38563
diff changeset
483 * Returns: (element-type PurpleStatusAttribute) (transfer none): The list of attributes.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
484 */
18190
bcf28ef7e8ff Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@pidgin.im>
parents: 16870
diff changeset
485 GList *purple_status_type_get_attrs(const PurpleStatusType *status_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
486
10348
0ab5eb1a828e [gaim-migrate @ 11562]
Mark Doliner <markdoliner@pidgin.im>
parents: 10340
diff changeset
487 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
488 * purple_status_type_find_with_id:
38716
b9bed228745a Add many libpurple element-type annotations.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 38563
diff changeset
489 * @status_types: (element-type PurpleStatus) (transfer none): A list of status
b9bed228745a Add many libpurple element-type annotations.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 38563
diff changeset
490 * types. Often account->status_types.
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
491 * @id: The unique ID of the status type you wish to find.
10348
0ab5eb1a828e [gaim-migrate @ 11562]
Mark Doliner <markdoliner@pidgin.im>
parents: 10340
diff changeset
492 *
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
493 * Find the PurpleStatusType with the given id.
10348
0ab5eb1a828e [gaim-migrate @ 11562]
Mark Doliner <markdoliner@pidgin.im>
parents: 10340
diff changeset
494 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
495 * Returns: The status type with the given ID, or NULL if one could
10348
0ab5eb1a828e [gaim-migrate @ 11562]
Mark Doliner <markdoliner@pidgin.im>
parents: 10340
diff changeset
496 * not be found.
0ab5eb1a828e [gaim-migrate @ 11562]
Mark Doliner <markdoliner@pidgin.im>
parents: 10340
diff changeset
497 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
498 const PurpleStatusType *purple_status_type_find_with_id(GList *status_types,
10348
0ab5eb1a828e [gaim-migrate @ 11562]
Mark Doliner <markdoliner@pidgin.im>
parents: 10340
diff changeset
499 const char *id);
0ab5eb1a828e [gaim-migrate @ 11562]
Mark Doliner <markdoliner@pidgin.im>
parents: 10340
diff changeset
500
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
501 /**************************************************************************/
35472
474e26199560 Removed @name
Ankit Vani <a@nevitus.org>
parents: 35471
diff changeset
502 /* PurpleStatusAttribute API */
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
503 /**************************************************************************/
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
504
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
505 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
506 * purple_status_attribute_get_type:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
507 *
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
508 * The standard _get_type function for #PurpleStatusAttribute.
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
509 *
35466
e259e75f1c6f Fix some gtk-doc warnings till xmlnode.h
Ankit Vani <a@nevitus.org>
parents: 35444
diff changeset
510 * Returns: The #GType for the #PurpleStatusAttribute boxed structure.
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
511 */
34858
28ac3a0418f1 Renamed PurpleStatusAttr to PurpleStatusAttribute for simplicity.
Ankit Vani <a@nevitus.org>
parents: 34857
diff changeset
512 GType purple_status_attribute_get_type(void);
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
513
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
514 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
515 * purple_status_attribute_new:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
516 * @id: The ID of the attribute.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
517 * @name: The name presented to the user.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
518 * @value_type: The type of data contained in the attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
519 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
520 * Creates a new status attribute.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
521 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
522 * Returns: A new status attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
523 */
34858
28ac3a0418f1 Renamed PurpleStatusAttr to PurpleStatusAttribute for simplicity.
Ankit Vani <a@nevitus.org>
parents: 34857
diff changeset
524 PurpleStatusAttribute *purple_status_attribute_new(const char *id, const char *name,
34801
08c49f30e4a1 Replaced PurpleValue with GType in plugin.h, signals.h. Replaced with GValue in status.h.
Ankit Vani <a@nevitus.org>
parents: 34799
diff changeset
525 GValue *value_type);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
526
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
527 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
528 * purple_status_attribute_destroy:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
529 * @attr: The status attribute to destroy.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
530 *
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
531 * Destroys a status attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
532 */
34858
28ac3a0418f1 Renamed PurpleStatusAttr to PurpleStatusAttribute for simplicity.
Ankit Vani <a@nevitus.org>
parents: 34857
diff changeset
533 void purple_status_attribute_destroy(PurpleStatusAttribute *attr);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
534
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
535 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
536 * purple_status_attribute_get_id:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
537 * @attr: The status attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
538 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
539 * Returns the ID of a status attribute.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
540 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
541 * Returns: The status attribute's ID.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
542 */
34858
28ac3a0418f1 Renamed PurpleStatusAttr to PurpleStatusAttribute for simplicity.
Ankit Vani <a@nevitus.org>
parents: 34857
diff changeset
543 const char *purple_status_attribute_get_id(const PurpleStatusAttribute *attr);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
544
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
545 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
546 * purple_status_attribute_get_name:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
547 * @attr: The status attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
548 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
549 * Returns the name of a status attribute.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
550 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
551 * Returns: The status attribute's name.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
552 */
34858
28ac3a0418f1 Renamed PurpleStatusAttr to PurpleStatusAttribute for simplicity.
Ankit Vani <a@nevitus.org>
parents: 34857
diff changeset
553 const char *purple_status_attribute_get_name(const PurpleStatusAttribute *attr);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
554
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
555 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
556 * purple_status_attribute_get_value:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
557 * @attr: The status attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
558 *
11249
efc82f3e1bd3 [gaim-migrate @ 13418]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11129
diff changeset
559 * Returns the value of a status attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
560 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
561 * Returns: The status attribute's value.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
562 */
34858
28ac3a0418f1 Renamed PurpleStatusAttr to PurpleStatusAttribute for simplicity.
Ankit Vani <a@nevitus.org>
parents: 34857
diff changeset
563 GValue *purple_status_attribute_get_value(const PurpleStatusAttribute *attr);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
564
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
565 /**************************************************************************/
35472
474e26199560 Removed @name
Ankit Vani <a@nevitus.org>
parents: 35471
diff changeset
566 /* PurpleMood API */
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
567 /**************************************************************************/
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
568
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
569 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
570 * purple_mood_get_type:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
571 *
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
572 * The standard _get_type function for #PurpleMood.
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
573 *
35466
e259e75f1c6f Fix some gtk-doc warnings till xmlnode.h
Ankit Vani <a@nevitus.org>
parents: 35444
diff changeset
574 * Returns: The #GType for the #PurpleMood boxed structure.
34785
99bcdb44c75f Added boxed types for PurpleStatus and PurpleSavedStatus
Ankit Vani <a@nevitus.org>
parents: 34778
diff changeset
575 */
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
576 GType purple_mood_get_type(void);
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
577
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
578 /**************************************************************************/
35472
474e26199560 Removed @name
Ankit Vani <a@nevitus.org>
parents: 35471
diff changeset
579 /* PurpleStatus API */
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
580 /**************************************************************************/
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
581
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
582 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
583 * purple_status_get_type:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
584 *
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
585 * The standard _get_type function for #PurpleStatus.
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
586 *
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
587 * Returns: The #GType for #PurpleStatus.
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
588 */
39543
b72187eb4335 Use G_DECLARE_FINAL_TYPE for PurpleStatus.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39515
diff changeset
589 G_DECLARE_FINAL_TYPE(PurpleStatus, purple_status, PURPLE, STATUS, GObject)
34785
99bcdb44c75f Added boxed types for PurpleStatus and PurpleSavedStatus
Ankit Vani <a@nevitus.org>
parents: 34778
diff changeset
590
99bcdb44c75f Added boxed types for PurpleStatus and PurpleSavedStatus
Ankit Vani <a@nevitus.org>
parents: 34778
diff changeset
591 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
592 * purple_status_new:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
593 * @status_type: The type of status.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
594 * @presence: The parent presence.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
595 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
596 * Creates a new status.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
597 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
598 * Returns: The new status.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
599 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
600 PurpleStatus *purple_status_new(PurpleStatusType *status_type,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
601 PurplePresence *presence);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
602
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
603 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
604 * purple_status_set_active:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
605 * @status: The status.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
606 * @active: The active state.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
607 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
608 * Sets whether or not a status is active.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
609 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
610 * This should only be called by the account, conversation, and buddy APIs.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
611 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
612 void purple_status_set_active(PurpleStatus *status, gboolean active);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
613
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
614 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
615 * purple_status_set_active_with_attrs:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
616 * @status: The status.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
617 * @active: The active state.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
618 * @args: A list of attributes to set on the status. This list is
10204
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
619 * composed of key/value pairs, where each key is a valid
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
620 * attribute name for this PurpleStatusType. The list should
10204
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
621 * be NULL terminated.
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
622 *
10204
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
623 * Sets whether or not a status is active.
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
624 *
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
625 * This should only be called by the account, conversation, and buddy APIs.
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
626 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15435
diff changeset
627 void purple_status_set_active_with_attrs(PurpleStatus *status, gboolean active,
10204
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
628 va_list args);
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
629
874e91e2a3b3 [gaim-migrate @ 11325]
Mark Doliner <markdoliner@pidgin.im>
parents: 10151
diff changeset
630 /**
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
631 * purple_status_set_active_with_attrs_dict:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
632 * @status: The status.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
633 * @active: The active state.
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
634 * @attrs: (element-type utf8 gpointer): A hash table of attributes to set on
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
635 * the status. This hash table's keys are valid attribute names for
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
636 * this PurpleStatusType. The hash table is not modified or freed by
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
637 * this function.
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
638 *
11249
efc82f3e1bd3 [gaim-migrate @ 13418]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11129
diff changeset
639 * Sets whether or not a status is active.
efc82f3e1bd3 [gaim-migrate @ 13418]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11129
diff changeset
640 *
efc82f3e1bd3 [gaim-migrate @ 13418]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11129
diff changeset
641 * This should only be called by the account, conversation, and buddy APIs.
40332
cd2da3a58f6d Rename purple_account_set_status_list and purple_status_set_active_with_attrs_list
qarkai <qarkai@gmail.com>
parents: 40328
diff changeset
642 *
cd2da3a58f6d Rename purple_account_set_status_list and purple_status_set_active_with_attrs_list
qarkai <qarkai@gmail.com>
parents: 40328
diff changeset
643 * Since: 3.0.0
11249
efc82f3e1bd3 [gaim-migrate @ 13418]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11129
diff changeset
644 */
40584
6f198a69ac48 A bunch of documentation cleanups
Gary Kramlich <grim@reaperworld.com>
parents: 40575
diff changeset
645 void purple_status_set_active_with_attrs_dict(PurpleStatus *status, gboolean active, GHashTable *attrs);
11249
efc82f3e1bd3 [gaim-migrate @ 13418]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11129
diff changeset
646
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
647 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
648 * purple_status_get_status_type:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
649 * @status: The status.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
650 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
651 * Returns the status's type.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
652 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
653 * Returns: The status's type.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
654 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
655 PurpleStatusType *purple_status_get_status_type(PurpleStatus *status);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
656
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
657 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
658 * purple_status_get_presence:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
659 * @status: The status.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
660 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
661 * Returns the status's presence.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
662 *
39738
14d425a528ad Add missing transfer annotations.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39659
diff changeset
663 * Returns: (transfer none): The status's presence.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
664 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
665 PurplePresence *purple_status_get_presence(PurpleStatus *status);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
666
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
667 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
668 * purple_status_get_id:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
669 * @status: The status.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
670 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
671 * Returns the status's type ID.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
672 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
673 * This is a convenience method for
35378
5d9e2581005b gtk-doc prep: *_get_type() functions are hidden as standard GType-returning funcs, so rename them.
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
674 * purple_status_type_get_id(purple_status_get_status_type(status)).
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
675 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
676 * Returns: The status's ID.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
677 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
678 const char *purple_status_get_id(PurpleStatus *status);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
679
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
680 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
681 * purple_status_get_name:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
682 * @status: The status.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
683 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
684 * Returns the status's name.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
685 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
686 * This is a convenience method for
35378
5d9e2581005b gtk-doc prep: *_get_type() functions are hidden as standard GType-returning funcs, so rename them.
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
687 * purple_status_type_get_name(purple_status_get_status_type(status)).
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
688 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
689 * Returns: The status's name.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
690 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
691 const char *purple_status_get_name(PurpleStatus *status);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
692
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
693 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
694 * purple_status_is_independent:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
695 * @status: The status.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
696 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
697 * Returns whether or not a status is independent.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
698 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
699 * This is a convenience method for
35378
5d9e2581005b gtk-doc prep: *_get_type() functions are hidden as standard GType-returning funcs, so rename them.
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
700 * purple_status_type_is_independent(purple_status_get_status_type(status)).
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
701 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
702 * Returns: TRUE if the status is independent, or FALSE otherwise.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
703 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
704 gboolean purple_status_is_independent(PurpleStatus *status);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
705
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
706 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
707 * purple_status_is_exclusive:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
708 * @status: The status.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
709 *
10067
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
710 * Returns whether or not a status is exclusive.
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
711 *
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
712 * This is a convenience method for
35378
5d9e2581005b gtk-doc prep: *_get_type() functions are hidden as standard GType-returning funcs, so rename them.
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
713 * purple_status_type_is_exclusive(purple_status_get_status_type(status)).
10067
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
714 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
715 * Returns: TRUE if the status is exclusive, FALSE otherwise.
10067
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
716 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
717 gboolean purple_status_is_exclusive(PurpleStatus *status);
10067
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
718
d04171b6f098 [gaim-migrate @ 11043]
Mark Doliner <markdoliner@pidgin.im>
parents: 10040
diff changeset
719 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
720 * purple_status_is_available:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
721 * @status: The status.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
722 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
723 * Returns whether or not a status is available.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
724 *
12595
8108c22aa723 [gaim-migrate @ 14925]
Richard Laager <rlaager@pidgin.im>
parents: 12484
diff changeset
725 * Available statuses are online and possibly invisible, but not away or idle.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
726 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
727 * This is a convenience method for
35378
5d9e2581005b gtk-doc prep: *_get_type() functions are hidden as standard GType-returning funcs, so rename them.
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
728 * purple_status_type_is_available(purple_status_get_status_type(status)).
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
729 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
730 * Returns: TRUE if the status is available, or FALSE otherwise.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
731 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
732 gboolean purple_status_is_available(PurpleStatus *status);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
733
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
734 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
735 * purple_status_is_active:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
736 * @status: The status.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
737 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
738 * Returns the active state of a status.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
739 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
740 * Returns: The active state of the status.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
741 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
742 gboolean purple_status_is_active(PurpleStatus *status);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
743
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
744 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
745 * purple_status_is_online:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
746 * @status: The status.
10040
b74aeb350fc5 [gaim-migrate @ 10999]
Dave West <kat@users.sourceforge.net>
parents: 10006
diff changeset
747 *
b74aeb350fc5 [gaim-migrate @ 10999]
Dave West <kat@users.sourceforge.net>
parents: 10006
diff changeset
748 * Returns whether or not a status is considered 'online'
b74aeb350fc5 [gaim-migrate @ 10999]
Dave West <kat@users.sourceforge.net>
parents: 10006
diff changeset
749 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
750 * Returns: TRUE if the status is considered online, FALSE otherwise
10040
b74aeb350fc5 [gaim-migrate @ 10999]
Dave West <kat@users.sourceforge.net>
parents: 10006
diff changeset
751 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
752 gboolean purple_status_is_online(PurpleStatus *status);
10040
b74aeb350fc5 [gaim-migrate @ 10999]
Dave West <kat@users.sourceforge.net>
parents: 10006
diff changeset
753
b74aeb350fc5 [gaim-migrate @ 10999]
Dave West <kat@users.sourceforge.net>
parents: 10006
diff changeset
754 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
755 * purple_status_get_attr_value:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
756 * @status: The status.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
757 * @id: The attribute ID.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
758 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
759 * Returns the value of an attribute in a status with the specified ID.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
760 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
761 * Returns: The value of the attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
762 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
763 GValue *purple_status_get_attr_value(PurpleStatus *status,
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
764 const char *id);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
765
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
766 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
767 * purple_status_get_attr_boolean:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
768 * @status: The status.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
769 * @id: The attribute ID.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
770 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
771 * Returns the boolean value of an attribute in a status with the specified ID.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
772 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
773 * Returns: The boolean value of the attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
774 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
775 gboolean purple_status_get_attr_boolean(PurpleStatus *status,
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
776 const char *id);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
777
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
778 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
779 * purple_status_get_attr_int:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
780 * @status: The status.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
781 * @id: The attribute ID.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
782 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
783 * Returns the integer value of an attribute in a status with the specified ID.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
784 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
785 * Returns: The integer value of the attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
786 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
787 int purple_status_get_attr_int(PurpleStatus *status, const char *id);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
788
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
789 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
790 * purple_status_get_attr_string:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
791 * @status: The status.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
792 * @id: The attribute ID.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
793 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
794 * Returns the string value of an attribute in a status with the specified ID.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
795 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
796 * Returns: The string value of the attribute.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
797 */
39515
80425f8a38e2 Clean up a function prototype to be on one line
Gary Kramlich <grim@reaperworld.com>
parents: 39514
diff changeset
798 const char *purple_status_get_attr_string(PurpleStatus *status, const char *id);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
799
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
800 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
801 * purple_status_compare:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
802 * @status1: The first status.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
803 * @status2: The second status.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
804 *
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
805 * Compares two statuses for availability.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
806 *
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
807 * Returns: -1 if @status1 is more available than @status2.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
808 * 0 if @status1 is equal to @status2.
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
809 * 1 if @status2 is more available than @status1.
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
810 */
39514
9c7715998bbc Cleanup account.[ch] and status.[ch] to remove g_type_class_add_private and other cleans including remove const from accessors
Gary Kramlich <grim@reaperworld.com>
parents: 39300
diff changeset
811 gint purple_status_compare(PurpleStatus *status1, PurpleStatus *status2);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
812
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
813 /**************************************************************************/
35472
474e26199560 Removed @name
Ankit Vani <a@nevitus.org>
parents: 35471
diff changeset
814 /* Statuses subsystem */
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
815 /**************************************************************************/
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
816
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
817 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
818 * purple_statuses_get_handle:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
819 *
10087
e5b80a38939d [gaim-migrate @ 11098]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 10071
diff changeset
820 * Get the handle for the status subsystem.
e5b80a38939d [gaim-migrate @ 11098]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 10071
diff changeset
821 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 35088
diff changeset
822 * Returns: the handle to the status subsystem
10087
e5b80a38939d [gaim-migrate @ 11098]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 10071
diff changeset
823 */
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
824 void *purple_statuses_get_handle(void);
10087
e5b80a38939d [gaim-migrate @ 11098]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 10071
diff changeset
825
e5b80a38939d [gaim-migrate @ 11098]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 10071
diff changeset
826 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
827 * purple_statuses_init:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
828 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
829 * Initializes the status subsystem.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
830 */
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
831 void purple_statuses_init(void);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
832
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
833 /**
35401
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
834 * purple_statuses_uninit:
baddcf712dd3 Convert docs from doxygen to gtk-doc format for status.h and xfer.h
Ankit Vani <a@nevitus.org>
parents: 35394
diff changeset
835 *
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
836 * Uninitializes the status subsystem.
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
837 */
34854
8417ea6a9235 Started GObjectification of PurpleStatus.
Ankit Vani <a@nevitus.org>
parents: 34852
diff changeset
838 void purple_statuses_uninit(void);
9944
71ef020ec4b0 [gaim-migrate @ 10838]
Christian Hammond <chipx86@chipx86.com>
parents: 8046
diff changeset
839
40327
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
840 /**************************************************************************/
40328
45e719e8d3bc Replace lists of PurpleAttr with GHashTable
qarkai <qarkai@gmail.com>
parents: 40327
diff changeset
841 /* Helpers */
40327
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
842 /**************************************************************************/
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
843
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
844 /**
40328
45e719e8d3bc Replace lists of PurpleAttr with GHashTable
qarkai <qarkai@gmail.com>
parents: 40327
diff changeset
845 * purple_attrs_from_vargs:
40327
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
846 * @args: A list of attributes to parse. This list is
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
847 * composed of key/value pairs, where each key is a valid
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
848 * attribute name for this PurpleStatusType. The list should
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
849 * be NULL terminated.
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
850 *
40328
45e719e8d3bc Replace lists of PurpleAttr with GHashTable
qarkai <qarkai@gmail.com>
parents: 40327
diff changeset
851 * Returns a hash table of attributes constructed from args.
40327
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
852 *
40328
45e719e8d3bc Replace lists of PurpleAttr with GHashTable
qarkai <qarkai@gmail.com>
parents: 40327
diff changeset
853 * Returns: (element-type utf8 gpointer) (transfer container): The hash table of attributes.
40327
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
854 *
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
855 * Since: 3.0.0
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
856 */
40328
45e719e8d3bc Replace lists of PurpleAttr with GHashTable
qarkai <qarkai@gmail.com>
parents: 40327
diff changeset
857 GHashTable *purple_attrs_from_vargs(va_list args);
40327
4caeb8c0b1ca Add PurpleAttr to use in lists instead of consecutive key and value elements
qarkai <qarkai@gmail.com>
parents: 40186
diff changeset
858
32787
7072f190d6ad Use G_BEGIN/END_DECLS in public libpurple files. This was
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32303
diff changeset
859 G_END_DECLS
15124
68a8be380f54 [gaim-migrate @ 17846]
Sean Egan <seanegan@pidgin.im>
parents: 14988
diff changeset
860
39659
e4dfb99b0cef Fix libpurple header guards using reserved names.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 39556
diff changeset
861 #endif /* PURPLE_STATUS_H */

mercurial