doc/blist-signals.dox@1d95c7294577 (annotated)
doc/blist-signals.dox
Mon, 31 Oct 2005 22:02:30 +0000
- author
- Etan Reisner <deryni@pidgin.im>
- date
- Mon, 31 Oct 2005 22:02:30 +0000
- changeset 11935
- 1d95c7294577
- parent 11454
- a604c2097a6e
- child 11942
- e392054bc95b
- permissions
- -rw-r--r--
[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.
| 6605 | 1 | /** @page blist-signals Buddy List Signals |
| 2 | ||
| 3 | @signals | |
| 11935 | 4 | @signal buddy-status-changed |
| 5 | @signal buddy-idle-changed | |
| 6605 | 6 | @signal buddy-signed-on |
| 7 | @signal buddy-signed-off | |
| 8 | @signal update-idle | |
| 9051 | 9 | @signal blist-node-extended-menu |
| 11454 | 10 | @signal buddy-added |
| 11 | @signal buddy-removed | |
| 12 | @signal blist-node-aliased | |
| 6605 | 13 | @endsignals |
| 14 | ||
| 15 | <hr> | |
| 16 | ||
| 11935 | 17 | @signaldef buddy-status-changed |
| 6605 | 18 | @signalproto |
| 11935 | 19 | void (*buddy_away)(GaimBuddy *buddy, GaimStatus *old_status, GaimStatus *status); |
| 6605 | 20 | @endsignalproto |
| 21 | @signaldesc | |
| 22 | Emitted when a buddy on your buddy list goes away. | |
| 11935 | 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. | |
| 6605 | 26 | @endsignaldef |
| 27 | ||
| 11935 | 28 | @signaldef buddy-idle-changed |
| 6605 | 29 | @signalproto |
| 11935 | 30 | void (*buddy_idle)(GaimBuddy *buddy, gboolean old_idle, gboolean idle); |
| 6605 | 31 | @endsignalproto |
| 32 | @signaldesc | |
| 33 | Emitted when a buddy on your buddy list becomes idle. | |
| 11935 | 34 | @param buddy The buddy that became idle. |
| 35 | @param old_idle Whether the buddy was idle. | |
| 36 | @param idle Whether the buddy is currently idle. | |
|
9111
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
37 | @endsignaldef |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
38 | |
| 6605 | 39 | @signaldef buddy-signed-on |
| 40 | @signalproto | |
| 11935 | 41 | void (*buddy_signed_on)(GaimBuddy *buddy); |
| 6605 | 42 | @endsignalproto |
| 43 | @signaldesc | |
| 44 | Emitted when a buddy on your buddy list signs on. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
45 | @param buddy The buddy that signed on. |
| 6605 | 46 | @endsignaldef |
| 47 | ||
| 48 | @signaldef buddy-signed-off | |
| 49 | @signalproto | |
| 11935 | 50 | void (*buddy_signed_off)(GaimBuddy *buddy); |
| 6605 | 51 | @endsignalproto |
| 52 | @signaldesc | |
| 53 | Emitted when a buddy on your buddy list signs off. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
54 | @param buddy The buddy that signed off. |
| 6605 | 55 | @endsignaldef |
| 56 | ||
| 57 | @signaldef update-idle | |
| 58 | @signalproto | |
| 59 | void (*update_idle)(); | |
| 60 | @endsignalproto | |
| 61 | @signaldesc | |
| 62 | Emitted when the buddy list is refreshed and the idle times are updated. | |
| 63 | @endsignaldef | |
| 64 | ||
| 9051 | 65 | @signaldef blist-node-extended-menu |
| 66 | @signalproto | |
| 67 | void (*blist_node_extended_menu)(GaimBlistNode *node, GList **menu) | |
| 68 | @endsignalproto | |
| 69 | @signaldesc | |
| 70 | Emitted when a buddlist menu is being constructed @a menu is a pointer to | |
| 71 | a GList of GaimBlistNodeAction's allowing a plugin to add menu items | |
| 72 | @endsignaldef | |
| 73 | ||
| 11454 | 74 | @signaldef buddy-added |
| 75 | @signalproto | |
| 76 | void (*buddy_added)(GaimBuddy *buddy) | |
| 77 | @endsignalproto | |
| 78 | @signaldesc | |
| 79 | Emitted when a new buddy is added to the buddy list. | |
| 80 | @endsignaldef | |
| 81 | ||
| 82 | @signaldef buddy-removed | |
| 83 | @signalproto | |
| 84 | void (*buddy_removed)(GaimBuddy *buddy) | |
| 85 | @endsignalproto | |
| 86 | @signaldesc | |
| 87 | Emitted when a buddy is removed from the buddy list. | |
| 88 | @endsignaldef | |
| 89 | ||
| 90 | @signaldef blist-node-aliased | |
| 91 | @signalproto | |
| 92 | void (*blist_node_aliased)(GaimBlistNode *node, const char *old_alias) | |
| 93 | @endsignalproto | |
| 94 | @signaldesc | |
| 95 | Emitted when a blist node (buddy, chat, or contact) is aliased. | |
| 96 | @endsignaldef | |
| 97 | ||
| 6605 | 98 | */ |
| 99 | // vim: syntax=c tw=75 et |
