Mercurial > pidgin

view doc/sound-signals.dox @ 17958:58c790b37e03

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add account option to send emoticons, defaulting to off since can't currently parse the emoticon code we send (although the official client can, and the emoticon code from the official client can be parsed).
author Jeffrey Connelly <jaconnel@calpoly.edu>
date Fri, 20 Jul 2007 06:06:52 +0000
parents 1414e0e01dc5
children e0613cf8c493
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <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 tw=75 et