view doc/sound-signals.dox @ 29452:414886d7a51c

propagate from branch 'im.pidgin.pidgin' (head d6650bbce66004cf205e9f60ef96626783db72e8) to branch 'im.pidgin.cpw.rekkanoryo.icqxstatus' (head 4491e1af4a9262cd67501541c84475c417386ced)
author Richard Laager <rlaager@wiktel.com>
date Wed, 26 Nov 2008 22:14:34 +0000
parents e0613cf8c493
children
line wrap: on
line source

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