Mercurial > pidgin3 / file revision

• file
• latest
• revisions
• annotate
• diff
• comparison
• raw

doc/sound-signals.dox@402d25ce01da

doc/sound-signals.dox

Mon, 08 Jun 2009 02:24:49 +0000

author

Elliott Sales de Andrade <qulogic@pidgin.im>

date

Mon, 08 Jun 2009 02:24:49 +0000

changeset 27314

402d25ce01da

parent 20897

2608e9e07913

permissions

-rw-r--r--

Use the JID for adding a chat/buddy because the name is for descriptive
purpose only, and using it will not fill in the Add Chat dialog correctly.
Because the JID is not visible, the user will not know what to actually put
there instead.

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