view doc/sound-signals.dox @ 23390:f0a88845f517

propagate from branch 'im.pidgin.pidgin.2.4.3' (head e09d33c61a6e5a59bfc3a52a4370aadf0a90f254) to branch 'im.pidgin.pidgin' (head 82e0fb6843fe710da3b85966d158b57c161e7c73)
author Richard Laager <rlaager@wiktel.com>
date Thu, 26 Jun 2008 09:14:42 +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