view doc/sound-signals.dox @ 30622:d78a3f06b7a0

merge of '2e4b491ee89464d56b79db045bcef7f63fda6b97' and 'fc7c355ab0d2fb25d82bfd4e3847128276915e28'
author Paul Aurich <paul@darkrain42.org>
date Tue, 15 Jun 2010 22:42:49 +0000
parents e0613cf8c493
children
line wrap: on
line source

/** @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