view doc/sound-signals.dox @ 18948:22838745420a

propagate from branch 'im.pidgin.pidgin' (head 704b8c18f7c29f1fc8bfcf640275d2a9928ed03c) to branch 'im.pidgin.soc.2007.certmgr' (head 66c83d19227970a035a46be54fb419e0d9102d44)
author William Ehlhardt <williamehlhardt@gmail.com>
date Mon, 25 Jun 2007 21:38:40 +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