Mercurial > pidgin.yaz

annotate doc/sound-signals.dox @ 17167:68f634d5f5f5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head faebb5b94eeb15c49559aa2b3c3ce87c9a38a763) to branch 'org.maemo.garage.pidgin.pidgin.pidgin-create-window' (head 0a8f3caadedcc4862887fa8bd7695aa5ac2dff3e)
author Gabriel Schulhof <nix@go-nix.ca>
date Fri, 18 May 2007 22:32:30 +0000
parents 1414e0e01dc5
children e0613cf8c493
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
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
1414e0e01dc5 More renaming.
Richard Laager <rlaager@wiktel.com>
parents: 16183
diff changeset
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