doc/connection-signals.dox

Fri, 27 Jun 2008 01:29:59 +0000

author
Justin Rodriguez <ffdragon@soc.pidgin.im>
date
Fri, 27 Jun 2008 01:29:59 +0000
branch
soc.2008.themes
changeset 23649
5da5fe967d10
parent 21286
759b1949f5ce
child 23860
53c2e53a3f05
permissions
-rw-r--r--

Working sound themes (option 1) theme is saved in prefs and there is no seperate custom theme, everything
else is backwards compatiable, sound plays but the theme is not always found

6724
e1d416a4a4bc [gaim-migrate @ 7251]
Christian Hammond <chipx86@chipx86.com>
parents: 6611
diff changeset
1 /** @page connection-signals Connection Signals
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
4 @signal signing-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 @signal signed-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 @signal signing-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal signed-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 @endsignals
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 <hr>
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 @signaldef signing-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 Emitted when a connection is about to sign on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 @param gc The connection that is about to sign on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 @signaldef signed-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 Emitted when a connection has signed on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @param gc The connection that has signed on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @signaldef signing-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 Emitted when a connection is about to sign off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38 @param gc The connection that is about to sign off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
41 @signaldef signed-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 Emitted when a connection has signed off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 @param gc The connection that has signed off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
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

mercurial