view doc/sound-signals.dox @ 28332:35f3a79045a6

propagate from branch 'im.pidgin.pidgin' (head f2a545adb2d67a5ba3dce2abedf68c392cc815e1) to branch 'im.pidgin.cpw.darkrain42.2.6.1' (head 3100186c018974c8e9a25d886213b3317320c5c7)
author Paul Aurich <paul@darkrain42.org>
date Wed, 05 Aug 2009 01:34:35 +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