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