view doc/sound-signals.dox @ 25500:24d035ad12cd

propagate from branch 'im.pidgin.pidgin' (head cf74b964fddd2185233987f6e7743623bf21efb8) to branch 'im.pidgin.pidgin.yaz' (head e611312336fc5f025cfd6ef561ee9318827cae80)
author Yoshiki Yazawa <yaz@honeyplanet.jp>
date Thu, 07 Jun 2007 07:32:06 +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