doc/sound-signals.dox

Tue, 18 Sep 2007 20:30:25 +0000

author
Stu Tomlinson <nosnilmot@pidgin.im>
date
Tue, 18 Sep 2007 20:30:25 +0000
changeset 20384
632684df1936
parent 16257
66f737e6b718
child 20897
2608e9e07913
permissions
-rw-r--r--

Convert buddy notes to plain text before displaying in the tooltip to
avoid invalid pango markup preventing the display of the entire tooltip
text. Fixes #2657

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