doc/gtkblist-signals.dox

Mon, 08 Jun 2009 02:24:49 +0000

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Mon, 08 Jun 2009 02:24:49 +0000
changeset 27314
402d25ce01da
parent 20897
2608e9e07913
child 29919
2e8615d80b0b
permissions
-rw-r--r--

Use the JID for adding a chat/buddy because the name is for descriptive
purpose only, and using it will not fill in the Add Chat dialog correctly.
Because the JID is not visible, the user will not know what to actually put
there instead.

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
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
10 @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
11
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
12 <hr>
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
13
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
14 @signaldef gtkblist-hiding
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
15 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12713
diff changeset
16 void (*gtkblist-hiding)(PurpleBuddyList *blist);
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
17 @endsignalproto
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
18 @signaldesc
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
19 Emitted when the buddy list is about to be hidden.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
20 @param blist The buddy list.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
21 @endsignaldef
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
22
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
23 @signaldef gtkblist-unhiding
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
24 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12713
diff changeset
25 void (*gtkblist-unhiding)(PurpleBuddyList *blist);
12016
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
26 @endsignalproto
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
27 @signaldesc
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
28 Emitted when the buddy list is about to be unhidden.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
29 @param blist The buddy list.
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
30 @endsignaldef
0517ad5d0196 [gaim-migrate @ 14309]
Casey Harkins <charkins@pidgin.im>
parents: 10477
diff changeset
31
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
32 @signaldef gtkblist-created
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
33 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12713
diff changeset
34 void (*gtkblist-created)(PurpleBuddyList *blist);
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
35 @endsignalproto
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
36 @signaldesc
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
37 Emitted when the buddy list is created.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
38 @param blist The buddy list.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
39 @endsignaldef
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
40
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
41 @signaldef drawing-tooltip
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
42 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12713
diff changeset
43 void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full);
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
44 @endsignalproto
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
45 @signaldesc
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
46 Emitted just before a tooltip is displayed.
10477
7d0641ba585c [gaim-migrate @ 11764]
Mark Doliner <markdoliner@pidgin.im>
parents: 9609
diff changeset
47 @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
48 will be displayed.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
49 @note
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
50 Make sure to free @a *text before you replace it!
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
51 @param node The blist node for the tooltip.
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
52 @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
53 @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
54 a compact tooltip for a non-priority buddy.
9001
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
55 @endsignaldef
835c74e31c33 [gaim-migrate @ 9776]
Ethan Blanton <elb@pidgin.im>
parents:
diff changeset
56 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
57 // vim: syntax=c.doxygen tw=75 et

mercurial