doc/account-signals.dox

Mon, 02 Jul 2012 23:02:14 -0700

author
Mark Doliner <mark@kingant.net>
date
Mon, 02 Jul 2012 23:02:14 -0700
branch
release-2.x.y
changeset 33064
d8e716bfd316
parent 31325
2bb18e0658e7
child 32438
dc8991868906
permissions
-rw-r--r--

Added tag v2.10.5 for changeset a3d157700972

6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /** @page account-signals Account Signals
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
26986
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
4 @signal account-created
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
5 @signal account-destroying
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
6 @signal account-added
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal account-connecting
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
8 @signal account-removed
12127
0ff56edeaaaf [gaim-migrate @ 14427]
Casey Harkins <charkins@pidgin.im>
parents: 12070
diff changeset
9 @signal account-disabled
0ff56edeaaaf [gaim-migrate @ 14427]
Casey Harkins <charkins@pidgin.im>
parents: 12070
diff changeset
10 @signal account-enabled
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
11 @signal account-setting-info
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 @signal account-set-info
11628
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
13 @signal account-status-changed
26871
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
14 @signal account-actions-changed
21140
26ad90b1ead5 Add the account-alias-changed signal to the summary at the top.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
15 @signal account-alias-changed
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
16 @signal account-authorization-requested
31325
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
17 @signal account-authorization-requested-with-message
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
18 @signal account-authorization-denied
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
19 @signal account-authorization-granted
21287
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
20 @signal account-error-changed
29993
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
21 @signal account-signed-on
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
22 @signal account-signed-off
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
23 @signal account-connection-error
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @endsignals
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
26 @see account.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
27
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 <hr>
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29
26986
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
30 @signaldef account-created
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
31 @signalproto
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
32 void (*account_created)(PurpleAccount *account);
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
33 @endsignalproto
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
34 @signaldesc
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
35 Emitted when an account is created by calling purple_account_new.
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
36 @param account The account.
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
37 @since 2.6.0
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
38 @endsignaldef
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
39
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
40 @signaldef account-destroying
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
41 @signalproto
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
42 void (*account_destroying)(PurpleAccount *account);
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
43 @endsignalproto
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
44 @signaldesc
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
45 Emitted when an account is about to be destroyed.
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
46 @param account The account.
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
47 @since 2.6.0
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
48 @endsignaldef
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
49
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
50 @signaldef account-added
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
51 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
52 void (*account_added)(PurpleAccount *account);
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
53 @endsignalproto
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
54 @signaldesc
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
55 Emitted when an account is added.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
56 @param account The account that was added.
26986
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
57 @see purple_accounts_add
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
58 @endsignaldef
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
59
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60 @signaldef account-connecting
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
62 void (*account_connecting)(PurpleAccount *account);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64 @signaldesc
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
65 This is called when an account is in the process of connecting.
6606
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
66 @param account The account in the process of connecting.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
68
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
69 @signaldef account-removed
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
70 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
71 void (*account_removed)(PurpleAccount *account);
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
72 @endsignalproto
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
73 @signaldesc
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
74 Emitted when an account is removed.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
75 @param account The account that was removed.
26986
5b66ec752214 Add account-(created|destroying) signals.
Paul Aurich <darkrain42@pidgin.im>
parents: 26871
diff changeset
76 @see purple_accounts_remove
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
77 @endsignaldef
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents: 11685
diff changeset
78
12070
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
79 @signaldef account-disabled
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
80 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
81 void (*account_disabled)(PurpleAccount *account);
12070
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
82 @endsignalproto
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
83 @signaldesc
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
84 Emitted when an account is disabled.
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
85 @param account The account that was disabled.
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
86 @endsignaldef
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
87
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
88 @signaldef account-enabled
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
89 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
90 void (*account_enabled)(PurpleAccount *account);
12070
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
91 @endsignalproto
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
92 @signaldesc
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
93 Emitted when an account is enabled.
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
94 @param account The account that was enabled.
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
95 @endsignaldef
e678eea4d899 [gaim-migrate @ 14365]
Tim Ringenbach <marv@pidgin.im>
parents: 12053
diff changeset
96
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
97 @signaldef account-setting-info
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
98 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
99 void (*account_setting_info)(PurpleAccount *account, const char *new_info);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
100 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
101 @signaldesc
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
102 Emitted when a user is about to send his new user info, or
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
103 profile, to the server.
6606
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
104 @param account The account that the info will be set on.
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
105 @param new_info The new information to set.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
106 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
107
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
108 @signaldef account-set-info
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
109 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
110 void (*account_set_info)(PurpleAccount *account, const char *new_info);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
111 @endsignalproto
6606
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
112 @signaldesc
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
113 Emitted when a user sent his new user info, or profile, to the server.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
114 @param account The account that the info was set on.
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
115 @param new_info The new information set.
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
116 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
117
11628
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
118 @signaldef account-status-changed
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
119 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
120 void (*account_status_changed)(PurpleAccount *account, PurpleStatus *old, PurpleStatus *new);
11628
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
121 @endsignalproto
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
122 @signaldesc
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
123 Emitted when the status of an account changes (after the change).
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
124 @param account The account that changed status.
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
125 @param old The status before change.
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
126 @param new The status after change.
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
127 @endsignaldef
cdd5df7cfbc1 [gaim-migrate @ 13903]
Casey Harkins <charkins@pidgin.im>
parents: 9447
diff changeset
128
26871
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
129 @signaldef account-actions-changed
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
130 @signalproto
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
131 void (*account_actions_changed)(PurpleAccount *account);
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
132 @endsignalproto
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
133 @signaldesc
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
134 Emitted when the account actions are changed after initial connection.
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
135 @param account The account whose actions changed.
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
136 @endsignaldef
d62964222795 Add a new signal which is emitted (after the account is connected) if the
Paul Aurich <darkrain42@pidgin.im>
parents: 26581
diff changeset
137
13282
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
138 @signaldef account-alias-changed
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
139 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 13282
diff changeset
140 void (*account_alias_changed)(PurpleAccount *account, const char *old);
13282
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
141 @endsignalproto
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
142 @signaldesc
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
143 Emitted when the alias of an account changes (after the change).
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
144 @param account The account for which the alias was changed.
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
145 @param old The alias before change.
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
146 @endsignaldef
83e33fe74de3 [gaim-migrate @ 15647]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12127
diff changeset
147
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
148 @signaldef account-authorization-requested
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
149 @signalproto
26581
669b448a46e5 Update the documentation for the account-authorization-requested signal, as
Richard Laager <rlaager@pidgin.im>
parents: 22430
diff changeset
150 int (*account_authorization_requested)(PurpleAccount *account, const char *user);
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
151 @endsignalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
152 @signaldesc
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
153 Emitted when a user requests authorization.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
154 @param account The account.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
155 @param user The name of the user requesting authorization.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
156 @return Less than zero to deny the request without prompting, greater
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
157 than zero if the request should be granted. If zero is returned,
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
158 then the user will be prompted with the request.
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
159 @since 2.3.0
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
160 @endsignaldef
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
161
31325
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
162 @signaldef account-authorization-requested-with-message
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
163 @signalproto
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
164 int (*account_authorization_requested)(PurpleAccount *account, const char *user, const char *message);
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
165 @endsignalproto
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
166 @signaldesc
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
167 Emitted when a user requests authorization.
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
168 @param account The account.
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
169 @param user The name of the user requesting authorization.
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
170 @param message The authorization request message
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
171 @return PURPLE_ACCOUNT_RESPONSE_IGNORE to silently ignore the request,
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
172 PURPLE_ACCOUNT_RESPONSE_DENY to block the request (the sender might
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
173 get informed, PURPLE_ACCOUNT_RESPONSE_ACCEPT if the request should be
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
174 granted. If PURPLE_ACCOUNT_RESPONSE_PASS is returned, then the user
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
175 will be prompted with the request.
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
176 @since 2.8.0
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
177 @endsignaldef
2bb18e0658e7 Patch from Stefan Ott to add the account-authorization-requested-with-message
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 29993
diff changeset
178
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
179 @signaldef account-authorization-denied
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
180 @signalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
181 void (*account_authorization_denied)(PurpleAccount *account, const char *user);
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
182 @endsignalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
183 @signaldesc
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
184 Emitted when the authorization request for a buddy is denied.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
185 @param account The account.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
186 @param user The name of the user requesting authorization.
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
187 @since 2.3.0
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
188 @endsignaldef
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
189
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
190 @signaldef account-authorization-granted
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
191 @signalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
192 void (*account_authorization_granted)(PurpleAccount *account, const char *user);
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
193 @endsignalproto
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
194 @signaldesc
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
195 Emitted when the authorization request for a buddy is granted.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
196 @param account The account.
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
197 @param user The name of the user requesting authorization.
21205
af0ebfad2b43 Changelog some of the stuff.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 21204
diff changeset
198 @since 2.3.0
20421
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
199 @endsignaldef
e6c82f6c2485 Authorization signals. Modified patch from cockroach. Closes #1061.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16244
diff changeset
200
21287
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
201 @signaldef account-error-changed
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
202 @signalproto
21298
d0d9cfaf3fe7 Mark pointed out that PurpleConnectionErrorPair is not a very good name for the
Will Thompson <resiak@pidgin.im>
parents: 21295
diff changeset
203 void (*account_error_changed)(PurpleAccount *account, const PurpleConnectionErrorInfo *old_error, const PurpleConnectionErrorInfo *current_error);
21287
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
204 @endsignalproto
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
205 @signaldesc
22430
9a2ae22bf043 I think it's reasonable to just say "don't do this".
Will Thompson <resiak@pidgin.im>
parents: 21682
diff changeset
206 Emitted when @a account's error changes. You should not call
9a2ae22bf043 I think it's reasonable to just say "don't do this".
Will Thompson <resiak@pidgin.im>
parents: 21682
diff changeset
207 purple_account_clear_current_error() while this signal is being emitted.
21294
1fe885468da2 Add the old error to the account-error-changed signal.
Will Thompson <resiak@pidgin.im>
parents: 21287
diff changeset
208 @param account The account whose error has changed.
1fe885468da2 Add the old error to the account-error-changed signal.
Will Thompson <resiak@pidgin.im>
parents: 21287
diff changeset
209 @param old_error The account's previous error, or @c NULL if it had no
21300
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
210 error. After this signal is emitted, @a old_error is
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
211 not guaranteed to be a valid pointer.
21294
1fe885468da2 Add the old error to the account-error-changed signal.
Will Thompson <resiak@pidgin.im>
parents: 21287
diff changeset
212 @param new_error The account's new error, or @c NULL if it has no error.
21300
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
213 If not @c NULL, @a new_error will remain a valid until
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
214 pointer just after the next time this signal is emitted
1c23e08cb824 Document exactly how long the PurpleConnectionErrorInfo pointers given out by
Will Thompson <resiak@pidgin.im>
parents: 21298
diff changeset
215 for this @a account.
21287
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
216 @see purple_account_get_current_error()
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
217 @since 2.3.0
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
218 @endsignaldef
c4971408eae8 Make PurpleAccount keep track of the last connection error suffered (or not, if
Will Thompson <resiak@pidgin.im>
parents: 21205
diff changeset
219
29993
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
220 @signaldef account-signed-on
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
221 @signalproto
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
222 void (*signed_on)(PurpleAccount *account);
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
223 @endsignalproto
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
224 @signaldesc
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
225 Emitted when an account has signed on.
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
226 @param account The account that has signed on.
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
227 @since 2.7.0
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
228 @endsignaldef
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
229
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
230 @signaldef account-signed-off
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
231 @signalproto
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
232 void (*signed_off)(PurpleAccount *account);
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
233 @endsignalproto
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
234 @signaldesc
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
235 Emitted when an account has signed off.
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
236 @param account The account that has signed off.
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
237 @since 2.7.0
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
238 @endsignaldef
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
239
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
240 @signaldef account-connection-error
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
241 @signalproto
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
242 void (*connection_error)(PurpleAccount *gc, PurpleConnectionError err, const gchar *desc)
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
243 @endsignalproto
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
244 @signaldesc
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
245 Emitted when a connection error occurs, before @ref signed-off.
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
246 @param account The account on which the error has occurred
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
247 @param err The error that occurred
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
248 @param desc A description of the error, giving more information.
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
249 @since 2.7.0
982a75b07fea Document those signals. Refs #11130.
Paul Aurich <darkrain42@pidgin.im>
parents: 26986
diff changeset
250 @endsignaldef
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
251 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
252 // vim: syntax=c.doxygen tw=75 et

mercurial