view doc/sound-signals.dox @ 19172:069c036d9b72

propagate from branch 'tmpbranch' (head fd482c25cc81ccebcc993d06cad489169e942c22) to branch 'im.pidgin.soc.2007.finchfeat' (head 627c3377bc204d06f54462d88bd59d01fbb753a1)
author Eric Polino <aluink@pidgin.im>
date Tue, 24 Jul 2007 19:39:58 +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