view doc/sound-signals.dox @ 13895:8f910263b4bb

[gaim-migrate @ 16380] Merge SVN revision #16379 from v2_0_0 to trunk Original commit message (by LSchiere): iwkse in #gaim brought it to my attention that the example code in the C Plugin Howto won't compile. It won't compile because GAIM_WEBSITE is defined in internal.h, which we don't want plugin authors including, and which isn't included in the sample code. I decided it would be a good thing if the example code compiled, so I changed it. committer: Tailor Script <[e-mail]>

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(GaimSoundEventID event, GaimAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when gaim 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