Mercurial > pidgin
annotate doc/connection-signals.dox @ 32819:2c6510167895 default tip
propagate from branch 'im.pidgin.pidgin.2.x.y' (head 3315c5dfbd0ad16511bdcf865e5b07c02d07df24)
to branch 'im.pidgin.pidgin' (head cbd1eda6bcbf0565ae7766396bb8f6f419cb6a9a)
author | Elliott Sales de Andrade <qulogic@pidgin.im> |
---|---|
date | Sat, 02 Jun 2012 02:30:49 +0000 |
parents | 02a2e8183b1d |
children |
rev | line source |
---|---|
6724
aca39e77db85
[gaim-migrate @ 7251]
Christian Hammond <chipx86@chipx86.com>
parents:
6611
diff
changeset
|
1 /** @page connection-signals Connection Signals |
6611 | 2 |
3 @signals | |
4 @signal signing-on | |
5 @signal signed-on | |
29753
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
6 @signal autojoin |
6611 | 7 @signal signing-off |
8 @signal signed-off | |
23543
95a7d1a72fd9
A2B in #pidgin noticed that the link was missing
Ka-Hing Cheung <khc@hxbc.us>
parents:
21365
diff
changeset
|
9 @signal connection-error |
6611 | 10 @endsignals |
11 | |
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
|
12 @see connection.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
|
13 |
6611 | 14 <hr> |
15 | |
16 @signaldef signing-on | |
17 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
6724
diff
changeset
|
18 void (*signing_on)(PurpleConnection *gc); |
6611 | 19 @endsignalproto |
20 @signaldesc | |
21 Emitted when a connection is about to sign on. | |
22 @param gc The connection that is about to sign on. | |
23 @endsignaldef | |
24 | |
25 @signaldef signed-on | |
26 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
6724
diff
changeset
|
27 void (*signed_on)(PurpleConnection *gc); |
6611 | 28 @endsignalproto |
29 @signaldesc | |
30 Emitted when a connection has signed on. | |
31 @param gc The connection that has signed on. | |
32 @endsignaldef | |
33 | |
29753
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
34 @signaldef autojoin |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
35 @signalproto |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
36 gboolean (*autojoin)(PurpleConnection *gc); |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
37 @endsignalproto |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
38 @signaldesc |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
39 Emitted when a connection has signed on, after the signed-on signal, to |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
40 signal UIs to autojoin chats if they wish. UIs should connect to this |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
41 with @c PURPLE_SIGNAL_PRIORITY_HIGHEST to allow plugins to block this |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
42 signal before the UI sees it and then re-emit it later. |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
43 @param gc The connection that has signed on. |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
44 @return @c TRUE if the signal was handled or @c FALSE otherwise. In |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
45 practice, the return value is irrelevant, as it really only |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
46 exists so plugins can block the UI's autojoin. |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
47 @endsignaldef |
378cceb9131d
Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents:
27284
diff
changeset
|
48 |
6611 | 49 @signaldef signing-off |
50 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
6724
diff
changeset
|
51 void (*signing_off)(PurpleConnection *gc); |
6611 | 52 @endsignalproto |
53 @signaldesc | |
54 Emitted when a connection is about to sign off. | |
55 @param gc The connection that is about to sign off. | |
56 @endsignaldef | |
57 | |
58 @signaldef signed-off | |
59 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
6724
diff
changeset
|
60 void (*signed_off)(PurpleConnection *gc); |
6611 | 61 @endsignalproto |
62 @signaldesc | |
63 Emitted when a connection has signed off. | |
64 @param gc The connection that has signed off. | |
65 @endsignaldef | |
66 | |
21365
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
67 @signaldef connection-error |
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
68 @signalproto |
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
69 void (*connection_error)(PurpleConnection *gc, PurpleConnectionError err, const gchar *desc) |
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
70 @endsignalproto |
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
71 @signaldesc |
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
72 Emitted when a connection error occurs, before @ref signed-off. |
27284
73c8e1964eef
A semi-random collection of English spelling and grammatical changes.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
23543
diff
changeset
|
73 @param gc The connection on which the error has occurred |
73c8e1964eef
A semi-random collection of English spelling and grammatical changes.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
23543
diff
changeset
|
74 @param err The error that occurred |
21365
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
75 @param desc A description of the error, giving more information. |
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
76 @endsignaldef |
3a269007711e
Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20807
diff
changeset
|
77 |
6611 | 78 */ |
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
|
79 // vim: syntax=c.doxygen tw=75 et |