annotate doc/blist-signals.dox @ 31131:6376fc7a092e

propagate from branch 'im.pidgin.pidgin' (head 8a0b15ca6f7e80f487af0b74bda066a717062d0f) to branch 'im.pidgin.cpw.qulogic.msnp16' (head 985d7e2eada00fd3ff1b4eba6e0d030bdfdff7fb)
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Sat, 06 Feb 2010 05:26:27 +0000
parents 0924698e2362
children e68d6c7990c1
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
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
16 @see blist.h
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
17
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 <hr>
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
20 @signaldef buddy-status-changed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
22 void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 Emitted when a buddy on your buddy list goes away.
11947
fc8396a3fd5e [gaim-migrate @ 14238]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11942
diff changeset
26 @param buddy The buddy whose status changed.
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
27 @param old_status The status that the buddy just changed from.
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
28 @param status The status that the buddy just changed to.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
31 @signaldef buddy-idle-changed
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
33 void (*buddy_idle)(PurpleBuddy *buddy, gboolean old_idle, gboolean idle);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
34 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 Emitted when a buddy on your buddy list becomes idle.
11947
fc8396a3fd5e [gaim-migrate @ 14238]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11942
diff changeset
37 @param buddy The buddy whose idle status changed.
11935
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
38 @param old_idle Whether the buddy was idle.
cb73483c9f63 [gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents: 11454
diff changeset
39 @param idle Whether the buddy is currently idle.
9111
2583056be3a4 [gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents: 9051
diff changeset
40 @endsignaldef
2583056be3a4 [gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents: 9051
diff changeset
41
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
42 @signaldef buddy-signed-on
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
43 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
44 void (*buddy_signed_on)(PurpleBuddy *buddy);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 Emitted when a buddy on your buddy list signs on.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
48 @param buddy The buddy that signed on.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
51 @signaldef buddy-signed-off
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
52 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
53 void (*buddy_signed_off)(PurpleBuddy *buddy);
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
54 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
55 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
56 Emitted when a buddy on your buddy list signs off.
6606
34eaa941ecd6 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
57 @param buddy The buddy that signed off.
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
58 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
59
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60 @signaldef update-idle
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 @signalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
62 void (*update_idle)();
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 @endsignalproto
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64 @signaldesc
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
65 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
66 @endsignaldef
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67
9051
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
68 @signaldef blist-node-extended-menu
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
69 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
70 void (*blist_node_extended_menu)(PurpleBlistNode *node, GList **menu)
9051
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
71 @endsignalproto
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
72 @signaldesc
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
73 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
74 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
75 @endsignaldef
826013efffcb [gaim-migrate @ 9827]
Luke Schierer <lschiere@pidgin.im>
parents: 6606
diff changeset
76
26878
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
77 @signaldef blist-node-added
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
78 @signalproto
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
79 void (*blist_node_added)(PurpleBlistNode *node)
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
80 @endsignalproto
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
81 @signaldesc
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
82 Emitted when a new blist node is added to the buddy list.
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
83 @endsignaldef
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
84
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
85 @signaldef blist-node-removed
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
86 @signalproto
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
87 void (*blist_node_removed)(PurpleBlistNode *node)
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
88 @endsignalproto
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
89 @signaldesc
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
90 Emitted when a blist node is removed from the buddy list.
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
91 @endsignaldef
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
92
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
93 @signaldef buddy-added
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
94 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
95 void (*buddy_added)(PurpleBuddy *buddy)
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
96 @endsignalproto
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
97 @signaldesc
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
98 Emitted when a new buddy is added to the buddy list.
26878
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
99 @deprecated Use blist-node-added instead.
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
100 @endsignaldef
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
101
21065
ff00e91f962e Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
102 @signaldef buddy-removed
ff00e91f962e Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
103 @signalproto
ff00e91f962e Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
104 void (*buddy_removed)(PurpleBuddy *buddy)
ff00e91f962e Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
105 @endsignalproto
ff00e91f962e Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
106 @signaldesc
ff00e91f962e Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
107 Emitted when a buddy is removed from the buddy list.
26878
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
108 @deprecated Use blist-node-removed instead.
0924698e2362 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents: 21065
diff changeset
109 @endsignaldef
21065
ff00e91f962e Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents: 20807
diff changeset
110
12148
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
111 @signaldef buddy-icon-changed
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
112 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
113 void (*buddy_icon_changed)(PurpleBuddy *buddy)
12148
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
114 @endsignalproto
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
115 @signaldesc
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
116 Emitted when a buddy's icon is set.
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
117 @endsignaldef
2c65a3749ce1 [gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents: 11947
diff changeset
118
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
119 @signaldef blist-node-aliased
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
120 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12148
diff changeset
121 void (*blist_node_aliased)(PurpleBlistNode *node, const char *old_alias)
11454
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
122 @endsignalproto
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
123 @signaldesc
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
124 Emitted when a blist node (buddy, chat, or contact) is aliased.
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
125 @endsignaldef
201617d49573 [gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents: 9111
diff changeset
126
6605
943b03bcecf5 [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
127 */
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
128 // vim: syntax=c.doxygen tw=75 et