view doc/sound-signals.dox @ 24604:918738a0bba4

propagate from branch 'im.pidgin.pidgin' (head be9df40b197dab92a74c4bf346f64e538f7f99e5) to branch 'im.pidgin.pidgin.openq' (head d2e4cd570e8e3995be990ee8ddf4fdfb8ce6226c)
author SHiNE CsyFeK <csyfek@gmail.com>
date Sat, 06 Dec 2008 13:30:06 +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