Mercurial > pidgin.yaz

annotate doc/sound-signals.dox @ 25773:f47429b5ab52

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 9ba9fc8e618e033ab6a9245be2210194b6364e75) to branch 'org.darkrain42.pidgin.xmpp' (head cf5f217d261ff97cb9aa1bf55e4c2730956824e7)
author Paul Aurich <paul@darkrain42.org>
date Sat, 29 Nov 2008 21:41:55 +0000
parents e0613cf8c493
children
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
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16196
diff changeset
7 @see sound.h
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16196
diff changeset
8
12292
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
9 <hr>
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
10
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
11 @signaldef playing-sound-event
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
12 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 12292
diff changeset
13 gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
12292
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
14 @endsignalproto
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
15 @signaldesc
16196
1414e0e01dc5 More renaming.
Richard Laager <rlaager@wiktel.com>
parents: 16183
diff changeset
16 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
17 @param event The event this sound represents.
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
18 @param account The account the sound is being played for.
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
19 @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
20 @endsignaldef
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
21
b0582839cd6c [gaim-migrate @ 14596]
Etan Reisner <pidgin@unreliablesource.net>
parents:
diff changeset
22 */
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16196
diff changeset
23 // vim: syntax=c.doxygen tw=75 et