Mercurial > pidgin
comparison doc/blist-signals.dox @ 11935:cb73483c9f63
[gaim-migrate @ 14226]
Here are buddy-status-changed and buddy-idle-changed signals, to replace
buddy-away, buddy-back, buddy-idle, and buddy-unidle. It it now possible to
detect when a buddy goes from one away-state to another away-state without
coming back in between.
I'm not really sure I like how buddy-idle-changed works here, but it felt
better to keep it consistent. It currently only fires on idle and unidle and
not on just-more-idle, though that's easy to change if we decide plugins might
want to know as idle time increases.
I think I got all the doxygen and ChangeLog.API stuff, someone yell if I
missed something.
committer: Tailor Script <tailor@pidgin.im>
author | Etan Reisner <pidgin@unreliablesource.net> |
---|---|
date | Mon, 31 Oct 2005 22:02:30 +0000 |
parents | 201617d49573 |
children | a24cfe32961a |
comparison
equal
deleted
inserted
replaced
11934:525cf7ecd919 | 11935:cb73483c9f63 |
---|---|
1 /** @page blist-signals Buddy List Signals | 1 /** @page blist-signals Buddy List Signals |
2 | 2 |
3 @signals | 3 @signals |
4 @signal buddy-away | 4 @signal buddy-status-changed |
5 @signal buddy-back | 5 @signal buddy-idle-changed |
6 @signal buddy-idle | |
7 @signal buddy-unidle | |
8 @signal buddy-signed-on | 6 @signal buddy-signed-on |
9 @signal buddy-signed-off | 7 @signal buddy-signed-off |
10 @signal update-idle | 8 @signal update-idle |
11 @signal blist-node-extended-menu | 9 @signal blist-node-extended-menu |
12 @signal buddy-added | 10 @signal buddy-added |
14 @signal blist-node-aliased | 12 @signal blist-node-aliased |
15 @endsignals | 13 @endsignals |
16 | 14 |
17 <hr> | 15 <hr> |
18 | 16 |
19 @signaldef buddy-away | 17 @signaldef buddy-status-changed |
20 @signalproto | 18 @signalproto |
21 void (*buddy_away)(struct buddy *buddy); | 19 void (*buddy_away)(GaimBuddy *buddy, GaimStatus *old_status, GaimStatus *status); |
22 @endsignalproto | 20 @endsignalproto |
23 @signaldesc | 21 @signaldesc |
24 Emitted when a buddy on your buddy list goes away. | 22 Emitted when a buddy on your buddy list goes away. |
25 @param buddy The buddy that went away. | 23 @param buddy The buddy that went away. |
24 @param old_status The status that the buddy just changed from. | |
25 @param status The status that the buddy just changed to. | |
26 @endsignaldef | 26 @endsignaldef |
27 | 27 |
28 @signaldef buddy-back | 28 @signaldef buddy-idle-changed |
29 @signalproto | 29 @signalproto |
30 void (*buddy_back)(struct buddy *buddy); | 30 void (*buddy_idle)(GaimBuddy *buddy, gboolean old_idle, gboolean idle); |
31 @endsignalproto | |
32 @signaldesc | |
33 Emitted when a buddy on your buddy list comes back from being away. | |
34 @param buddy The buddy that came back from being away. | |
35 @endsignaldef | |
36 | |
37 @signaldef buddy-idle | |
38 @signalproto | |
39 void (*buddy_idle)(struct buddy *buddy); | |
40 @endsignalproto | 31 @endsignalproto |
41 @signaldesc | 32 @signaldesc |
42 Emitted when a buddy on your buddy list becomes idle. | 33 Emitted when a buddy on your buddy list becomes idle. |
43 @param buddy The buddy that became idle. | 34 @param buddy The buddy that became idle. |
44 @endsignaldef | 35 @param old_idle Whether the buddy was idle. |
45 | 36 @param idle Whether the buddy is currently idle. |
46 @signaldef buddy-unidle | |
47 @signalproto | |
48 void (*buddy_unidle)(struct buddy *buddy); | |
49 @endsignalproto | |
50 @signaldesc | |
51 Emitted when a buddy on your buddy list returns from being idle. | |
52 @param buddy The buddy that returned from being idle. | |
53 @endsignaldef | |
54 | |
55 @signaldef buddy-idle-updated | |
56 @signalproto | |
57 void (*buddy_idle_updated)(struct buddy *buddy); | |
58 @endsignalproto | |
59 @signaldesc | |
60 Emitted when a buddy's idle time changes. The exceptions are when the | |
61 buddy goes from being idle to being unidle, or from unidle to idle. | |
62 @param buddy The buddy whose idle time changed. | |
63 @endsignaldef | 37 @endsignaldef |
64 | 38 |
65 @signaldef buddy-signed-on | 39 @signaldef buddy-signed-on |
66 @signalproto | 40 @signalproto |
67 void (*buddy_signed_on)(struct buddy *buddy); | 41 void (*buddy_signed_on)(GaimBuddy *buddy); |
68 @endsignalproto | 42 @endsignalproto |
69 @signaldesc | 43 @signaldesc |
70 Emitted when a buddy on your buddy list signs on. | 44 Emitted when a buddy on your buddy list signs on. |
71 @param buddy The buddy that signed on. | 45 @param buddy The buddy that signed on. |
72 @endsignaldef | 46 @endsignaldef |
73 | 47 |
74 @signaldef buddy-signed-off | 48 @signaldef buddy-signed-off |
75 @signalproto | 49 @signalproto |
76 void (*buddy_signed_off)(struct buddy *buddy); | 50 void (*buddy_signed_off)(GaimBuddy *buddy); |
77 @endsignalproto | 51 @endsignalproto |
78 @signaldesc | 52 @signaldesc |
79 Emitted when a buddy on your buddy list signs off. | 53 Emitted when a buddy on your buddy list signs off. |
80 @param buddy The buddy that signed off. | 54 @param buddy The buddy that signed off. |
81 @endsignaldef | 55 @endsignaldef |