view doc/sound-signals.dox @ 18709:7d0dc92fd68d

merge of '9ec1d6311bc02e1a3ea896058870df504fd94178' and 'fb510ca2d33eb269ce13fc8d4de2c3c5bb5f3253'
author Ka-Hing Cheung <khc@hxbc.us>
date Sat, 28 Jul 2007 20:47:11 +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