view doc/sound-signals.dox @ 20114:a465779350aa

Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and PURPLE_REASON_AUTHENTICATION_FAILED, and added PURPLE_REASON_AUTHENTICATION_IMPOSSIBLE. It's not fatal basically because none of the places in prpl-jabber that need it set wants_to_die --- should it be?
author Will Thompson <will.thompson@collabora.co.uk>
date Wed, 19 Sep 2007 11:39:42 +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