Mercurial > pidgin

view doc/sound-signals.dox @ 29447:c203ceb5bd9a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 6729d3dea8df2203383212a82eddd4697ea70ee9) to branch 'im.pidgin.cpw.rekkanoryo.icqxstatus' (head 0dd11b78b526e2c42337a6749d942bb0a93fe958)
author Richard Laager <rlaager@wiktel.com>
date Tue, 25 Nov 2008 17:24: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