doc/sound-signals.dox

Mon, 01 Oct 2007 17:44:04 +0000

author
Luke Schierer <lschiere@pidgin.im>
date
Mon, 01 Oct 2007 17:44:04 +0000
branch
release-2.2.1
changeset 20408
97e945cef795
parent 16257
66f737e6b718
child 20897
2608e9e07913
permissions
-rw-r--r--

merge of '392db9c2383dd6a8931565b8451179220d6cbbfc'
and '88c21e50426d7f139ecfdf059ebd108cdaa2d069'

/** @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

mercurial