view doc/sound-signals.dox @ 26136:d68924f1265f

propagate from branch 'im.pidgin.pidgin' (head 27a5e4c3bf4db89f9d87c37d7043c1f4dc68ed1f) to branch 'im.pidgin.pidgin.vv' (head 2327fc75d25586f742fc4305b4dfc93a581c1e13)
author Mike Ruprecht <maiku@soc.pidgin.im>
date Mon, 19 Jan 2009 10:47:12 +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