doc/sound-signals.dox

Mon, 19 Oct 2009 22:56:27 +0000

author
Paul Aurich <darkrain42@pidgin.im>
date
Mon, 19 Oct 2009 22:56:27 +0000
changeset 28704
0c1d6f63740f
parent 20897
2608e9e07913
permissions
-rw-r--r--

When switching the account in the Disco / Room List dialogs, kill the visible
results, as the results are not at all guaranteed to be applicable to the
newly-selected account.

Among other things, this happens when you disconnect an account with the
Disco Browser or Room List dialogs open.

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