annotate doc/blist-signals.dox @ 17588:91cbd18fee06

svn revision 728 of Psi fixes the avatar namespace issue, so I can remove this workaround.
author Andreas Monitzer <pidgin@monitzer.com>
date Mon, 18 Jun 2007 02:19:17 +0000
parents 8cf53d7a0887
children e0613cf8c493
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /** @page blist-signals Buddy List Signals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
4 @signal buddy-status-changed
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
5 @signal buddy-idle-changed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 @signal buddy-signed-on
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal buddy-signed-off
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 @signal update-idle
9051
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
9 @signal blist-node-extended-menu
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
10 @signal buddy-added
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
11 @signal buddy-removed
12148
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
12 @signal buddy-icon-changed
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
13 @signal blist-node-aliased
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 @endsignals
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 <hr>
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
18 @signaldef buddy-status-changed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
20 void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 Emitted when a buddy on your buddy list goes away.
11947
fc8396a3fd5e [gaim-migrate @ 14238]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11942
diff changeset
24 @param buddy The buddy whose status changed.
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
25 @param old_status The status that the buddy just changed from.
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
26 @param status The status that the buddy just changed to.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
29 @signaldef buddy-idle-changed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
31 void (*buddy_idle)(PurpleBuddy *buddy, gboolean old_idle, gboolean idle);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
34 Emitted when a buddy on your buddy list becomes idle.
11947
fc8396a3fd5e [gaim-migrate @ 14238]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11942
diff changeset
35 @param buddy The buddy whose idle status changed.
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
36 @param old_idle Whether the buddy was idle.
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
37 @param idle Whether the buddy is currently idle.
9111
2583056be3a4 [gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents: 9051
diff changeset
38 @endsignaldef
2583056be3a4 [gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents: 9051
diff changeset
39
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40 @signaldef buddy-signed-on
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
41 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
42 void (*buddy_signed_on)(PurpleBuddy *buddy);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
43 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 Emitted when a buddy on your buddy list signs on.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
46 @param buddy The buddy that signed on.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49 @signaldef buddy-signed-off
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
51 void (*buddy_signed_off)(PurpleBuddy *buddy);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
52 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
53 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
54 Emitted when a buddy on your buddy list signs off.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
55 @param buddy The buddy that signed off.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
56 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
57
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
58 @signaldef update-idle
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
59 @signalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60 void (*update_idle)();
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
62 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 Emitted when the buddy list is refreshed and the idle times are updated.
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
65
9051
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
66 @signaldef blist-node-extended-menu
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
67 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
68 void (*blist_node_extended_menu)(PurpleBlistNode *node, GList **menu)
9051
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
69 @endsignalproto
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
70 @signaldesc
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
71 Emitted when a buddlist menu is being constructed @a menu is a pointer to
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
72 a GList of PurpleBlistNodeAction's allowing a plugin to add menu items
9051
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
73 @endsignaldef
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
74
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
75 @signaldef buddy-added
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
76 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
77 void (*buddy_added)(PurpleBuddy *buddy)
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
78 @endsignalproto
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
79 @signaldesc
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
80 Emitted when a new buddy is added to the buddy list.
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
81 @endsignaldef
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
82
12148
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
83 @signaldef buddy-icon-changed
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
84 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
85 void (*buddy_icon_changed)(PurpleBuddy *buddy)
12148
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
86 @endsignalproto
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
87 @signaldesc
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
88 Emitted when a buddy's icon is set.
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
89 @endsignaldef
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
90
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
91 @signaldef buddy-removed
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
92 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
93 void (*buddy_removed)(PurpleBuddy *buddy)
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
94 @endsignalproto
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
95 @signaldesc
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
96 Emitted when a buddy is removed from the buddy list.
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
97 @endsignaldef
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
98
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
99 @signaldef blist-node-aliased
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
100 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
101 void (*blist_node_aliased)(PurpleBlistNode *node, const char *old_alias)
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
102 @endsignalproto
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
103 @signaldesc
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
104 Emitted when a blist node (buddy, chat, or contact) is aliased.
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
105 @endsignaldef
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
106
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
107 */
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
108 // vim: syntax=c tw=75 et