Mercurial > pidgin3 / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/libpurple/sound-signals.dox	Sun Oct 13 15:41:22 2013 +0530
@@ -0,0 +1,23 @@
+/** @page sound-signals Sound Signals
+
+ @signals
+  @signal playing-sound-event
+ @endsignals
+
+ @see sound.h
+
+ <hr>
+
+ @signaldef playing-sound-event
+  @signalproto
+gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
+  @endsignalproto
+  @signaldesc
+   Emitted when libpurple 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.doxygen tw=75 et