pidgin/gtksound.h

   1 /**
   2  * @file gtksound.h GTK+ Sound API
   3  * @ingroup pidgin
   4  */
   5
   6 /* pidgin
   7  *
   8  * Pidgin is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26 #ifndef _PIDGINSOUND_H_
  27 #define _PIDGINSOUND_H_
  28
  29 #include "sound.h"
  30
  31 /**************************************************************************/
  32 /** @name GTK+ Sound API                                                  */
  33 /**************************************************************************/
  34 /*@{*/
  35
  36 /**
  37  * Get the prefs option for an event.
  38  *
  39  * @param event The event.
  40  * @return The option.
  41  */
  42 const char *pidgin_sound_get_event_option(PurpleSoundEventID event);
  43
  44 /**
  45  * Get the label for an event.
  46  *
  47  * @param event The event.
  48  * @return The label.
  49  */
  50 const char *pidgin_sound_get_event_label(PurpleSoundEventID event);
  51
  52 /**
  53  * Gets GTK+ sound UI ops.
  54  *
  55  * @return The UI operations structure.
  56  */
  57 PurpleSoundUiOps *pidgin_sound_get_ui_ops(void);
  58
  59 /**
  60  * Get the handle for the GTK+ sound system.
  61  *
  62  * @return The handle to the sound system
  63  */
  64 void *pidgin_sound_get_handle(void);
  65
  66 /**
  67  * Returns true Pidgin is using customized sounds
  68  *
  69  * @return TRUE if non default sounds are used.
  70  *
  71  * @since 2.6.0
  72  */
  73 gboolean pidgin_sound_is_customized(void);
  74
  75 /*@}*/
  76
  77 #endif /* _PIDGINSOUND_H_ */