view doc/sound-signals.dox @ 25773:f47429b5ab52

propagate from branch 'im.pidgin.pidgin' (head 9ba9fc8e618e033ab6a9245be2210194b6364e75) to branch 'org.darkrain42.pidgin.xmpp' (head cf5f217d261ff97cb9aa1bf55e4c2730956824e7)
author Paul Aurich <paul@darkrain42.org>
date Sat, 29 Nov 2008 21:41:55 +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