doc/connection-signals.dox@402d25ce01da (annotated)
doc/connection-signals.dox
Mon, 08 Jun 2009 02:24:49 +0000
- author
- Elliott Sales de Andrade <qulogic@pidgin.im>
- date
- Mon, 08 Jun 2009 02:24:49 +0000
- changeset 27314
- 402d25ce01da
- parent 23860
- 53c2e53a3f05
- child 27525
- 579b9d64b364
- permissions
- -rw-r--r--
Use the JID for adding a chat/buddy because the name is for descriptive
purpose only, and using it will not fill in the Add Chat dialog correctly.
Because the JID is not visible, the user will not know what to actually put
there instead.
|
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 | |
|
23860
53c2e53a3f05
A2B in #pidgin noticed that the link was missing
Ka-Hing Cheung <khc@pidgin.im>
parents:
21286
diff
changeset
|
8 | @signal connection-error |
| 6611 | 9 | @endsignals |
| 10 | ||
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
11 | @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
|
12 | |
| 6611 | 13 | <hr> |
| 14 | ||
| 15 | @signaldef signing-on | |
| 16 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
6724
diff
changeset
|
17 | void (*signing_on)(PurpleConnection *gc); |
| 6611 | 18 | @endsignalproto |
| 19 | @signaldesc | |
| 20 | Emitted when a connection is about to sign on. | |
| 21 | @param gc The connection that is about to sign on. | |
| 22 | @endsignaldef | |
| 23 | ||
| 24 | @signaldef signed-on | |
| 25 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
6724
diff
changeset
|
26 | void (*signed_on)(PurpleConnection *gc); |
| 6611 | 27 | @endsignalproto |
| 28 | @signaldesc | |
| 29 | Emitted when a connection has signed on. | |
| 30 | @param gc The connection that has signed on. | |
| 31 | @endsignaldef | |
| 32 | ||
| 33 | @signaldef signing-off | |
| 34 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
6724
diff
changeset
|
35 | void (*signing_off)(PurpleConnection *gc); |
| 6611 | 36 | @endsignalproto |
| 37 | @signaldesc | |
| 38 | Emitted when a connection is about to sign off. | |
| 39 | @param gc The connection that is about to sign off. | |
| 40 | @endsignaldef | |
| 41 | ||
| 42 | @signaldef signed-off | |
| 43 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
6724
diff
changeset
|
44 | void (*signed_off)(PurpleConnection *gc); |
| 6611 | 45 | @endsignalproto |
| 46 | @signaldesc | |
| 47 | Emitted when a connection has signed off. | |
| 48 | @param gc The connection that has signed off. | |
| 49 | @endsignaldef | |
| 50 | ||
|
21286
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
51 | @signaldef connection-error |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
52 | @signalproto |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
53 | void (*connection_error)(PurpleConnection *gc, PurpleConnectionError err, const gchar *desc) |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
54 | @endsignalproto |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
55 | @signaldesc |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
56 | Emitted when a connection error occurs, before @ref signed-off. |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
57 | @param gc The connection on which the error has occured |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
58 | @param err The error that occured |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
59 | @param desc A description of the error, giving more information. |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
60 | @endsignaldef |
|
759b1949f5ce
Document connection-error signal.
Will Thompson <resiak@pidgin.im>
parents:
20897
diff
changeset
|
61 | |
| 6611 | 62 | */ |
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
63 | // vim: syntax=c.doxygen tw=75 et |
