pidgin/gtksound.h

changeset 40509
6748a5ec6644
parent 40508
2ebcb8eb5c01
child 40510
09975c2082c5
equal deleted inserted replaced
40508:2ebcb8eb5c01 40509:6748a5ec6644
1 /* pidgin
2 *
3 * Pidgin is the legal property of its developers, whose names are too numerous
4 * to list here. Please refer to the COPYRIGHT file distributed with this
5 * source distribution.
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
20 */
21
22 #if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
23 # error "only <pidgin.h> may be included directly"
24 #endif
25
26 #ifndef _PIDGINSOUND_H_
27 #define _PIDGINSOUND_H_
28 /**
29 * SECTION:gtksound
30 * @section_id: pidgin-gtksound
31 * @short_description: <filename>gtksound.h</filename>
32 * @title: Sound API
33 */
34
35 #include <purple.h>
36
37 G_BEGIN_DECLS
38
39 /**************************************************************************/
40 /* GTK+ Sound API */
41 /**************************************************************************/
42
43 /**
44 * pidgin_sound_get_event_option:
45 * @event: The event.
46 *
47 * Get the prefs option for an event.
48 *
49 * Returns: The option.
50 */
51 const char *pidgin_sound_get_event_option(PurpleSoundEventID event);
52
53 /**
54 * pidgin_sound_get_event_label:
55 * @event: The event.
56 *
57 * Get the label for an event.
58 *
59 * Returns: The label.
60 */
61 const char *pidgin_sound_get_event_label(PurpleSoundEventID event);
62
63 /**
64 * pidgin_sound_get_ui_ops:
65 *
66 * Gets GTK+ sound UI ops.
67 *
68 * Returns: The UI operations structure.
69 */
70 PurpleSoundUiOps *pidgin_sound_get_ui_ops(void);
71
72 /**
73 * pidgin_sound_get_handle:
74 *
75 * Get the handle for the GTK+ sound system.
76 *
77 * Returns: The handle to the sound system
78 */
79 void *pidgin_sound_get_handle(void);
80
81 /**
82 * pidgin_sound_is_customized:
83 *
84 * Returns true Pidgin is using customized sounds
85 *
86 * Returns: TRUE if non default sounds are used.
87 */
88 gboolean pidgin_sound_is_customized(void);
89
90 G_END_DECLS
91
92 #endif /* _PIDGINSOUND_H_ */

mercurial