libpurple/theme-manager.h

   1 /*
   2  * purple
   3  *
   4  * Purple is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23 #ifndef PURPLE_THEME_MANAGER_H
  24 #define PURPLE_THEME_MANAGER_H
  25 /**
  26  * SECTION:theme-manager
  27  * @section_id: libpurple-theme-manager
  28  * @short_description: <filename>theme-manager.h</filename>
  29  * @title: Theme Manager API
  30  */
  31
  32 #include <glib-object.h>
  33 #include <glib.h>
  34 #include "theme.h"
  35 #include "theme-loader.h"
  36
  37 typedef void (*PurpleThemeFunc) (PurpleTheme *);
  38
  39 typedef struct _PurpleThemeManager PurpleThemeManager;
  40 typedef struct _PurpleThemeManagerClass PurpleThemeManagerClass;
  41
  42 #define PURPLE_TYPE_THEME_MANAGER            (purple_theme_manager_get_type())
  43 #define PURPLE_THEME_MANAGER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_THEME_MANAGER, PurpleThemeManager))
  44 #define PURPLE_THEME_MANAGER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_THEME_MANAGER, PurpleThemeManagerClass))
  45 #define PURPLE_IS_THEME_MANAGER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_THEME_MANAGER))
  46 #define PURPLE_IS_THEME_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_THEME_MANAGER))
  47 #define PURPLE_GET_THEME_MANAGER_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_THEME_MANAGER, PurpleThemeManagerClass))
  48
  49 struct _PurpleThemeManager {
  50         GObject parent;
  51 };
  52
  53 struct _PurpleThemeManagerClass {
  54         GObjectClass parent_class;
  55
  56         /*< private >*/
  57         void (*purple_reserved1)(void);
  58         void (*purple_reserved2)(void);
  59         void (*purple_reserved3)(void);
  60         void (*purple_reserved4)(void);
  61 };
  62
  63 /**************************************************************************/
  64 /* Purple Theme Manager API                                               */
  65 /**************************************************************************/
  66 G_BEGIN_DECLS
  67
  68 /**
  69  * purple_theme_manager_get_type:
  70  *
  71  * Returns: The #GType for theme manager.
  72  */
  73 GType purple_theme_manager_get_type(void);
  74
  75 /**
  76  * purple_theme_manager_init:
  77  *
  78  * Initalizes the theme manager.
  79  */
  80 void purple_theme_manager_init(void);
  81
  82 /**
  83  * purple_theme_manager_uninit:
  84  *
  85  * Uninitalizes the manager then frees all the themes and loaders it is
  86  * responsible for.
  87  */
  88 void purple_theme_manager_uninit(void);
  89
  90 /**
  91  * purple_theme_manager_refresh:
  92  *
  93  * Rebuilds all the themes in the theme manager.
  94  * (Removes all current themes but keeps the added loaders.)
  95  */
  96 void purple_theme_manager_refresh(void);
  97
  98 /**
  99  * purple_theme_manager_find_theme:
 100  * @name: The name of the PurpleTheme.
 101  * @type: The type of the PurpleTheme.
 102  *
 103  * Finds the PurpleTheme object stored by the theme manager.
 104  *
 105  * Returns: The PurpleTheme, or NULL if it wasn't found.
 106  */
 107 PurpleTheme *purple_theme_manager_find_theme(const gchar *name, const gchar *type);
 108
 109 /**
 110  * purple_theme_manager_add_theme:
 111  * @theme: The PurpleTheme to add to the manager.
 112  *
 113  * Adds a PurpleTheme to the theme manager.  If the theme already exists
 114  * then this function does nothing.
 115  */
 116 void purple_theme_manager_add_theme(PurpleTheme *theme);
 117
 118 /**
 119  * purple_theme_manager_remove_theme:
 120  * @theme: The PurpleTheme to remove from the manager.
 121  *
 122  * Removes a PurpleTheme from the theme manager and frees the theme.
 123  */
 124 void purple_theme_manager_remove_theme(PurpleTheme *theme);
 125
 126 /**
 127  * purple_theme_manager_register_type:
 128  * @loader: The PurpleThemeLoader to add.
 129  *
 130  * Adds a loader to the theme manager so it knows how to build themes.
 131  */
 132 void purple_theme_manager_register_type(PurpleThemeLoader *loader);
 133
 134 /**
 135  * purple_theme_manager_unregister_type:
 136  * @loader: The PurpleThemeLoader to be removed.
 137  *
 138  * Removes the loader and all themes of the same type from the loader.
 139  */
 140 void purple_theme_manager_unregister_type(PurpleThemeLoader *loader);
 141
 142 /**
 143  * purple_theme_manager_for_each_theme:
 144  * @func: The PurpleThemeFunc to be applied to each theme.
 145  *
 146  * Calls the given function on each purple theme.
 147  */
 148 void purple_theme_manager_for_each_theme(PurpleThemeFunc func);
 149
 150 /**
 151  * purple_theme_manager_load_theme:
 152  * @theme_dir:  the directory of the theme to load
 153  * @type:               the type of theme to load
 154  *
 155  * Loads a theme of the given type without adding it to the manager
 156  */
 157 PurpleTheme *purple_theme_manager_load_theme(const gchar *theme_dir, const gchar *type);
 158
 159 G_END_DECLS
 160
 161 #endif /* PURPLE_THEME_MANAGER_H */