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 Abstact Class
  29  */
  30
  31 #include <glib.h>
  32 #include <glib-object.h>
  33 #include "theme.h"
  34 #include "sound.h"
  35
  36 typedef struct _PurpleSoundTheme        PurpleSoundTheme;
  37 typedef struct _PurpleSoundThemeClass   PurpleSoundThemeClass;
  38
  39 #define PURPLE_TYPE_SOUND_THEME             (purple_sound_theme_get_type())
  40 #define PURPLE_SOUND_THEME(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_SOUND_THEME, PurpleSoundTheme))
  41 #define PURPLE_SOUND_THEME_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_SOUND_THEME, PurpleSoundThemeClass))
  42 #define PURPLE_IS_SOUND_THEME(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_SOUND_THEME))
  43 #define PURPLE_IS_SOUND_THEME_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_SOUND_THEME))
  44 #define PURPLE_SOUND_THEME_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_SOUND_THEME, PurpleSoundThemeClass))
  45
  46 /**
  47  * PurpleSoundTheme:
  48  *
  49  * A purple sound theme.
  50  * This is an object for Purple to represent a sound theme.
  51  */
  52 struct _PurpleSoundTheme
  53 {
  54         /*< private >*/
  55         PurpleTheme parent;
  56 };
  57
  58 struct _PurpleSoundThemeClass
  59 {
  60         /*< private >*/
  61         PurpleThemeClass parent_class;
  62
  63         void (*purple_reserved1)(void);
  64         void (*purple_reserved2)(void);
  65         void (*purple_reserved3)(void);
  66         void (*purple_reserved4)(void);
  67 };
  68
  69 /**************************************************************************/
  70 /* Purple Sound Theme API                                                 */
  71 /**************************************************************************/
  72 G_BEGIN_DECLS
  73
  74 /**
  75  * purple_sound_theme_get_type:
  76  *
  77  * Returns: The #GType for a sound theme.
  78  */
  79 GType purple_sound_theme_get_type(void);
  80
  81 /**
  82  * purple_sound_theme_get_file:
  83  * @theme: The theme.
  84  * @event: The purple sound event to look up.
  85  *
  86  * Returns a copy of the filename for the sound event.
  87  *
  88  * Returns: The filename of the sound event.
  89  */
  90 const gchar *purple_sound_theme_get_file(PurpleSoundTheme *theme,
  91                 const gchar *event);
  92
  93 /**
  94  * purple_sound_theme_get_file_full:
  95  * @theme: The theme.
  96  * @event: The purple sound event to look up
  97  *
  98  * Returns a copy of the directory and filename for the sound event
  99  *
 100  * Returns: The directory + '/' + filename of the sound event.  This is
 101  *          a newly allocated string that should be freed with g_free.
 102  */
 103 gchar *purple_sound_theme_get_file_full(PurpleSoundTheme *theme,
 104                 const gchar *event);
 105
 106 /**
 107  * purple_sound_theme_set_file:
 108  * @theme:    The theme.
 109  * @event:    the purple sound event to look up
 110  * @filename: the name of the file to be used for the event
 111  *
 112  * Sets the filename for a given sound event
 113  */
 114 void purple_sound_theme_set_file(PurpleSoundTheme *theme,
 115                 const gchar *event,
 116                 const gchar *filename);
 117
 118 G_END_DECLS
 119
 120 #endif /* PURPLE_SOUND_THEME_H */