view doc/sound-signals.dox @ 29642:e81b708a8986

propagate from branch 'im.pidgin.pidgin' (head 7bdc0d34e54e09101ba68ba39703a8fd5081e8eb) to branch 'im.pidgin.cpw.attention_ui' (head a3a3ff8b7620f28f0d050e0edb1794384b43f486)
author Marcus Lundblad <ml@update.uu.se>
date Mon, 27 Oct 2008 23:08:32 +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