Mercurial > pidgin.yaz
annotate doc/account-signals.dox @ 21930:7d0ef1e3ac4f
C++ doesn't really allow forward declarations of enums, and we
want libpurple to be usable from C++ applications, right? I changed
this to not have forward declarations, since we don't really gain
anything from it.
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Mon, 24 Dec 2007 04:56:23 +0000 |
parents | 14afe5a92fc2 |
children | cccdcc7e5642 |
rev | line source |
---|---|
6605 | 1 /** @page account-signals Account Signals |
2 | |
3 @signals | |
12053 | 4 @signal account-added |
6605 | 5 @signal account-connecting |
12053 | 6 @signal account-removed |
12127
944c97d11bb1
[gaim-migrate @ 14427]
Richard Laager <rlaager@wiktel.com>
parents:
12070
diff
changeset
|
7 @signal account-disabled |
944c97d11bb1
[gaim-migrate @ 14427]
Richard Laager <rlaager@wiktel.com>
parents:
12070
diff
changeset
|
8 @signal account-enabled |
6605 | 9 @signal account-setting-info |
10 @signal account-set-info | |
11628 | 11 @signal account-status-changed |
21064
1aaa6e9881b9
Add the account-alias-changed signal to the summary at the top.
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
12 @signal account-alias-changed |
21221
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
13 @signal account-authorization-requested |
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
14 @signal account-authorization-denied |
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
15 @signal account-authorization-granted |
21366
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
16 @signal account-error-changed |
6605 | 17 @endsignals |
18 | |
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16183
diff
changeset
|
19 @see account.h |
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16183
diff
changeset
|
20 |
6605 | 21 <hr> |
22 | |
12053 | 23 @signaldef account-added |
24 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
25 void (*account_added)(PurpleAccount *account); |
12053 | 26 @endsignalproto |
27 @signaldesc | |
28 Emitted when an account is added. | |
29 @param account The account that was added. | |
30 @endsignaldef | |
31 | |
6605 | 32 @signaldef account-connecting |
33 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
34 void (*account_connecting)(PurpleAccount *account); |
6605 | 35 @endsignalproto |
36 @signaldesc | |
37 This is called when an account is in the process of connecting. | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
38 @param account The account in the process of connecting. |
6605 | 39 @endsignaldef |
40 | |
12053 | 41 @signaldef account-removed |
42 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
43 void (*account_removed)(PurpleAccount *account); |
12053 | 44 @endsignalproto |
45 @signaldesc | |
46 Emitted when an account is removed. | |
47 @param account The account that was removed. | |
48 @endsignaldef | |
49 | |
12070 | 50 @signaldef account-disabled |
51 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
52 void (*account_disabled)(PurpleAccount *account); |
12070 | 53 @endsignalproto |
54 @signaldesc | |
55 Emitted when an account is disabled. | |
56 @param account The account that was disabled. | |
57 @endsignaldef | |
58 | |
59 @signaldef account-enabled | |
60 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
61 void (*account_enabled)(PurpleAccount *account); |
12070 | 62 @endsignalproto |
63 @signaldesc | |
64 Emitted when an account is enabled. | |
65 @param account The account that was enabled. | |
66 @endsignaldef | |
67 | |
6605 | 68 @signaldef account-setting-info |
69 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
70 void (*account_setting_info)(PurpleAccount *account, const char *new_info); |
6605 | 71 @endsignalproto |
72 @signaldesc | |
73 Emitted when a user is about to send his new user info, or | |
74 profile, to the server. | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
75 @param account The account that the info will be set on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
76 @param new_info The new information to set. |
6605 | 77 @endsignaldef |
78 | |
79 @signaldef account-set-info | |
80 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
81 void (*account_set_info)(PurpleAccount *account, const char *new_info); |
6605 | 82 @endsignalproto |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
83 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
84 Emitted when a user sent his new user info, or profile, to the server. |
6605 | 85 @param account The account that the info was set on. |
86 @param new_info The new information set. | |
87 @endsignaldef | |
88 | |
11628 | 89 @signaldef account-status-changed |
90 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
91 void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new); |
11628 | 92 @endsignalproto |
93 @signaldesc | |
94 Emitted when the status of an account changes (after the change). | |
95 @param account The account that changed status. | |
96 @param old The status before change. | |
97 @param new The status after change. | |
98 @endsignaldef | |
99 | |
13281
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
100 @signaldef account-alias-changed |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
101 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
102 void (*account_alias_changed)(PurpleAccount *account, const char *old); |
13281
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
103 @endsignalproto |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
104 @signaldesc |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
105 Emitted when the alias of an account changes (after the change). |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
106 @param account The account for which the alias was changed. |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
107 @param old The alias before change. |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
108 @endsignaldef |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
109 |
20178
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
110 @signaldef account-authorization-requested |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
111 @signalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
112 void (*account_authorization_requested)(PurpleAccount *account, const char *user); |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
113 @endsignalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
114 @signaldesc |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
115 Emitted when a user requests authorization. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
116 @param account The account. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
117 @param user The name of the user requesting authorization. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
118 @return Less than zero to deny the request without prompting, greater |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
119 than zero if the request should be granted. If zero is returned, |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
120 then the user will be prompted with the request. |
21221
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
121 @since 2.3.0 |
20178
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
122 @endsignaldef |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
123 |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
124 @signaldef account-authorization-denied |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
125 @signalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
126 void (*account_authorization_denied)(PurpleAccount *account, const char *user); |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
127 @endsignalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
128 @signaldesc |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
129 Emitted when the authorization request for a buddy is denied. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
130 @param account The account. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
131 @param user The name of the user requesting authorization. |
21221
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
132 @since 2.3.0 |
20178
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
133 @endsignaldef |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
134 |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
135 @signaldef account-authorization-granted |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
136 @signalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
137 void (*account_authorization_granted)(PurpleAccount *account, const char *user); |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
138 @endsignalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
139 @signaldesc |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
140 Emitted when the authorization request for a buddy is granted. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
141 @param account The account. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
142 @param user The name of the user requesting authorization. |
21221
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
143 @since 2.3.0 |
20178
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
144 @endsignaldef |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
145 |
21366
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
146 @signaldef account-error-changed |
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
147 @signalproto |
21377
872068d10eab
Mark pointed out that PurpleConnectionErrorPair is not a very good name for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
21374
diff
changeset
|
148 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error); |
21366
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
149 @endsignalproto |
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
150 @signaldesc |
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
151 Emitted when @a account's error changes. |
21373
cbf197042bad
Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21366
diff
changeset
|
152 @param account The account whose error has changed. |
cbf197042bad
Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21366
diff
changeset
|
153 @param old_error The account's previous error, or @c NULL if it had no |
21379
30a532b14003
Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents:
21377
diff
changeset
|
154 error. After this signal is emitted, @a old_error is |
30a532b14003
Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents:
21377
diff
changeset
|
155 not guaranteed to be a valid pointer. |
21373
cbf197042bad
Add the old error to the account-error-changed signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21366
diff
changeset
|
156 @param new_error The account's new error, or @c NULL if it has no error. |
21379
30a532b14003
Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents:
21377
diff
changeset
|
157 If not @c NULL, @a new_error will remain a valid until |
30a532b14003
Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents:
21377
diff
changeset
|
158 pointer just after the next time this signal is emitted |
30a532b14003
Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <will.thompson@collabora.co.uk>
parents:
21377
diff
changeset
|
159 for this @a account. |
21366
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
160 @see purple_account_get_current_error() |
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
161 @since 2.3.0 |
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
162 @endsignaldef |
8858a42ca237
Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <will.thompson@collabora.co.uk>
parents:
21221
diff
changeset
|
163 |
6605 | 164 */ |
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16183
diff
changeset
|
165 // vim: syntax=c.doxygen tw=75 et |