doc/sound-signals.dox

Wed, 19 Sep 2007 11:39:42 +0000

author
Will Thompson <resiak@pidgin.im>
date
Wed, 19 Sep 2007 11:39:42 +0000
branch
cpw.resiak.disconnectreason
changeset 20442
97e2d532c2ac
parent 16257
66f737e6b718
child 20897
2608e9e07913
permissions
-rw-r--r--

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?

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