Mercurial > pidgin.yaz
annotate doc/gtkblist-signals.dox @ 31699:a3bfd9439d37
merge of '974d79cf8eb22b7138c9a3d7313e89585fd8b443'
and 'a657534f694305a613db4946ca8ea9ab4c8f1c1d'
author | Evan Schoenberg <evan.s@dreskin.net> |
---|---|
date | Mon, 21 Feb 2011 22:56:48 +0000 |
parents | d75813811637 |
children |
rev | line source |
---|---|
9001 | 1 /** @page gtkblist-signals GtkBlist Signals |
2 | |
3 @signals | |
12016
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
4 @signal gtkblist-hiding |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
5 @signal gtkblist-unhiding |
9001 | 6 @signal gtkblist-created |
7 @signal drawing-tooltip | |
30038
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
8 @signal drawing-buddy |
9001 | 9 @endsignals |
10 | |
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
|
11 @see gtkblist.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
|
12 |
9001 | 13 <hr> |
14 | |
12016
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
15 @signaldef gtkblist-hiding |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
16 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12713
diff
changeset
|
17 void (*gtkblist-hiding)(PurpleBuddyList *blist); |
12016
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
18 @endsignalproto |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
19 @signaldesc |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
20 Emitted when the buddy list is about to be hidden. |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
21 @param blist The buddy list. |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
22 @endsignaldef |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
23 |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
24 @signaldef gtkblist-unhiding |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
25 @signalproto |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12713
diff
changeset
|
26 void (*gtkblist-unhiding)(PurpleBuddyList *blist); |
12016
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
27 @endsignalproto |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
28 @signaldesc |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
29 Emitted when the buddy list is about to be unhidden. |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
30 @param blist The buddy list. |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
31 @endsignaldef |
24c7fb94d3a3
[gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
10477
diff
changeset
|
32 |
9001 | 33 @signaldef gtkblist-created |
34 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12713
diff
changeset
|
35 void (*gtkblist-created)(PurpleBuddyList *blist); |
9001 | 36 @endsignalproto |
37 @signaldesc | |
38 Emitted when the buddy list is created. | |
39 @param blist The buddy list. | |
40 @endsignaldef | |
41 | |
42 @signaldef drawing-tooltip | |
43 @signalproto | |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12713
diff
changeset
|
44 void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full); |
9001 | 45 @endsignalproto |
46 @signaldesc | |
47 Emitted just before a tooltip is displayed. | |
10477 | 48 @a text is a standard GString, so the plugin can modify the text that |
9001 | 49 will be displayed. |
50 @note | |
51 Make sure to free @a *text before you replace it! | |
52 @param node The blist node for the tooltip. | |
53 @param text A pointer to the text that will be displayed. | |
12713
d7043c3c793d
[gaim-migrate @ 15057]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
54 @param full Whether we're doing a full tooltip for the priority buddy or |
d7043c3c793d
[gaim-migrate @ 15057]
Richard Laager <rlaager@wiktel.com>
parents:
12291
diff
changeset
|
55 a compact tooltip for a non-priority buddy. |
9001 | 56 @endsignaldef |
30038
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
57 |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
58 @signaldef drawing-buddy |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
59 @signalproto |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
60 char *(*drawing-buddy)(PurpleBuddy *buddy); |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
61 @endsignalproto |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
62 @signaldesc |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
63 Emitted to allow plugins to handle markup within a buddy's name or to |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
64 override the default of no formatting for names shown in the buddy list. |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
65 @param buddy A pointer to the PurpleBuddy that will be displayed. |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
66 @return The text to display (must be allocated), or @c NULL if no |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
67 changes to the default behavior are desired. |
d75813811637
Add a new signal, drawing-buddy, to allow plugins to handle markup in buddy
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
20807
diff
changeset
|
68 @endsignaldef |
9001 | 69 */ |
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
|
70 // vim: syntax=c.doxygen tw=75 et |