Mercurial > pidgin
comparison doc/connection-signals.dox @ 31189:f2e0b8f38e14
propagate from branch 'im.pidgin.pidgin' (head 69fbc32fd3dfe8ca0979e1c486c3d51eb06088cf)
to branch 'im.pidgin.pidgin.openq' (head 0a02249008d0dad085b600dd65c45a347d1c84aa)
author | SHiNE CsyFeK <csyfek@gmail.com> |
---|---|
date | Sun, 07 Nov 2010 04:48:56 +0000 |
parents | 50729e095c3c |
children | 02a2e8183b1d |
comparison
equal
deleted
inserted
replaced
31188:35224e759210 | 31189:f2e0b8f38e14 |
---|---|
1 /** @page connection-signals Connection Signals | 1 /** @page connection-signals Connection Signals |
2 | 2 |
3 @signals | 3 @signals |
4 @signal signing-on | 4 @signal signing-on |
5 @signal signed-on | 5 @signal signed-on |
6 @signal autojoin | |
6 @signal signing-off | 7 @signal signing-off |
7 @signal signed-off | 8 @signal signed-off |
8 @signal connection-error | 9 @signal connection-error |
9 @endsignals | 10 @endsignals |
10 | 11 |
26 void (*signed_on)(PurpleConnection *gc); | 27 void (*signed_on)(PurpleConnection *gc); |
27 @endsignalproto | 28 @endsignalproto |
28 @signaldesc | 29 @signaldesc |
29 Emitted when a connection has signed on. | 30 Emitted when a connection has signed on. |
30 @param gc The connection that has signed on. | 31 @param gc The connection that has signed on. |
32 @endsignaldef | |
33 | |
34 @signaldef autojoin | |
35 @signalproto | |
36 gboolean (*autojoin)(PurpleConnection *gc); | |
37 @endsignalproto | |
38 @signaldesc | |
39 Emitted when a connection has signed on, after the signed-on signal, to | |
40 signal UIs to autojoin chats if they wish. UIs should connect to this | |
41 with @c PURPLE_SIGNAL_PRIORITY_HIGHEST to allow plugins to block this | |
42 signal before the UI sees it and then re-emit it later. | |
43 @param gc The connection that has signed on. | |
44 @return @c TRUE if the signal was handled or @c FALSE otherwise. In | |
45 practice, the return value is irrelevant, as it really only | |
46 exists so plugins can block the UI's autojoin. | |
47 @since 2.7.0 | |
31 @endsignaldef | 48 @endsignaldef |
32 | 49 |
33 @signaldef signing-off | 50 @signaldef signing-off |
34 @signalproto | 51 @signalproto |
35 void (*signing_off)(PurpleConnection *gc); | 52 void (*signing_off)(PurpleConnection *gc); |