doc/blist-signals.dox@e5e3fca89af4 (annotated)
doc/blist-signals.dox
Fri, 28 May 2004 06:10:13 +0000
- author
- Christian Hammond <chipx86@chipx86.com>
- date
- Fri, 28 May 2004 06:10:13 +0000
- changeset 9111
- e5e3fca89af4
- parent 9051
- aebb592d4529
- child 11454
- a604c2097a6e
- permissions
- -rw-r--r--
[gaim-migrate @ 9888]
Document the signal.
| 6605 | 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 | |
| 9051 | 11 | @signal blist-node-extended-menu |
| 6605 | 12 | @endsignals |
| 13 | ||
| 14 | <hr> | |
| 15 | ||
| 16 | @signaldef buddy-away | |
| 17 | @signalproto | |
| 18 | void (*buddy_away)(struct buddy *buddy); | |
| 19 | @endsignalproto | |
| 20 | @signaldesc | |
| 21 | Emitted when a buddy on your buddy list goes away. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
22 | @param buddy The buddy that went away. |
| 6605 | 23 | @endsignaldef |
| 24 | ||
| 25 | @signaldef buddy-back | |
| 26 | @signalproto | |
| 27 | void (*buddy_back)(struct buddy *buddy); | |
| 28 | @endsignalproto | |
| 29 | @signaldesc | |
| 30 | Emitted when a buddy on your buddy list comes back from being away. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
31 | @param buddy The buddy that came back from being away. |
| 6605 | 32 | @endsignaldef |
| 33 | ||
| 34 | @signaldef buddy-idle | |
| 35 | @signalproto | |
| 36 | void (*buddy_idle)(struct buddy *buddy); | |
| 37 | @endsignalproto | |
| 38 | @signaldesc | |
| 39 | Emitted when a buddy on your buddy list becomes idle. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
40 | @param buddy The buddy that became idle. |
| 6605 | 41 | @endsignaldef |
| 42 | ||
| 43 | @signaldef buddy-unidle | |
| 44 | @signalproto | |
| 45 | void (*buddy_unidle)(struct buddy *buddy); | |
| 46 | @endsignalproto | |
| 47 | @signaldesc | |
| 48 | Emitted when a buddy on your buddy list returns from being idle. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
49 | @param buddy The buddy that returned from being idle. |
| 6605 | 50 | @endsignaldef |
| 51 | ||
|
9111
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
52 | @signaldef buddy-idle-updated |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
53 | @signalproto |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
54 | void (*buddy_idle_updated)(struct buddy *buddy); |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
55 | @endsignalproto |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
56 | @signaldesc |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
57 | Emitted when a buddy's idle time changes. The exceptions are when the |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
58 | buddy goes from being idle to being unidle, or from unidle to idle. |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
59 | @param buddy The buddy whose idle time changed. |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
60 | @endsignaldef |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
61 | |
| 6605 | 62 | @signaldef buddy-signed-on |
| 63 | @signalproto | |
| 64 | void (*buddy_signed_on)(struct buddy *buddy); | |
| 65 | @endsignalproto | |
| 66 | @signaldesc | |
| 67 | Emitted when a buddy on your buddy list signs on. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
68 | @param buddy The buddy that signed on. |
| 6605 | 69 | @endsignaldef |
| 70 | ||
| 71 | @signaldef buddy-signed-off | |
| 72 | @signalproto | |
| 73 | void (*buddy_signed_off)(struct buddy *buddy); | |
| 74 | @endsignalproto | |
| 75 | @signaldesc | |
| 76 | Emitted when a buddy on your buddy list signs off. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
77 | @param buddy The buddy that signed off. |
| 6605 | 78 | @endsignaldef |
| 79 | ||
| 80 | @signaldef update-idle | |
| 81 | @signalproto | |
| 82 | void (*update_idle)(); | |
| 83 | @endsignalproto | |
| 84 | @signaldesc | |
| 85 | Emitted when the buddy list is refreshed and the idle times are updated. | |
| 86 | @endsignaldef | |
| 87 | ||
| 9051 | 88 | @signaldef blist-node-extended-menu |
| 89 | @signalproto | |
| 90 | void (*blist_node_extended_menu)(GaimBlistNode *node, GList **menu) | |
| 91 | @endsignalproto | |
| 92 | @signaldesc | |
| 93 | Emitted when a buddlist menu is being constructed @a menu is a pointer to | |
| 94 | a GList of GaimBlistNodeAction's allowing a plugin to add menu items | |
| 95 | @endsignaldef | |
| 96 | ||
| 6605 | 97 | */ |
| 98 | // vim: syntax=c tw=75 et |
