Mercurial > pidgin.yaz
annotate doc/sound-signals.dox @ 15439:a415922e2882
merge of '8f5c72b9dbcf628f35e4674469f97b34f9c6fa2c'
and 'e082ba7b9cfaf0fef0531d0fe9b54af7831f75df'
author | Ethan Blanton <elb@pidgin.im> |
---|---|
date | Sun, 28 Jan 2007 01:24:15 +0000 |
parents | b0582839cd6c |
children | 8cf53d7a0887 |
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 |