Mercurial > pidgin.yaz
comparison doc/blist-signals.dox @ 6605:943b03bcecf5
[gaim-migrate @ 7129]
Added some signal documentation. The conversation signal docs are taking
forever. Who wants to help? :)
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sun, 24 Aug 2003 06:32:28 +0000 |
parents | |
children | 34eaa941ecd6 |
comparison
equal
deleted
inserted
replaced
6604:693262ed19dc | 6605:943b03bcecf5 |
---|---|
1 /** @page blist-signals Buddy List Signals | |
2 | |
3 @signals | |
4 @signal buddy-away | |
5 @signal buddy-back | |
6 @signal buddy-idle | |
7 @signal buddy-unidle | |
8 @signal buddy-signed-on | |
9 @signal buddy-signed-off | |
10 @signal update-idle | |
11 @endsignals | |
12 | |
13 <hr> | |
14 | |
15 @signaldef buddy-away | |
16 @signalproto | |
17 void (*buddy_away)(struct buddy *buddy); | |
18 @endsignalproto | |
19 @param buddy The buddy that went away. | |
20 @signaldesc | |
21 Emitted when a buddy on your buddy list goes away. | |
22 @endsignaldef | |
23 | |
24 @signaldef buddy-back | |
25 @signalproto | |
26 void (*buddy_back)(struct buddy *buddy); | |
27 @endsignalproto | |
28 @param buddy The buddy that came back from being away. | |
29 @signaldesc | |
30 Emitted when a buddy on your buddy list comes back from being away. | |
31 @endsignaldef | |
32 | |
33 @signaldef buddy-idle | |
34 @signalproto | |
35 void (*buddy_idle)(struct buddy *buddy); | |
36 @endsignalproto | |
37 @param buddy The buddy that became idle. | |
38 @signaldesc | |
39 Emitted when a buddy on your buddy list becomes idle. | |
40 @endsignaldef | |
41 | |
42 @signaldef buddy-unidle | |
43 @signalproto | |
44 void (*buddy_unidle)(struct buddy *buddy); | |
45 @endsignalproto | |
46 @param buddy The buddy that returned from being idle. | |
47 @signaldesc | |
48 Emitted when a buddy on your buddy list returns from being idle. | |
49 @endsignaldef | |
50 | |
51 @signaldef buddy-signed-on | |
52 @signalproto | |
53 void (*buddy_signed_on)(struct buddy *buddy); | |
54 @endsignalproto | |
55 @param buddy The buddy that signed on. | |
56 @signaldesc | |
57 Emitted when a buddy on your buddy list signs on. | |
58 @endsignaldef | |
59 | |
60 @signaldef buddy-signed-off | |
61 @signalproto | |
62 void (*buddy_signed_off)(struct buddy *buddy); | |
63 @endsignalproto | |
64 @param buddy The buddy that signed off. | |
65 @signaldesc | |
66 Emitted when a buddy on your buddy list signs off. | |
67 @endsignaldef | |
68 | |
69 @signaldef update-idle | |
70 @signalproto | |
71 void (*update_idle)(); | |
72 @endsignalproto | |
73 @signaldesc | |
74 Emitted when the buddy list is refreshed and the idle times are updated. | |
75 @endsignaldef | |
76 | |
77 */ | |
78 // vim: syntax=c tw=75 et |