view doc/sound-signals.dox @ 25660:751df82b78e7

propagate from branch 'im.pidgin.pidgin' (head 23720684a7671144bc56d1b20b6a1a0a22862d73) to branch 'im.pidgin.cpw.darkrain42.xmpp.iq-handlers' (head 3bdb82c347184599c389f7ed65d02c61f2708b89)
author Paul Aurich <paul@darkrain42.org>
date Tue, 10 Feb 2009 06:12:24 +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