libpurple/sound-theme.h

   1 /* purple
   2  *
   3  * Purple 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 PURPLE_SOUND_THEME_H
  23 #define PURPLE_SOUND_THEME_H
  24 /**
  25  * SECTION:sound-theme
  26  * @section_id: libpurple-sound-theme
  27  * @short_description: <filename>sound-theme.h</filename>
  28  * @title: Sound Theme Class
  29  */
  30
  31 #include <glib.h>
  32 #include <glib-object.h>
  33 #include "theme.h"
  34 #include "sound.h"
  35
  36 #define PURPLE_TYPE_SOUND_THEME  purple_sound_theme_get_type()
  37
  38 /**************************************************************************/
  39 /* Purple Sound Theme API                                                 */
  40 /**************************************************************************/
  41 G_BEGIN_DECLS
  42
  43 /**
  44  * purple_sound_theme_get_type:
  45  *
  46  * Returns: The #GType for a sound theme.
  47  */
  48 G_DECLARE_FINAL_TYPE(PurpleSoundTheme, purple_sound_theme, PURPLE, SOUND_THEME,
  49                 PurpleTheme)
  50
  51 /**
  52  * purple_sound_theme_get_file:
  53  * @theme: The theme.
  54  * @event: The purple sound event to look up.
  55  *
  56  * Returns a copy of the filename for the sound event.
  57  *
  58  * Returns: The filename of the sound event.
  59  */
  60 const gchar *purple_sound_theme_get_file(PurpleSoundTheme *theme,
  61                 const gchar *event);
  62
  63 /**
  64  * purple_sound_theme_get_file_full:
  65  * @theme: The theme.
  66  * @event: The purple sound event to look up
  67  *
  68  * Returns a copy of the directory and filename for the sound event
  69  *
  70  * Returns: The directory + '/' + filename of the sound event.  This is
  71  *          a newly allocated string that should be freed with g_free.
  72  */
  73 gchar *purple_sound_theme_get_file_full(PurpleSoundTheme *theme,
  74                 const gchar *event);
  75
  76 /**
  77  * purple_sound_theme_set_file:
  78  * @theme:    The theme.
  79  * @event:    the purple sound event to look up
  80  * @filename: the name of the file to be used for the event
  81  *
  82  * Sets the filename for a given sound event
  83  */
  84 void purple_sound_theme_set_file(PurpleSoundTheme *theme,
  85                 const gchar *event,
  86                 const gchar *filename);
  87
  88 G_END_DECLS
  89
  90 #endif /* PURPLE_SOUND_THEME_H */