pidgin/gtksound.h

   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 #ifndef _PIDGINSOUND_H_
  23 #define _PIDGINSOUND_H_
  24 /**
  25  * SECTION:gtksound
  26  * @section_id: pidgin-gtksound
  27  * @short_description: <filename>gtksound.h</filename>
  28  * @title: Sound API
  29  */
  30
  31 #include "sound.h"
  32
  33 G_BEGIN_DECLS
  34
  35 /**************************************************************************/
  36 /* GTK+ Sound API                                                         */
  37 /**************************************************************************/
  38
  39 /**
  40  * pidgin_sound_get_event_option:
  41  * @event: The event.
  42  *
  43  * Get the prefs option for an event.
  44  *
  45  * Returns: The option.
  46  */
  47 const char *pidgin_sound_get_event_option(PurpleSoundEventID event);
  48
  49 /**
  50  * pidgin_sound_get_event_label:
  51  * @event: The event.
  52  *
  53  * Get the label for an event.
  54  *
  55  * Returns: The label.
  56  */
  57 const char *pidgin_sound_get_event_label(PurpleSoundEventID event);
  58
  59 /**
  60  * pidgin_sound_get_ui_ops:
  61  *
  62  * Gets GTK+ sound UI ops.
  63  *
  64  * Returns: The UI operations structure.
  65  */
  66 PurpleSoundUiOps *pidgin_sound_get_ui_ops(void);
  67
  68 /**
  69  * pidgin_sound_get_handle:
  70  *
  71  * Get the handle for the GTK+ sound system.
  72  *
  73  * Returns: The handle to the sound system
  74  */
  75 void *pidgin_sound_get_handle(void);
  76
  77 /**
  78  * pidgin_sound_is_customized:
  79  *
  80  * Returns true Pidgin is using customized sounds
  81  *
  82  * Returns: TRUE if non default sounds are used.
  83  */
  84 gboolean pidgin_sound_is_customized(void);
  85
  86 G_END_DECLS
  87
  88 #endif /* _PIDGINSOUND_H_ */