libpurple/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_THEME_H
  23 #define PURPLE_THEME_H
  24 /**
  25  * SECTION:theme
  26  * @section_id: libpurple-theme
  27  * @short_description: <filename>theme.h</filename>
  28  * @title: Theme Abstact Class
  29  */
  30
  31 #include <glib.h>
  32 #include <glib-object.h>
  33
  34 typedef struct _PurpleTheme        PurpleTheme;
  35 typedef struct _PurpleThemeClass   PurpleThemeClass;
  36
  37 #define PURPLE_TYPE_THEME            (purple_theme_get_type ())
  38 #define PURPLE_THEME(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_TYPE_THEME, PurpleTheme))
  39 #define PURPLE_THEME_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_TYPE_THEME, PurpleThemeClass))
  40 #define PURPLE_IS_THEME(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_TYPE_THEME))
  41 #define PURPLE_IS_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_THEME))
  42 #define PURPLE_THEME_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_THEME, PurpleThemeClass))
  43
  44 /**
  45  * PurpleTheme:
  46  *
  47  * A purple theme.
  48  * This is an abstract class for Purple to use with the Purple theme manager.
  49  */
  50 struct _PurpleTheme
  51 {
  52         GObject parent;
  53 };
  54
  55 struct _PurpleThemeClass
  56 {
  57         GObjectClass parent_class;
  58
  59         /*< private >*/
  60         void (*purple_reserved1)(void);
  61         void (*purple_reserved2)(void);
  62         void (*purple_reserved3)(void);
  63         void (*purple_reserved4)(void);
  64 };
  65
  66 /**************************************************************************/
  67 /* Purple Theme API                                                       */
  68 /**************************************************************************/
  69 G_BEGIN_DECLS
  70
  71 /**
  72  * purple_theme_get_type:
  73  *
  74  * Returns: The #GType for a theme.
  75  */
  76 GType purple_theme_get_type(void);
  77
  78 /**
  79  * purple_theme_get_name:
  80  * @theme:  The purple theme.
  81  *
  82  * Returns the name of the PurpleTheme object.
  83  *
  84  * Returns: The string representing the name of the theme.
  85  */
  86 const gchar *purple_theme_get_name(PurpleTheme *theme);
  87
  88 /**
  89  * purple_theme_set_name:
  90  * @theme: The purple theme.
  91  * @name:  The name of the PurpleTheme object.
  92  *
  93  * Sets the name of the PurpleTheme object.
  94  */
  95 void purple_theme_set_name(PurpleTheme *theme, const gchar *name);
  96
  97 /**
  98  * purple_theme_get_description:
  99  * @theme:  The purple theme.
 100  *
 101  * Returns the description of the PurpleTheme object.
 102  *
 103  * Returns: A short description of the theme.
 104  */
 105 const gchar *purple_theme_get_description(PurpleTheme *theme);
 106
 107 /**
 108  * purple_theme_set_description:
 109  * @theme:  The purple theme.
 110  * @description: The description of the PurpleTheme object.
 111  *
 112  * Sets the description of the PurpleTheme object.
 113  */
 114 void purple_theme_set_description(PurpleTheme *theme, const gchar *description);
 115
 116 /**
 117  * purple_theme_get_author:
 118  * @theme:  The purple theme.
 119  *
 120  * Returns the author of the PurpleTheme object.
 121  *
 122  * Returns: The author of the theme.
 123  */
 124 const gchar *purple_theme_get_author(PurpleTheme *theme);
 125
 126 /**
 127  * purple_theme_set_author:
 128  * @theme:  The purple theme.
 129  * @author: The author of the PurpleTheme object.
 130  *
 131  * Sets the author of the PurpleTheme object.
 132  */
 133 void purple_theme_set_author(PurpleTheme *theme, const gchar *author);
 134
 135 /**
 136  * purple_theme_get_type_string:
 137  * @theme:  The purple theme.
 138  *
 139  * Returns the type (string) of the PurpleTheme object.
 140  *
 141  * Returns: The string representing the type.
 142  */
 143 const gchar *purple_theme_get_type_string(PurpleTheme *theme);
 144
 145 /**
 146  * purple_theme_get_dir:
 147  * @theme:  The purple theme.
 148  *
 149  * Returns the directory of the PurpleTheme object.
 150  *
 151  * Returns: The string representing the theme directory.
 152  */
 153 const gchar *purple_theme_get_dir(PurpleTheme *theme);
 154
 155 /**
 156  * purple_theme_set_dir:
 157  * @theme:  The purple theme.
 158  * @dir:    The directory of the PurpleTheme object.
 159  *
 160  * Sets the directory of the PurpleTheme object.
 161  */
 162 void purple_theme_set_dir(PurpleTheme *theme, const gchar *dir);
 163
 164 /**
 165  * purple_theme_get_image:
 166  * @theme:  The purple theme.
 167  *
 168  * Returns the image preview of the PurpleTheme object.
 169  *
 170  * Returns: The image preview of the PurpleTheme object.
 171  */
 172 const gchar *purple_theme_get_image(PurpleTheme *theme);
 173
 174 /**
 175  * purple_theme_get_image_full:
 176  * @theme:  The purple theme.
 177  *
 178  * Returns the image preview and directory of the PurpleTheme object.
 179  *
 180  * Returns: The image preview of the PurpleTheme object.
 181  */
 182 gchar *purple_theme_get_image_full(PurpleTheme *theme);
 183
 184 /**
 185  * purple_theme_set_image:
 186  * @theme:       The purple theme.
 187  * @img:    The image preview of the PurpleTheme object.
 188  *
 189  * Sets the directory of the PurpleTheme object.
 190  */
 191 void purple_theme_set_image(PurpleTheme *theme, const gchar *img);
 192
 193 G_END_DECLS
 194
 195 #endif /* PURPLE_THEME_H */