view doc/sound-signals.dox @ 25379:4e8748f3374f

explicit merge of 'cfb115ff00c406f8011c0d661d33bee60813b27c' and '65a6b2bf1ab03c791a4444120e325ce42d9471f2'
author Richard Laager <rlaager@wiktel.com>
date Fri, 02 Jan 2009 22:23:38 +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