view doc/sound-signals.dox @ 17507:b610b8e0c850

merge of '4538f6c33c0f8ed2d8e1f9124fb52bce0d676e63' and 'c41f4a042c7fd12301b7a3acdf8d766cbb4fc8ea'
author William Ehlhardt <williamehlhardt@gmail.com>
date Thu, 31 May 2007 00:40:23 +0000
parents 1414e0e01dc5
children e0613cf8c493
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <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 tw=75 et