doc/gtkblist-signals.dox

Wed, 04 Jan 2006 04:19:23 +0000

author
Sadrul Habib Chowdhury <sadrul@pidgin.im>
date
Wed, 04 Jan 2006 04:19:23 +0000
changeset 12713
6f057a6e0516
parent 12291
2af68342099e
child 16244
be35cbf49dfb
permissions
-rw-r--r--

[gaim-migrate @ 15057]
SF Patch #1396249 from Sadrul

"The "drawing-tooltip" signal should carry `full' to the
plugins so the plugins don't add stuff for every buddy
in the contact."

committer: Richard Laager <rlaager@pidgin.im>

9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
1 /** @page gtkblist-signals GtkBlist Signals
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
2
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
3 @signals
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
4 @signal gtkblist-hiding
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
5 @signal gtkblist-unhiding
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
6 @signal gtkblist-created
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
7 @signal drawing-tooltip
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
8 @endsignals
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
9
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
10 <hr>
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
11
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
12 @signaldef gtkblist-hiding
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
13 @signalproto
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
14 void (*gtkblist-hiding)(GaimBuddyList *blist);
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
15 @endsignalproto
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
16 @signaldesc
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
17 Emitted when the buddy list is about to be hidden.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
18 @param blist The buddy list.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
19 @endsignaldef
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
20
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
21 @signaldef gtkblist-unhiding
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
22 @signalproto
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
23 void (*gtkblist-unhiding)(GaimBuddyList *blist);
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
24 @endsignalproto
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
25 @signaldesc
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
26 Emitted when the buddy list is about to be unhidden.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
27 @param blist The buddy list.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
28 @endsignaldef
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
29
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
30 @signaldef gtkblist-created
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
31 @signalproto
9568
84bc2952f1df [gaim-migrate @ 10411]
Tim Ringenbach <marv@pidgin.im>
parents: 9001
diff changeset
32 void (*gtkblist-created)(GaimBuddyList *blist);
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
33 @endsignalproto
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
34 @signaldesc
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
35 Emitted when the buddy list is created.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
36 @param blist The buddy list.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
37 @endsignaldef
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
38
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
39 @signaldef drawing-tooltip
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
40 @signalproto
12713
6f057a6e0516 [gaim-migrate @ 15057]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 12291
diff changeset
41 void (*drawing-tooltip)(GaimBlistNode *node, GString *text, gboolean full);
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
42 @endsignalproto
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
43 @signaldesc
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
44 Emitted just before a tooltip is displayed.
10477
7d0641ba585c [gaim-migrate @ 11764]
Mark Doliner <markdoliner@pidgin.im>
parents: 9609
diff changeset
45 @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
46 will be displayed.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
47 @note
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
48 Make sure to free @a *text before you replace it!
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
49 @param node The blist node for the tooltip.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
50 @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
51 @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
52 a compact tooltip for a non-priority buddy.
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
53 @endsignaldef
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
54 */
12291
2af68342099e [gaim-migrate @ 14595]
Etan Reisner <deryni@pidgin.im>
parents: 12016
diff changeset
55 // vim: syntax=c tw=75 et

mercurial