Mercurial > pidgin
annotate doc/sound-signals.dox @ 19452:eb0fe583bc53
merge of 'cacb6312fda77c93ab3e7557fdea3c2956cc55ad'
and 'f5aeed9a6e0c9cb68e829608dc9d41f7782fe487'
author | Kevin Stange <kevin@simguy.net> |
---|---|
date | Sun, 26 Aug 2007 18:59:59 +0000 |
parents | 1414e0e01dc5 |
children | e0613cf8c493 |
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 |
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
12292
diff
changeset
|
11 gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account); |
12292
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 |
16196 | 14 Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE. |
12292
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 |