doc/sound-signals.dox

Wed, 13 May 2009 20:29:03 +0000

author
Marcus Lundblad <malu@pidgin.im>
date
Wed, 13 May 2009 20:29:03 +0000
changeset 27110
05ca719b901b
parent 20897
2608e9e07913
permissions
-rw-r--r--

Support custom smileys in MUCs (when all participants support BoB and a maximum
of 10 participants are in the chat).
Always announce support for BoB, since disable custom smileys will still turn
off fetching them, and BoB can be used for other purposes further on.

12292
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
1 /** @page sound-signals Sound Signals
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
2
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
3 @signals
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
4 @signal playing-sound-event
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
5 @endsignals
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
6
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16257
diff changeset
7 @see sound.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16257
diff changeset
8
12292
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
9 <hr>
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
10
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
11 @signaldef playing-sound-event
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
12 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12292
diff changeset
13 gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
12292
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
14 @endsignalproto
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
15 @signaldesc
16257
66f737e6b718 More renaming.
Richard Laager <rlaager@pidgin.im>
parents: 16244
diff changeset
16 Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
12292
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
17 @param event The event this sound represents.
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
18 @param account The account the sound is being played for.
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
19 @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
20 @endsignaldef
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
21
1193c8f68b6a [gaim-migrate @ 14596]
Etan Reisner <deryni@pidgin.im>
parents:
diff changeset
22 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16257
diff changeset
23 // vim: syntax=c.doxygen tw=75 et

mercurial