view doc/sound-signals.dox @ 26867:4f36ec04181c

merge of '2b7afd5f3a168b013e5d3cd69999ffb6e0ee95a6' and '2c9a1153bc1694e9656752a73526bd6b7461265b'
author Ka-Hing Cheung <khc@hxbc.us>
date Mon, 11 May 2009 01:37:56 +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