doc/reference/pidgin/signals_gtkblist.xml

Sun, 20 Oct 2013 15:11:49 +0530

author
Ankit Vani <a@nevitus.org>
date
Sun, 20 Oct 2013 15:11:49 +0530
branch
soc.2013.gobjectification.plugins
changeset 36905
d256e7a2ec4c
parent 36900
doc/reference/pidgin/gtkblist-signals.dox@423fbe5e5289
child 36915
13cf9f35c2aa
permissions
-rw-r--r--

Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
The contents of the xml files mostly still need to be refactored.

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-gtkblist">
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>
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
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>
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
9 @signals
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
10 @signal gtkblist-hiding
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
11 @signal gtkblist-unhiding
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
12 @signal gtkblist-created
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
13 @signal drawing-tooltip
29919
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
14 @signal drawing-buddy
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
15 @endsignals
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
16
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
17 @see gtkblist.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
18
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
19 @signaldef gtkblist-hiding
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
20 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12713
diff changeset
21 void (*gtkblist-hiding)(PurpleBuddyList *blist);
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
22 @endsignalproto
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
23 @signaldesc
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
24 Emitted when the buddy list is about to be hidden.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
25 @param blist The buddy list.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
26 @endsignaldef
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
27
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
28 @signaldef gtkblist-unhiding
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
29 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12713
diff changeset
30 void (*gtkblist-unhiding)(PurpleBuddyList *blist);
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
31 @endsignalproto
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
32 @signaldesc
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
33 Emitted when the buddy list is about to be unhidden.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
34 @param blist The buddy list.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
35 @endsignaldef
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
36
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
37 @signaldef gtkblist-created
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
38 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12713
diff changeset
39 void (*gtkblist-created)(PurpleBuddyList *blist);
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
40 @endsignalproto
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
41 @signaldesc
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
42 Emitted when the buddy list is created.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
43 @param blist The buddy list.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
44 @endsignaldef
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
45
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
46 @signaldef drawing-tooltip
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
47 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12713
diff changeset
48 void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full);
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
49 @endsignalproto
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
50 @signaldesc
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
51 Emitted just before a tooltip is displayed.
10477
7d0641ba585c [gaim-migrate @ 11764]
Mark Doliner <markdoliner@pidgin.im>
parents: 9609
diff changeset
52 @a text is a standard GString, so the plugin can modify the text that
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
53 will be displayed.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
54 @note
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
55 Make sure to free @a *text before you replace it!
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
56 @param node The blist node for the tooltip.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
57 @param text A pointer to the text that will be displayed.
12713
6f057a6e0516 [gaim-migrate @ 15057]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12291
diff changeset
58 @param full Whether we're doing a full tooltip for the priority buddy or
6f057a6e0516 [gaim-migrate @ 15057]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12291
diff changeset
59 a compact tooltip for a non-priority buddy.
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
60 @endsignaldef
29919
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
61
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
62 @signaldef drawing-buddy
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
63 @signalproto
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
64 char *(*drawing-buddy)(PurpleBuddy *buddy);
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
65 @endsignalproto
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
66 @signaldesc
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
67 Emitted to allow plugins to handle markup within a buddy's name or to
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
68 override the default of no formatting for names shown in the buddy list.
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
69 @param buddy A pointer to the PurpleBuddy that will be displayed.
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
70 @return The text to display (must be allocated), or @c NULL if no
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
71 changes to the default behavior are desired.
2e8615d80b0b Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 20897
diff changeset
72 @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
73
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
74 </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
75 </chapter>

mercurial