annotate doc/connection-signals.dox @ 22129:dd51079b3d8c

Only try to set the itmsurl attribute for the available status. I'd forgotten about that when I changed this a few days ago. As far as I know it's only supported when you're "available." If it works for other statuses then please let me know and I'll make the appropriate changes.
author Mark Doliner <mark@kingant.net>
date Wed, 16 Jan 2008 07:51:44 +0000
parents 3a269007711e
children 95a7d1a72fd9
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
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 @signal signing-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal signed-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 @endsignals
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9
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
10 @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
11
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 <hr>
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 @signaldef signing-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
16 void (*signing_on)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 Emitted when a connection is about to sign on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 @param gc The connection that is about to sign on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 @signaldef signed-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
25 void (*signed_on)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 Emitted when a connection has signed on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @param gc The connection that has signed on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @signaldef signing-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
34 void (*signing_off)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 Emitted when a connection is about to sign off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38 @param gc The connection that is about to sign off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
41 @signaldef signed-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
42 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
43 void (*signed_off)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 Emitted when a connection has signed off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 @param gc The connection that has signed off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49
21365
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
50 @signaldef connection-error
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
51 @signalproto
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
52 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
53 @endsignalproto
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
54 @signaldesc
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
55 Emitted when a connection error occurs, before @ref signed-off.
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
56 @param gc The connection on which the error has occured
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
57 @param err The error that occured
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
58 @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
59 @endsignaldef
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
60
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 */
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
62 // vim: syntax=c.doxygen tw=75 et