doc/sound-signals.dox

   1 /** @page sound-signals Sound Signals
   2
   3  @signals
   4   @signal playing-sound-event
   5  @endsignals
   6
   7  @see sound.h
   8
   9  <hr>
  10
  11  @signaldef playing-sound-event
  12   @signalproto
  13 gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
  14   @endsignalproto
  15   @signaldesc
  16    Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
  17   @param event   The event this sound represents.
  18   @param account The account the sound is being played for.
  19   @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
  20  @endsignaldef
  21
  22  */
  23 // vim: syntax=c.doxygen tw=75 et