doc/blist-signals.dox

Mon, 08 Jun 2009 02:24:49 +0000

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Mon, 08 Jun 2009 02:24:49 +0000
changeset 27314
402d25ce01da
parent 27023
f7d6ee5315c9
child 30052
1efbc2ffc89c
permissions
-rw-r--r--

Use the JID for adding a chat/buddy because the name is for descriptive
purpose only, and using it will not fill in the Add Chat dialog correctly.
Because the JID is not visible, the user will not know what to actually put
there instead.

6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /** @page blist-signals Buddy List Signals
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
11935
1d95c7294577 [gaim-migrate @ 14226]
Etan Reisner <deryni@pidgin.im>
parents: 11454
diff changeset
4 @signal buddy-status-changed
1d95c7294577 [gaim-migrate @ 14226]
Etan Reisner <deryni@pidgin.im>
parents: 11454
diff changeset
5 @signal buddy-idle-changed
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 @signal buddy-signed-on
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal buddy-signed-off
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 @signal update-idle
9051
aebb592d4529 [gaim-migrate @ 9827]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 6606
diff changeset
9 @signal blist-node-extended-menu
11454
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
10 @signal buddy-added
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
11 @signal buddy-removed
12148
6d4bb4d9081b [gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents: 11947
diff changeset
12 @signal buddy-icon-changed
11454
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
13 @signal blist-node-aliased
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 @endsignals
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
16 @see blist.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
17
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 <hr>
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19
11935
1d95c7294577 [gaim-migrate @ 14226]
Etan Reisner <deryni@pidgin.im>
parents: 11454
diff changeset
20 @signaldef buddy-status-changed
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
22 void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @signaldesc
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 Emitted when a buddy on your buddy list goes away.
11947
cf1cc9521e7d [gaim-migrate @ 14238]
Etan Reisner <deryni@pidgin.im>
parents: 11942
diff changeset
26 @param buddy The buddy whose status changed.
11935
1d95c7294577 [gaim-migrate @ 14226]
Etan Reisner <deryni@pidgin.im>
parents: 11454
diff changeset
27 @param old_status The status that the buddy just changed from.
1d95c7294577 [gaim-migrate @ 14226]
Etan Reisner <deryni@pidgin.im>
parents: 11454
diff changeset
28 @param status The status that the buddy just changed to.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30
11935
1d95c7294577 [gaim-migrate @ 14226]
Etan Reisner <deryni@pidgin.im>
parents: 11454
diff changeset
31 @signaldef buddy-idle-changed
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
33 void (*buddy_idle)(PurpleBuddy *buddy, gboolean old_idle, gboolean idle);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
34 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 @signaldesc
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 Emitted when a buddy on your buddy list becomes idle.
11947
cf1cc9521e7d [gaim-migrate @ 14238]
Etan Reisner <deryni@pidgin.im>
parents: 11942
diff changeset
37 @param buddy The buddy whose idle status changed.
11935
1d95c7294577 [gaim-migrate @ 14226]
Etan Reisner <deryni@pidgin.im>
parents: 11454
diff changeset
38 @param old_idle Whether the buddy was idle.
1d95c7294577 [gaim-migrate @ 14226]
Etan Reisner <deryni@pidgin.im>
parents: 11454
diff changeset
39 @param idle Whether the buddy is currently idle.
9111
e5e3fca89af4 [gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents: 9051
diff changeset
40 @endsignaldef
e5e3fca89af4 [gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents: 9051
diff changeset
41
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
42 @signaldef buddy-signed-on
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
43 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
44 void (*buddy_signed_on)(PurpleBuddy *buddy);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 @signaldesc
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 Emitted when a buddy on your buddy list signs on.
6606
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
48 @param buddy The buddy that signed on.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
51 @signaldef buddy-signed-off
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
52 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
53 void (*buddy_signed_off)(PurpleBuddy *buddy);
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
54 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
55 @signaldesc
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
56 Emitted when a buddy on your buddy list signs off.
6606
1387777368c7 [gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents: 6605
diff changeset
57 @param buddy The buddy that signed off.
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
58 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
59
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60 @signaldef update-idle
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 @signalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
62 void (*update_idle)();
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 @endsignalproto
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64 @signaldesc
665d3a8e885c [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.
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
66 @endsignaldef
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67
9051
aebb592d4529 [gaim-migrate @ 9827]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 6606
diff changeset
68 @signaldef blist-node-extended-menu
aebb592d4529 [gaim-migrate @ 9827]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 6606
diff changeset
69 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
70 void (*blist_node_extended_menu)(PurpleBlistNode *node, GList **menu)
9051
aebb592d4529 [gaim-migrate @ 9827]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 6606
diff changeset
71 @endsignalproto
aebb592d4529 [gaim-migrate @ 9827]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 6606
diff changeset
72 @signaldesc
aebb592d4529 [gaim-migrate @ 9827]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 6606
diff changeset
73 Emitted when a buddlist menu is being constructed @a menu is a pointer to
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
74 a GList of PurpleBlistNodeAction's allowing a plugin to add menu items
9051
aebb592d4529 [gaim-migrate @ 9827]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 6606
diff changeset
75 @endsignaldef
aebb592d4529 [gaim-migrate @ 9827]
Stu Tomlinson <nosnilmot@pidgin.im>
parents: 6606
diff changeset
76
27023
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
77 @signaldef blist-node-added
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
78 @signalproto
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
79 void (*blist_node_added)(PurpleBlistNode *node)
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
80 @endsignalproto
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
81 @signaldesc
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
82 Emitted when a new blist node is added to the buddy list.
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
83 @endsignaldef
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
84
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
85 @signaldef blist-node-removed
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
86 @signalproto
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
87 void (*blist_node_removed)(PurpleBlistNode *node)
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
88 @endsignalproto
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
89 @signaldesc
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
90 Emitted when a blist node is removed from the buddy list.
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
91 @endsignaldef
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
92
11454
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
93 @signaldef buddy-added
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
94 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
95 void (*buddy_added)(PurpleBuddy *buddy)
11454
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
96 @endsignalproto
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
97 @signaldesc
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
98 Emitted when a new buddy is added to the buddy list.
27023
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
99 @deprecated Use blist-node-added instead.
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
100 @endsignaldef
11454
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
101
21141
569c16841ac9 Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
102 @signaldef buddy-removed
569c16841ac9 Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
103 @signalproto
569c16841ac9 Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
104 void (*buddy_removed)(PurpleBuddy *buddy)
569c16841ac9 Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
105 @endsignalproto
569c16841ac9 Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
106 @signaldesc
569c16841ac9 Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
107 Emitted when a buddy is removed from the buddy list.
27023
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
108 @deprecated Use blist-node-removed instead.
f7d6ee5315c9 Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents: 21141
diff changeset
109 @endsignaldef
21141
569c16841ac9 Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents: 20897
diff changeset
110
12148
6d4bb4d9081b [gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents: 11947
diff changeset
111 @signaldef buddy-icon-changed
6d4bb4d9081b [gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents: 11947
diff changeset
112 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
113 void (*buddy_icon_changed)(PurpleBuddy *buddy)
12148
6d4bb4d9081b [gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents: 11947
diff changeset
114 @endsignalproto
6d4bb4d9081b [gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents: 11947
diff changeset
115 @signaldesc
6d4bb4d9081b [gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents: 11947
diff changeset
116 Emitted when a buddy's icon is set.
6d4bb4d9081b [gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents: 11947
diff changeset
117 @endsignaldef
6d4bb4d9081b [gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents: 11947
diff changeset
118
11454
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
119 @signaldef blist-node-aliased
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
120 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12148
diff changeset
121 void (*blist_node_aliased)(PurpleBlistNode *node, const char *old_alias)
11454
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
122 @endsignalproto
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
123 @signaldesc
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
124 Emitted when a blist node (buddy, chat, or contact) is aliased.
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
125 @endsignaldef
a604c2097a6e [gaim-migrate @ 13693]
Richard Laager <rlaager@pidgin.im>
parents: 9111
diff changeset
126
6605
665d3a8e885c [gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
127 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
128 // vim: syntax=c.doxygen tw=75 et

mercurial