Mercurial > pidgin
annotate doc/blist-signals.dox @ 29920:a4662fd44a7e
gg: Fix 05793e8aa in a way that is upstream-able
author | Paul Aurich <paul@darkrain42.org> |
---|---|
date | Thu, 13 May 2010 02:58:31 +0000 |
parents | e68d6c7990c1 |
children | 02a2e8183b1d |
rev | line source |
---|---|
6605 | 1 /** @page blist-signals Buddy List Signals |
2 | |
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 | 6 @signal buddy-signed-on |
7 @signal buddy-signed-off | |
8 @signal update-idle | |
9051 | 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 |
29768
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
14 @signal buddy-caps-changed |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
15 @signal ui-caps-changed |
6605 | 16 @endsignals |
17 | |
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
|
18 @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
|
19 |
6605 | 20 <hr> |
21 | |
11935
cb73483c9f63
[gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents:
11454
diff
changeset
|
22 @signaldef buddy-status-changed |
6605 | 23 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12148
diff
changeset
|
24 void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status); |
6605 | 25 @endsignalproto |
26 @signaldesc | |
27 Emitted when a buddy on your buddy list goes away. | |
11947
fc8396a3fd5e
[gaim-migrate @ 14238]
Etan Reisner <pidgin@unreliablesource.net>
parents:
11942
diff
changeset
|
28 @param buddy The buddy whose status changed. |
11935
cb73483c9f63
[gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents:
11454
diff
changeset
|
29 @param old_status The status that the buddy just changed from. |
cb73483c9f63
[gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents:
11454
diff
changeset
|
30 @param status The status that the buddy just changed to. |
6605 | 31 @endsignaldef |
32 | |
11935
cb73483c9f63
[gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents:
11454
diff
changeset
|
33 @signaldef buddy-idle-changed |
6605 | 34 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12148
diff
changeset
|
35 void (*buddy_idle)(PurpleBuddy *buddy, gboolean old_idle, gboolean idle); |
6605 | 36 @endsignalproto |
37 @signaldesc | |
38 Emitted when a buddy on your buddy list becomes idle. | |
11947
fc8396a3fd5e
[gaim-migrate @ 14238]
Etan Reisner <pidgin@unreliablesource.net>
parents:
11942
diff
changeset
|
39 @param buddy The buddy whose idle status changed. |
11935
cb73483c9f63
[gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents:
11454
diff
changeset
|
40 @param old_idle Whether the buddy was idle. |
cb73483c9f63
[gaim-migrate @ 14226]
Etan Reisner <pidgin@unreliablesource.net>
parents:
11454
diff
changeset
|
41 @param idle Whether the buddy is currently idle. |
9111
2583056be3a4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
42 @endsignaldef |
2583056be3a4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
43 |
6605 | 44 @signaldef buddy-signed-on |
45 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12148
diff
changeset
|
46 void (*buddy_signed_on)(PurpleBuddy *buddy); |
6605 | 47 @endsignalproto |
48 @signaldesc | |
49 Emitted when a buddy on your buddy list signs on. | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
50 @param buddy The buddy that signed on. |
6605 | 51 @endsignaldef |
52 | |
53 @signaldef buddy-signed-off | |
54 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12148
diff
changeset
|
55 void (*buddy_signed_off)(PurpleBuddy *buddy); |
6605 | 56 @endsignalproto |
57 @signaldesc | |
58 Emitted when a buddy on your buddy list signs off. | |
6606
34eaa941ecd6
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
59 @param buddy The buddy that signed off. |
6605 | 60 @endsignaldef |
61 | |
62 @signaldef update-idle | |
63 @signalproto | |
64 void (*update_idle)(); | |
65 @endsignalproto | |
66 @signaldesc | |
67 Emitted when the buddy list is refreshed and the idle times are updated. | |
68 @endsignaldef | |
69 | |
9051 | 70 @signaldef blist-node-extended-menu |
71 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12148
diff
changeset
|
72 void (*blist_node_extended_menu)(PurpleBlistNode *node, GList **menu) |
9051 | 73 @endsignalproto |
74 @signaldesc | |
75 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
|
76 a GList of PurpleBlistNodeAction's allowing a plugin to add menu items |
9051 | 77 @endsignaldef |
78 | |
26796
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
79 @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
|
80 @signalproto |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
81 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
|
82 @endsignalproto |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
83 @signaldesc |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
84 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
|
85 @endsignaldef |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
86 |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
87 @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
|
88 @signalproto |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
89 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
|
90 @endsignalproto |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
91 @signaldesc |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
92 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
|
93 @endsignaldef |
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
94 |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
95 @signaldef buddy-added |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
96 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12148
diff
changeset
|
97 void (*buddy_added)(PurpleBuddy *buddy) |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
98 @endsignalproto |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
99 @signaldesc |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
100 Emitted when a new buddy is added to the buddy list. |
26796
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
101 @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
|
102 @endsignaldef |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
103 |
21065
ff00e91f962e
Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
104 @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
|
105 @signalproto |
ff00e91f962e
Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
106 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
|
107 @endsignalproto |
ff00e91f962e
Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
108 @signaldesc |
ff00e91f962e
Order the signal descriptions the same in the body as in the summary.
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
109 Emitted when a buddy is removed from the buddy list. |
26796
0924698e2362
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <paul@darkrain42.org>
parents:
21065
diff
changeset
|
110 @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
|
111 @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
|
112 |
12148
2c65a3749ce1
[gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents:
11947
diff
changeset
|
113 @signaldef buddy-icon-changed |
2c65a3749ce1
[gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents:
11947
diff
changeset
|
114 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12148
diff
changeset
|
115 void (*buddy_icon_changed)(PurpleBuddy *buddy) |
12148
2c65a3749ce1
[gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents:
11947
diff
changeset
|
116 @endsignalproto |
2c65a3749ce1
[gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents:
11947
diff
changeset
|
117 @signaldesc |
2c65a3749ce1
[gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents:
11947
diff
changeset
|
118 Emitted when a buddy's icon is set. |
2c65a3749ce1
[gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents:
11947
diff
changeset
|
119 @endsignaldef |
2c65a3749ce1
[gaim-migrate @ 14449]
Richard Laager <rlaager@wiktel.com>
parents:
11947
diff
changeset
|
120 |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
121 @signaldef blist-node-aliased |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
122 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12148
diff
changeset
|
123 void (*blist_node_aliased)(PurpleBlistNode *node, const char *old_alias) |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
124 @endsignalproto |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
125 @signaldesc |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
126 Emitted when a blist node (buddy, chat, or contact) is aliased. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
127 @endsignaldef |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
9111
diff
changeset
|
128 |
29768
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
129 @signaldef buddy-caps-changed |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
130 @signalproto |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
131 void (*buddy_caps_changed)(PurpleBuddy *buddy, PurpleMediaCaps newcaps, |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
132 PurpleMediaCaps oldcaps) |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
133 @endsignalproto |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
134 @signaldesc |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
135 Emitted when updating a buddy's media capabilities. |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
136 @param buddy The buddy |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
137 @param newcaps |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
138 @param oldcaps |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
139 @since 2.7.0 |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
140 @endsignaldef |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
141 |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
142 @signaldef ui-caps-changed |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
143 @signalproto |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
144 void (*ui_caps_changed)(PurpleMediaCaps newcaps, PurpleMediaCaps oldcaps) |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
145 @endsignalproto |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
146 @signaldesc |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
147 Emitted when updating the media capabilities of the UI. |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
148 @param newcaps |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
149 @param oldcaps |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
150 @since 2.7.0 |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
151 @endsignaldef |
e68d6c7990c1
Added signal definitions for the new signals.
Marcus Lundblad <ml@update.uu.se>
parents:
26796
diff
changeset
|
152 |
6605 | 153 */ |
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
|
154 // vim: syntax=c.doxygen tw=75 et |