Mercurial > pidgin

annotate doc/sound-signals.dox @ 14749:9feddd56517f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[gaim-migrate @ 17506] This icon is better as a default no-icon-set icon. committer: Tailor Script <tailor@pidgin.im>
author Sean Egan <seanegan@gmail.com>
date Wed, 18 Oct 2006 01:21:51 +0000
parents b0582839cd6c
children 8cf53d7a0887
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12292
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
1 /** @page sound-signals Sound Signals
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
2
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
3 @signals
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
4 @signal playing-sound-event
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
5 @endsignals
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
6
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
7 <hr>
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
8
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
9 @signaldef playing-sound-event
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
10 @signalproto
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
11 gboolean (*playing_sound_event)(GaimSoundEventID event, GaimAccount *account);
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
12 @endsignalproto
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
13 @signaldesc
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
14 Emitted when gaim is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
15 @param event The event this sound represents.
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
16 @param account The account the sound is being played for.
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
17 @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
18 @endsignaldef
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
19
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
20 */
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
21 // vim: syntax=c tw=75 et