view doc/sound-signals.dox @ 24233:55c7c41ce84c

merge of '77f42c8f25c38b4f966158a64ab3be36f00e0aa8' and 'e8631a127deaf18b86db54656bab3e03cdf6e083'
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Mon, 13 Oct 2008 18:54:37 +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