doc/sound-signals.dox@017077f79a0f (annotated)
doc/sound-signals.dox
Tue, 31 Aug 2010 02:28:05 +0000
- author
- Paul Aurich <darkrain42@pidgin.im>
- date
- Tue, 31 Aug 2010 02:28:05 +0000
- changeset 30740
- 017077f79a0f
- parent 20897
- 2608e9e07913
- permissions
- -rw-r--r--
jabber: Unify "Require TLS" and "Use old-style (port 5223) SSL" settings
| 12292 | 1 | /** @page sound-signals Sound Signals |
| 2 | ||
| 3 | @signals | |
| 4 | @signal playing-sound-event | |
| 5 | @endsignals | |
| 6 | ||
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16257
diff
changeset
|
7 | @see sound.h |
|
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16257
diff
changeset
|
8 | |
| 12292 | 9 | <hr> |
| 10 | ||
| 11 | @signaldef playing-sound-event | |
| 12 | @signalproto | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
12292
diff
changeset
|
13 | gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account); |
| 12292 | 14 | @endsignalproto |
| 15 | @signaldesc | |
| 16257 | 16 | Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE. |
| 12292 | 17 | @param event The event this sound represents. |
| 18 | @param account The account the sound is being played for. | |
| 19 | @return @c TRUE if the sound should not be played, or @c FALSE otherwise. | |
| 20 | @endsignaldef | |
| 21 | ||
| 22 | */ | |
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16257
diff
changeset
|
23 | // vim: syntax=c.doxygen tw=75 et |
