annotate doc/gtkblist-signals.dox @ 20807:e0613cf8c493

Add some links from signal documentation back to the documentation for the corresponding header. Also, if there are going to be vim modelines with "syntax" settings, they may as well be "c.doxygen" not "c".
author Will Thompson <will.thompson@collabora.co.uk>
date Sun, 07 Oct 2007 18:49:50 +0000
parents 8cf53d7a0887
children d75813811637
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9001
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
1 /** @page gtkblist-signals GtkBlist Signals
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
2
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
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
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
6 @signal gtkblist-created
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
7 @signal drawing-tooltip
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
8 @endsignals
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
9
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
10 @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
11
9001
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
12 <hr>
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
13
12016
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
14 @signaldef gtkblist-hiding
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
15 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12713
diff changeset
16 void (*gtkblist-hiding)(PurpleBuddyList *blist);
12016
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
17 @endsignalproto
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
18 @signaldesc
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
19 Emitted when the buddy list is about to be hidden.
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
20 @param blist The buddy list.
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
21 @endsignaldef
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
22
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
23 @signaldef gtkblist-unhiding
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
24 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12713
diff changeset
25 void (*gtkblist-unhiding)(PurpleBuddyList *blist);
12016
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
26 @endsignalproto
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
27 @signaldesc
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
28 Emitted when the buddy list is about to be unhidden.
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
29 @param blist The buddy list.
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
30 @endsignaldef
24c7fb94d3a3 [gaim-migrate @ 14309]
Daniel Atallah <daniel.atallah@gmail.com>
parents: 10477
diff changeset
31
9001
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
32 @signaldef gtkblist-created
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
33 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12713
diff changeset
34 void (*gtkblist-created)(PurpleBuddyList *blist);
9001
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
35 @endsignalproto
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
36 @signaldesc
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
37 Emitted when the buddy list is created.
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
38 @param blist The buddy list.
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
39 @endsignaldef
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
40
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
41 @signaldef drawing-tooltip
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
42 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12713
diff changeset
43 void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full);
9001
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
44 @endsignalproto
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
45 @signaldesc
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
46 Emitted just before a tooltip is displayed.
10477
5cb55bcad11b [gaim-migrate @ 11764]
Mark Doliner <mark@kingant.net>
parents: 9609
diff changeset
47 @a text is a standard GString, so the plugin can modify the text that
9001
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
48 will be displayed.
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
49 @note
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
50 Make sure to free @a *text before you replace it!
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
51 @param node The blist node for the tooltip.
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
52 @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
53 @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
54 a compact tooltip for a non-priority buddy.
9001
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
55 @endsignaldef
6bf49a1ec075 [gaim-migrate @ 9776]
Luke Schierer <lschiere@pidgin.im>
parents:
diff changeset
56 */
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
57 // vim: syntax=c.doxygen tw=75 et