view doc/sound-signals.dox @ 26919:a6a4b440e5ae

merge of '53630753bb021f7391e8ad30abd709f73fe47c3d' and '90901b2c41b0b1a7856d9fb15fb2eb3b67383423'
author Paul Aurich <paul@darkrain42.org>
date Wed, 20 May 2009 00:39:12 +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