doc/sound-signals.dox

Wed, 30 Apr 2008 06:29:16 +0000

author
Evan Schoenberg <evands@pidgin.im>
date
Wed, 30 Apr 2008 06:29:16 +0000
branch
next.minor
changeset 23270
2b7db16e721a
parent 20897
2608e9e07913
permissions
-rw-r--r--

As discussed on the devel list, purple_serv_got_join_chat_failed() and the
"chat-join-failed" signal now accept and pass (respectively) a GHashTable
instead of a string. The GHashTable is the same one which was passed to
serv_join_chat() originally.

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