Mon, 21 Oct 2013 17:54:13 +0530
Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.
|
36905
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
1 | <?xml version='1.0' encoding="ISO-8859-1"?> |
|
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
|
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
3 | "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ |
|
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
4 | ]> |
|
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
5 | <chapter id="chapter-signals-blist"> |
|
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
6 | <title>Buddy List signals</title> |
| 6605 | 7 | |
|
36905
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
8 | <programlisting> |
| 6605 | 9 | @signals |
| 11935 | 10 | @signal buddy-status-changed |
| 11 | @signal buddy-idle-changed | |
| 6605 | 12 | @signal buddy-signed-on |
| 13 | @signal buddy-signed-off | |
| 14 | @signal update-idle | |
| 9051 | 15 | @signal blist-node-extended-menu |
| 11454 | 16 | @signal buddy-added |
| 17 | @signal buddy-removed | |
|
12148
6d4bb4d9081b
[gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents:
11947
diff
changeset
|
18 | @signal buddy-icon-changed |
| 11454 | 19 | @signal blist-node-aliased |
|
30052
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
20 | @signal buddy-caps-changed |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
21 | @signal ui-caps-changed |
| 6605 | 22 | @endsignals |
| 23 | ||
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
24 | @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
|
25 | |
| 11935 | 26 | @signaldef buddy-status-changed |
| 6605 | 27 | @signalproto |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12148
diff
changeset
|
28 | void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status); |
| 6605 | 29 | @endsignalproto |
| 30 | @signaldesc | |
| 31 | Emitted when a buddy on your buddy list goes away. | |
| 11947 | 32 | @param buddy The buddy whose status changed. |
| 11935 | 33 | @param old_status The status that the buddy just changed from. |
| 34 | @param status The status that the buddy just changed to. | |
| 6605 | 35 | @endsignaldef |
| 36 | ||
| 11935 | 37 | @signaldef buddy-idle-changed |
| 6605 | 38 | @signalproto |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12148
diff
changeset
|
39 | void (*buddy_idle)(PurpleBuddy *buddy, gboolean old_idle, gboolean idle); |
| 6605 | 40 | @endsignalproto |
| 41 | @signaldesc | |
| 42 | Emitted when a buddy on your buddy list becomes idle. | |
| 11947 | 43 | @param buddy The buddy whose idle status changed. |
| 11935 | 44 | @param old_idle Whether the buddy was idle. |
| 45 | @param idle Whether the buddy is currently idle. | |
|
9111
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
46 | @endsignaldef |
|
e5e3fca89af4
[gaim-migrate @ 9888]
Christian Hammond <chipx86@chipx86.com>
parents:
9051
diff
changeset
|
47 | |
| 6605 | 48 | @signaldef buddy-signed-on |
| 49 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12148
diff
changeset
|
50 | void (*buddy_signed_on)(PurpleBuddy *buddy); |
| 6605 | 51 | @endsignalproto |
| 52 | @signaldesc | |
| 53 | Emitted when a buddy on your buddy list signs on. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
54 | @param buddy The buddy that signed on. |
| 6605 | 55 | @endsignaldef |
| 56 | ||
| 57 | @signaldef buddy-signed-off | |
| 58 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12148
diff
changeset
|
59 | void (*buddy_signed_off)(PurpleBuddy *buddy); |
| 6605 | 60 | @endsignalproto |
| 61 | @signaldesc | |
| 62 | Emitted when a buddy on your buddy list signs off. | |
|
6606
1387777368c7
[gaim-migrate @ 7130]
Christian Hammond <chipx86@chipx86.com>
parents:
6605
diff
changeset
|
63 | @param buddy The buddy that signed off. |
| 6605 | 64 | @endsignaldef |
| 65 | ||
| 66 | @signaldef update-idle | |
| 67 | @signalproto | |
| 68 | void (*update_idle)(); | |
| 69 | @endsignalproto | |
| 70 | @signaldesc | |
| 71 | Emitted when the buddy list is refreshed and the idle times are updated. | |
| 72 | @endsignaldef | |
| 73 | ||
| 9051 | 74 | @signaldef blist-node-extended-menu |
| 75 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12148
diff
changeset
|
76 | void (*blist_node_extended_menu)(PurpleBlistNode *node, GList **menu) |
| 9051 | 77 | @endsignalproto |
| 78 | @signaldesc | |
| 79 | 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
|
80 | a GList of PurpleBlistNodeAction's allowing a plugin to add menu items |
| 9051 | 81 | @endsignaldef |
| 82 | ||
|
27023
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
83 | @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
|
84 | @signalproto |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
85 | 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
|
86 | @endsignalproto |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
87 | @signaldesc |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
88 | 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
|
89 | @endsignaldef |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
90 | |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
91 | @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
|
92 | @signalproto |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
93 | 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
|
94 | @endsignalproto |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
95 | @signaldesc |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
96 | 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
|
97 | @endsignaldef |
|
f7d6ee5315c9
Add blist-node-(added|removed) and deprecate buddy-(added|removed). Closes #8309
Paul Aurich <darkrain42@pidgin.im>
parents:
21141
diff
changeset
|
98 | |
| 11454 | 99 | @signaldef buddy-added |
| 100 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12148
diff
changeset
|
101 | void (*buddy_added)(PurpleBuddy *buddy) |
| 11454 | 102 | @endsignalproto |
| 103 | @signaldesc | |
| 104 | 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
|
105 | @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
|
106 | @endsignaldef |
| 11454 | 107 | |
|
21141
569c16841ac9
Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents:
20897
diff
changeset
|
108 | @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
|
109 | @signalproto |
|
569c16841ac9
Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents:
20897
diff
changeset
|
110 | 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
|
111 | @endsignalproto |
|
569c16841ac9
Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents:
20897
diff
changeset
|
112 | @signaldesc |
|
569c16841ac9
Order the signal descriptions the same in the body as in the summary.
Etan Reisner <deryni@pidgin.im>
parents:
20897
diff
changeset
|
113 | 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
|
114 | @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
|
115 | @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
|
116 | |
|
12148
6d4bb4d9081b
[gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents:
11947
diff
changeset
|
117 | @signaldef buddy-icon-changed |
|
6d4bb4d9081b
[gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents:
11947
diff
changeset
|
118 | @signalproto |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12148
diff
changeset
|
119 | void (*buddy_icon_changed)(PurpleBuddy *buddy) |
|
12148
6d4bb4d9081b
[gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents:
11947
diff
changeset
|
120 | @endsignalproto |
|
6d4bb4d9081b
[gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents:
11947
diff
changeset
|
121 | @signaldesc |
|
6d4bb4d9081b
[gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents:
11947
diff
changeset
|
122 | Emitted when a buddy's icon is set. |
|
6d4bb4d9081b
[gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents:
11947
diff
changeset
|
123 | @endsignaldef |
|
6d4bb4d9081b
[gaim-migrate @ 14449]
Richard Laager <rlaager@pidgin.im>
parents:
11947
diff
changeset
|
124 | |
| 11454 | 125 | @signaldef blist-node-aliased |
| 126 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12148
diff
changeset
|
127 | void (*blist_node_aliased)(PurpleBlistNode *node, const char *old_alias) |
| 11454 | 128 | @endsignalproto |
| 129 | @signaldesc | |
| 130 | Emitted when a blist node (buddy, chat, or contact) is aliased. | |
| 131 | @endsignaldef | |
| 132 | ||
|
30052
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
133 | @signaldef buddy-caps-changed |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
134 | @signalproto |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
135 | void (*buddy_caps_changed)(PurpleBuddy *buddy, PurpleMediaCaps newcaps, |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
136 | PurpleMediaCaps oldcaps) |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
137 | @endsignalproto |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
138 | @signaldesc |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
139 | Emitted when updating a buddy's media capabilities. |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
140 | @param buddy The buddy |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
141 | @param newcaps |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
142 | @param oldcaps |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
143 | @endsignaldef |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
144 | |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
145 | @signaldef ui-caps-changed |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
146 | @signalproto |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
147 | void (*ui_caps_changed)(PurpleMediaCaps newcaps, PurpleMediaCaps oldcaps) |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
148 | @endsignalproto |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
149 | @signaldesc |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
150 | Emitted when updating the media capabilities of the UI. |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
151 | @param newcaps |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
152 | @param oldcaps |
|
1efbc2ffc89c
Added signal definitions for the new signals.
Marcus Lundblad <malu@pidgin.im>
parents:
27023
diff
changeset
|
153 | @endsignaldef |
|
36905
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
154 | |
|
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
155 | </programlisting> |
|
d256e7a2ec4c
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
Ankit Vani <a@nevitus.org>
parents:
36900
diff
changeset
|
156 | </chapter> |