doc/notify-signals.dox

Sat, 01 Jul 2006 22:33:33 +0000

author
Mark Doliner <markdoliner@pidgin.im>
date
Sat, 01 Jul 2006 22:33:33 +0000
changeset 13965
9a4e261e06dd
parent 12129
314cd0274e6a
child 15327
ec403c2abb8a
permissions
-rw-r--r--

[gaim-migrate @ 16391]
Credit for some Bonjour improvements

12129
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
1 /** @page conversation-signals Notification Signals
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
2
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
3 @signals
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
4 @signal displaying-userinfo
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
5 @endsignals
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
6
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
7 @signaldef displaying-userinfo
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
8 @signalproto
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
9 void (*displaying_userinfo)(GaimAccount *account, const char *who, char **infotext);
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
10 @endsignalproto
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
11 @signaldesc
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
12 Emitted before userinfo is handed to the UI to display.
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
13 @a infotext is a pointer to a string, so a plugin can replace the text that
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
14 will be displayed.
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
15 @note
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
16 Make sure to free @a *infotext before you replace it!
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
17 @param account The account on which the info was obtained.
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
18 @param who The screen name of the user whose info is to be displayed.
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
19 @param infotext A pointer to the userinfo text to be displayed.
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
20 @endsignaldef
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
21
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
22 */
314cd0274e6a [gaim-migrate @ 14429]
Ka-Hing Cheung <khc@pidgin.im>
parents:
diff changeset
23 // vim: syntax=c tw=75 et

mercurial