annotate doc/connection-signals.dox @ 31519:3389c248e2b3

propagate from branch 'im.pidgin.pidgin.mxit' (head 3d58b1f843fc2aebf9411756956d07ae96951623) to branch 'im.pidgin.pidgin' (head 68d280808dc7fafe82192c72f81929fa14b14b5c)
author John Bailey <rekkanoryo@rekkanoryo.org>
date Mon, 02 May 2011 03:42:24 +0000
parents 50729e095c3c
children 02a2e8183b1d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6724
aca39e77db85 [gaim-migrate @ 7251]
Christian Hammond <chipx86@chipx86.com>
parents: 6611
diff changeset
1 /** @page connection-signals Connection Signals
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
4 @signal signing-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 @signal signed-on
29753
378cceb9131d Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents: 27284
diff changeset
6 @signal autojoin
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal signing-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
10 @endsignals
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 <hr>
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 @signaldef signing-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 Emitted when a connection is about to sign on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 @param gc The connection that is about to sign on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 @signaldef signed-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 Emitted when a connection has signed on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31 @param gc The connection that has signed on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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.
29764
50729e095c3c Add a @since tag for the new autojoin signal
Richard Laager <rlaager@wiktel.com>
parents: 29753
diff changeset
47 @since 2.7.0
29753
378cceb9131d Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents: 27284
diff changeset
48 @endsignaldef
378cceb9131d Add an autojoin connection signal
Richard Laager <rlaager@wiktel.com>
parents: 27284
diff changeset
49
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50 @signaldef signing-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
51 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
52 void (*signing_off)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
53 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
54 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
55 Emitted when a connection is about to sign off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
56 @param gc The connection that is about to sign off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
57 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
58
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
59 @signaldef signed-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
61 void (*signed_off)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
62 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64 Emitted when a connection has signed off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
65 @param gc The connection that has signed off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
66 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67
21365
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
68 @signaldef connection-error
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
69 @signalproto
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
70 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
71 @endsignalproto
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
72 @signaldesc
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
73 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
74 @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
75 @param err The error that occurred
21365
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
76 @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
77 @endsignaldef
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
78
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
79 */
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
80 // vim: syntax=c.doxygen tw=75 et