doc/reference/pidgin/signals_gtkblist.xml

branch
soc.2013.gobjectification.plugins
changeset 36905
d256e7a2ec4c
parent 36900
423fbe5e5289
child 36915
13cf9f35c2aa
equal deleted inserted replaced
36904:9708227bcb8e 36905:d256e7a2ec4c
1 <?xml version='1.0' encoding="ISO-8859-1"?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 ]>
5 <chapter id="chapter-signals-gtkblist">
6 <title>Buddy List signals</title>
7
8 <programlisting>
9 @signals
10 @signal gtkblist-hiding
11 @signal gtkblist-unhiding
12 @signal gtkblist-created
13 @signal drawing-tooltip
14 @signal drawing-buddy
15 @endsignals
16
17 @see gtkblist.h
18
19 @signaldef gtkblist-hiding
20 @signalproto
21 void (*gtkblist-hiding)(PurpleBuddyList *blist);
22 @endsignalproto
23 @signaldesc
24 Emitted when the buddy list is about to be hidden.
25 @param blist The buddy list.
26 @endsignaldef
27
28 @signaldef gtkblist-unhiding
29 @signalproto
30 void (*gtkblist-unhiding)(PurpleBuddyList *blist);
31 @endsignalproto
32 @signaldesc
33 Emitted when the buddy list is about to be unhidden.
34 @param blist The buddy list.
35 @endsignaldef
36
37 @signaldef gtkblist-created
38 @signalproto
39 void (*gtkblist-created)(PurpleBuddyList *blist);
40 @endsignalproto
41 @signaldesc
42 Emitted when the buddy list is created.
43 @param blist The buddy list.
44 @endsignaldef
45
46 @signaldef drawing-tooltip
47 @signalproto
48 void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full);
49 @endsignalproto
50 @signaldesc
51 Emitted just before a tooltip is displayed.
52 @a text is a standard GString, so the plugin can modify the text that
53 will be displayed.
54 @note
55 Make sure to free @a *text before you replace it!
56 @param node The blist node for the tooltip.
57 @param text A pointer to the text that will be displayed.
58 @param full Whether we're doing a full tooltip for the priority buddy or
59 a compact tooltip for a non-priority buddy.
60 @endsignaldef
61
62 @signaldef drawing-buddy
63 @signalproto
64 char *(*drawing-buddy)(PurpleBuddy *buddy);
65 @endsignalproto
66 @signaldesc
67 Emitted to allow plugins to handle markup within a buddy's name or to
68 override the default of no formatting for names shown in the buddy list.
69 @param buddy A pointer to the PurpleBuddy that will be displayed.
70 @return The text to display (must be allocated), or @c NULL if no
71 changes to the default behavior are desired.
72 @endsignaldef
73
74 </programlisting>
75 </chapter>

mercurial