comparison finch/gntsound.h @ 19154:01d574f529e0

One leak fix. Mostly cosmetic changes.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Wed, 11 Jul 2007 17:36:15 +0000
parents 5ff1231993af
children fbecc35c23bb
comparison
equal deleted inserted replaced
19149:5a6f174bf6dd 19154:01d574f529e0
26 #define _GNT_SOUND_H 26 #define _GNT_SOUND_H
27 27
28 #include "sound.h" 28 #include "sound.h"
29 29
30 /**********************************************************************/ 30 /**********************************************************************/
31 /** @name GNT Sound API */ 31 /** @name GNT Sound API */
32 /**********************************************************************/ 32 /**********************************************************************/
33 /*@{*/ 33 /*@{*/
34 34
35 /** 35 /**
36 * Get the prefs option for an event.
37 *
38 * @param event The event.
39 * @return The option.
40 */
41 const char *finch_sound_get_event_option(PurpleSoundEventID event);
42
43 /**
44 * Get the label for an event.
45 *
46 * @param event The event.
47 * @return The label.
48 */
49 const char *finch_sound_get_event_label(PurpleSoundEventID event);
50
51 /*
52 * Get the name of the active sound profile. 36 * Get the name of the active sound profile.
53 * 37 *
54 * @return the name 38 * @return The name of the profile
55 */ 39 */
56 const char *finch_sound_get_active_profile(void); 40 const char *finch_sound_get_active_profile(void);
57 41
58 /** 42 /**
59 * Set the active profile. If the profile doesn't exist, nothing is changed. 43 * Set the active profile. If the profile doesn't exist, nothing is changed.
60 * 44 *
61 * 45 * @param name The name of the profile
62 */ 46 */
63 void finch_sound_set_active_profile(const char *name); 47 void finch_sound_set_active_profile(const char *name);
64 48
65 /** 49 /**
66 * Get a list of available sound profiles. 50 * Get a list of available sound profiles.
67 * 51 *
68 * @return A list of strings denoting sound profile names. Free this list when you're done with it. 52 * @return A list of strings denoting sound profile names.
53 * Caller must free the list (but not the data).
69 */ 54 */
70 GList *finch_sound_get_profiles(void); 55 GList *finch_sound_get_profiles(void);
71 56
72 /** 57 /**
73 * Gets GNT sound UI ops. 58 * Gets GNT sound UI ops.
74 * 59 *
75 * @return The UI operations structure. 60 * @return The UI operations structure.
76 */ 61 */
77 PurpleSoundUiOps *finch_sound_get_ui_ops(void); 62 PurpleSoundUiOps *finch_sound_get_ui_ops(void);
78 63
79 /** 64 /**
80 * Show the sound settings dialog. 65 * Show the sound settings dialog.
81 */ 66 */
82 void finch_sounds_show_all(void); 67 void finch_sounds_show_all(void);
83 68
84 /**
85 * Get the handle for the GNT sound system.
86 *
87 * @return The handle to the sound system
88 */
89 void *finch_sound_get_handle(void);
90
91 /*@}*/ 69 /*@}*/
92 70
93 #endif 71 #endif