view doc/sound-signals.dox @ 25786:bc632f651319

propagate from branch 'im.pidgin.pidgin' (head d09a92cd7ce9896f92599d245e9964da4ac5b2e1) to branch 'im.pidgin.pidgin.next.minor' (head 26d9225c6ebd05488d396cbc713c3567e9280714)
author Richard Laager <rlaager@wiktel.com>
date Thu, 30 Oct 2008 20:03:40 +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