view doc/sound-signals.dox @ 28766:4e9a36bdda0f

merge of 'a582dd339f019301adca693df4b1a8fb135a1774' and 'e2fb4cc366c55b86f89304bddac780a92ff73394'
author Paul Aurich <paul@darkrain42.org>
date Sun, 06 Dec 2009 19:26:52 +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