changeset 12292:b0582839cd6c

[gaim-migrate @ 14596] This file too. committer: Tailor Script <tailor@pidgin.im>
author Etan Reisner <pidgin@unreliablesource.net>
date Fri, 02 Dec 2005 06:44:02 +0000
parents 5bc3d67ceb24
children ac63b000ed42
files doc/sound-signals.dox
diffstat 1 files changed, 21 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/sound-signals.dox	Fri Dec 02 06:44:02 2005 +0000
@@ -0,0 +1,21 @@
+/** @page sound-signals Sound Signals
+
+ @signals
+  @signal playing-sound-event
+ @endsignals
+
+ <hr>
+
+ @signaldef playing-sound-event
+  @signalproto
+gboolean (*playing_sound_event)(GaimSoundEventID event, GaimAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when gaim is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
+  @param event   The event this sound represents.
+  @param account The account the sound is being played for.
+  @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
+ @endsignaldef
+
+ */
+// vim: syntax=c tw=75 et