doc/sound-signals.dox@402d25ce01da (annotated)
doc/sound-signals.dox
Mon, 08 Jun 2009 02:24:49 +0000
- author
- Elliott Sales de Andrade <qulogic@pidgin.im>
- date
- Mon, 08 Jun 2009 02:24:49 +0000
- changeset 27314
- 402d25ce01da
- parent 20897
- 2608e9e07913
- permissions
- -rw-r--r--
Use the JID for adding a chat/buddy because the name is for descriptive
purpose only, and using it will not fill in the Add Chat dialog correctly.
Because the JID is not visible, the user will not know what to actually put
there instead.
| 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 |
