view doc/sound-signals.dox @ 20976:216fdae447a9

merge of 'e33c17e58da161b8cffaf13e9d79e9bb4b9ce4ce' and 'e9c14932998e8737c0abb9815f8792ca8219759b'
author Etan Reisner <pidgin@unreliablesource.net>
date Wed, 17 Oct 2007 03:37: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