Mercurial > pidgin
annotate doc/account-signals.dox @ 21234:aabe638f56d9
Wrap the newly deprecated functions with #ifndef PURPLE_DISABLE_DEPRECATED.
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sun, 14 Oct 2007 03:14:43 +0000 |
parents | e98c08afb706 |
children | 8858a42ca237 ad718740aa71 |
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 |
21221
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
12 @signal account-authorization-requested |
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
13 @signal account-authorization-denied |
e98c08afb706
Changelog some of the stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21220
diff
changeset
|
14 @signal account-authorization-granted |
6605 | 15 @endsignals |
16 | |
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
|
17 @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
|
18 |
6605 | 19 <hr> |
20 | |
12053 | 21 @signaldef account-added |
22 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
23 void (*account_added)(PurpleAccount *account); |
12053 | 24 @endsignalproto |
25 @signaldesc | |
26 Emitted when an account is added. | |
27 @param account The account that was added. | |
28 @endsignaldef | |
29 | |
6605 | 30 @signaldef account-connecting |
31 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
32 void (*account_connecting)(PurpleAccount *account); |
6605 | 33 @endsignalproto |
34 @signaldesc | |
35 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
|
36 @param account The account in the process of connecting. |
6605 | 37 @endsignaldef |
38 | |
12053 | 39 @signaldef account-removed |
40 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
41 void (*account_removed)(PurpleAccount *account); |
12053 | 42 @endsignalproto |
43 @signaldesc | |
44 Emitted when an account is removed. | |
45 @param account The account that was removed. | |
46 @endsignaldef | |
47 | |
12070 | 48 @signaldef account-disabled |
49 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
50 void (*account_disabled)(PurpleAccount *account); |
12070 | 51 @endsignalproto |
52 @signaldesc | |
53 Emitted when an account is disabled. | |
54 @param account The account that was disabled. | |
55 @endsignaldef | |
56 | |
57 @signaldef account-enabled | |
58 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
59 void (*account_enabled)(PurpleAccount *account); |
12070 | 60 @endsignalproto |
61 @signaldesc | |
62 Emitted when an account is enabled. | |
63 @param account The account that was enabled. | |
64 @endsignaldef | |
65 | |
6605 | 66 @signaldef account-setting-info |
67 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
68 void (*account_setting_info)(PurpleAccount *account, const char *new_info); |
6605 | 69 @endsignalproto |
70 @signaldesc | |
71 Emitted when a user is about to send his new user info, or | |
72 profile, to the server. | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
73 @param account The account that the info will be set on. |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
74 @param new_info The new information to set. |
6605 | 75 @endsignaldef |
76 | |
77 @signaldef account-set-info | |
78 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
79 void (*account_set_info)(PurpleAccount *account, const char *new_info); |
6605 | 80 @endsignalproto |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
81 @signaldesc |
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
82 Emitted when a user sent his new user info, or profile, to the server. |
6605 | 83 @param account The account that the info was set on. |
84 @param new_info The new information set. | |
85 @endsignaldef | |
86 | |
11628 | 87 @signaldef account-status-changed |
88 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
89 void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new); |
11628 | 90 @endsignalproto |
91 @signaldesc | |
92 Emitted when the status of an account changes (after the change). | |
93 @param account The account that changed status. | |
94 @param old The status before change. | |
95 @param new The status after change. | |
96 @endsignaldef | |
97 | |
13281
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
98 @signaldef account-alias-changed |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
99 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
13281
diff
changeset
|
100 void (*account_alias_changed)(PurpleAccount *account, const char *old); |
13281
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
101 @endsignalproto |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
102 @signaldesc |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
103 Emitted when the alias of an account changes (after the change). |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
104 @param account The account for which the alias was changed. |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
105 @param old The alias before change. |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
106 @endsignaldef |
e629076386f1
[gaim-migrate @ 15647]
Richard Laager <rlaager@wiktel.com>
parents:
12127
diff
changeset
|
107 |
20178
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
108 @signaldef account-authorization-requested |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
109 @signalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
110 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
|
111 @endsignalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
112 @signaldesc |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
113 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
|
114 @param account The account. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
115 @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
|
116 @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
|
117 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
|
118 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
|
119 @since 2.3.0 |
20178
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
120 @endsignaldef |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
121 |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
122 @signaldef account-authorization-denied |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
123 @signalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
124 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
|
125 @endsignalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
126 @signaldesc |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
127 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
|
128 @param account The account. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
129 @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
|
130 @since 2.3.0 |
20178
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
131 @endsignaldef |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
132 |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
133 @signaldef account-authorization-granted |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
134 @signalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
135 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
|
136 @endsignalproto |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
137 @signaldesc |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
138 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
|
139 @param account The account. |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
140 @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
|
141 @since 2.3.0 |
20178
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
142 @endsignaldef |
8e3ef71c4362
Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
16183
diff
changeset
|
143 |
6605 | 144 */ |
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
|
145 // vim: syntax=c.doxygen tw=75 et |