view doc/sound-signals.dox @ 29261:24aa608c5388

propagate from branch 'im.pidgin.pidgin' (head e1fd1e27a14e8cc717dc7fb6cb69ff1f10672704) to branch 'im.pidgin.cpw.attention_ui' (head 62e39626febfda000fa13a800bdd0eb9c3e36cbc)
author Marcus Lundblad <ml@update.uu.se>
date Tue, 18 Nov 2008 22:35:08 +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