doc/sound-signals.dox

Wed, 09 Dec 2009 21:50:01 +0000

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Wed, 09 Dec 2009 21:50:01 +0000
branch
cpw.qulogic.msnp16
changeset 29430
6b04fe735f52
parent 20897
2608e9e07913
permissions
-rw-r--r--

Allow receiving a NLN command from ourselves. This will probably need to be
changed so that when we're logging in we replace the other endpoint's
settings instead of saving them (if that's what's happening). Probably
should test this out sometime soon.

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

mercurial