view doc/sound-signals.dox @ 18342:2aad33bb021d

propagate from branch 'im.pidgin.pidgin' (head d08e73765328352fb955bb0b4e908eb39bea7b5d) to branch 'org.maemo.garage.pidgin.smiley-install' (head 3f1b3854a77850131531d1d6f19c44a0b9174107)
author Gabriel Schulhof <nix@go-nix.ca>
date Thu, 28 Jun 2007 17:07:48 +0000
parents 1414e0e01dc5
children e0613cf8c493
line wrap: on
line source

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