view doc/sound-signals.dox @ 26564:6559bf971fcd

merge of '79565c78f0c63b6c8f1b52e57e6e928780ce4f65' and 'a1c902f30c51b755e7c047ab91f9dae471e8d007'
author Paul Aurich <paul@darkrain42.org>
date Sun, 12 Apr 2009 23:47:43 +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