comparison finch/gntsound.h @ 32819:2c6510167895 default tip

propagate from branch 'im.pidgin.pidgin.2.x.y' (head 3315c5dfbd0ad16511bdcf865e5b07c02d07df24) to branch 'im.pidgin.pidgin' (head cbd1eda6bcbf0565ae7766396bb8f6f419cb6a9a)
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Sat, 02 Jun 2012 02:30:49 +0000
parents 02a2e8183b1d
children
comparison
equal deleted inserted replaced
32818:01ff09d4a463 32819:2c6510167895
35 35
36 /** 36 /**
37 * Get the name of the active sound profile. 37 * Get the name of the active sound profile.
38 * 38 *
39 * @return The name of the profile 39 * @return The name of the profile
40 *
41 * @since 2.1.0
42 */ 40 */
43 const char *finch_sound_get_active_profile(void); 41 const char *finch_sound_get_active_profile(void);
44 42
45 /** 43 /**
46 * Set the active profile. If the profile doesn't exist, nothing is changed. 44 * Set the active profile. If the profile doesn't exist, nothing is changed.
47 * 45 *
48 * @param name The name of the profile 46 * @param name The name of the profile
49 *
50 * @since 2.1.0
51 */ 47 */
52 void finch_sound_set_active_profile(const char *name); 48 void finch_sound_set_active_profile(const char *name);
53 49
54 /** 50 /**
55 * Get a list of available sound profiles. 51 * Get a list of available sound profiles.
56 * 52 *
57 * @return A list of strings denoting sound profile names. 53 * @return A list of strings denoting sound profile names.
58 * Caller must free the list (but not the data). 54 * Caller must free the list (but not the data).
59 *
60 * @since 2.1.0
61 */ 55 */
62 GList *finch_sound_get_profiles(void); 56 GList *finch_sound_get_profiles(void);
63 57
64 /** 58 /**
65 * Determine whether any sound will be played or not. 59 * Determine whether any sound will be played or not.
66 * 60 *
67 * @return Returns FALSE if preference is set to 'No sound', or if volume is 61 * @return Returns FALSE if preference is set to 'No sound', or if volume is
68 * set to zero. 62 * set to zero.
69 *
70 * @since 2.2.0
71 */ 63 */
72 gboolean finch_sound_is_enabled(void); 64 gboolean finch_sound_is_enabled(void);
73 65
74 /** 66 /**
75 * Gets GNT sound UI ops. 67 * Gets GNT sound UI ops.
76 * 68 *
77 * @return The UI operations structure. 69 * @return The UI operations structure.
78 *
79 * @since 2.1.0
80 */ 70 */
81 PurpleSoundUiOps *finch_sound_get_ui_ops(void); 71 PurpleSoundUiOps *finch_sound_get_ui_ops(void);
82 72
83 /** 73 /**
84 * Show the sound settings dialog. 74 * Show the sound settings dialog.
85 *
86 * @since 2.1.0
87 */ 75 */
88 void finch_sounds_show_all(void); 76 void finch_sounds_show_all(void);
89 77
90 /*@}*/ 78 /*@}*/
91 79