doc/connection-signals.dox@b61f17ea0f68 (annotated)
doc/connection-signals.dox
Sun, 30 Dec 2007 12:36:56 +0000
- author
- Will Thompson <resiak@pidgin.im>
- date
- Sun, 30 Dec 2007 12:36:56 +0000
- changeset 22089
- b61f17ea0f68
- parent 21286
- 759b1949f5ce
- child 23860
- 53c2e53a3f05
- permissions
- -rw-r--r--
I think that now that it's easy to re-enable accounts that got a connection
error, this TODO is obsolete.
|
6724
e1d416a4a4bc
[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 | |
| 6 | @signal signing-off | |
| 7 | @signal signed-off | |
| 8 | @endsignals | |
| 9 | ||
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
10 | @see connection.h |
|
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
11 | |
| 6611 | 12 | <hr> |
| 13 | ||
| 14 | @signaldef signing-on | |
| 15 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
6724
diff
changeset
|
16 | void (*signing_on)(PurpleConnection *gc); |
| 6611 | 17 | @endsignalproto |
| 18 | @signaldesc | |
| 19 | Emitted when a connection is about to sign on. | |
| 20 | @param gc The connection that is about to sign on. | |
| 21 | @endsignaldef | |
| 22 | ||
| 23 | @signaldef signed-on | |
| 24 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
6724
diff
changeset
|
25 | void (*signed_on)(PurpleConnection *gc); |
| 6611 | 26 | @endsignalproto |
| 27 | @signaldesc | |
| 28 | Emitted when a connection has signed on. | |
| 29 | @param gc The connection that has signed on. | |
| 30 | @endsignaldef | |
| 31 | ||
| 32 | @signaldef signing-off | |
| 33 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
6724
diff
changeset
|
34 | void (*signing_off)(PurpleConnection *gc); |
| 6611 | 35 | @endsignalproto |
| 36 | @signaldesc | |
| 37 | Emitted when a connection is about to sign off. | |
| 38 | @param gc The connection that is about to sign off. | |
| 39 | @endsignaldef | |
| 40 | ||
| 41 | @signaldef signed-off | |
| 42 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
6724
diff
changeset
|
43 | void (*signed_off)(PurpleConnection *gc); |
| 6611 | 44 | @endsignalproto |
| 45 | @signaldesc | |
| 46 | Emitted when a connection has signed off. | |
| 47 | @param gc The connection that has signed off. | |
| 48 | @endsignaldef | |
| 49 | ||
|
21286
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
50 | @signaldef connection-error |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
51 | @signalproto |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
52 | void (*connection_error)(PurpleConnection *gc, PurpleConnectionError err, const gchar *desc) |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
53 | @endsignalproto |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
54 | @signaldesc |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
55 | Emitted when a connection error occurs, before @ref signed-off. |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
56 | @param gc The connection on which the error has occured |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
57 | @param err The error that occured |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
58 | @param desc A description of the error, giving more information. |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
59 | @endsignaldef |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
60 | |
| 6611 | 61 | */ |
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
62 | // vim: syntax=c.doxygen tw=75 et |
