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 *theme);
  38
  39 #define PURPLE_TYPE_THEME_MANAGER  purple_theme_manager_get_type()
  40
  41 /**************************************************************************/
  42 /* Purple Theme Manager API                                               */
  43 /**************************************************************************/
  44 G_BEGIN_DECLS
  45
  46 /**
  47  * purple_theme_manager_get_type:
  48  *
  49  * Returns: The #GType for theme manager.
  50  */
  51 G_DECLARE_FINAL_TYPE(PurpleThemeManager, purple_theme_manager, PURPLE,
  52                 THEME_MANAGER, GObject)
  53
  54 /**
  55  * purple_theme_manager_init:
  56  *
  57  * Initalizes the theme manager.
  58  */
  59 void purple_theme_manager_init(void);
  60
  61 /**
  62  * purple_theme_manager_uninit:
  63  *
  64  * Uninitalizes the manager then frees all the themes and loaders it is
  65  * responsible for.
  66  */
  67 void purple_theme_manager_uninit(void);
  68
  69 /**
  70  * purple_theme_manager_refresh:
  71  *
  72  * Rebuilds all the themes in the theme manager.
  73  * (Removes all current themes but keeps the added loaders.)
  74  */
  75 void purple_theme_manager_refresh(void);
  76
  77 /**
  78  * purple_theme_manager_find_theme:
  79  * @name: The name of the PurpleTheme.
  80  * @type: The type of the PurpleTheme.
  81  *
  82  * Finds the PurpleTheme object stored by the theme manager.
  83  *
  84  * Returns: (transfer none): The PurpleTheme, or NULL if it wasn't found.
  85  */
  86 PurpleTheme *purple_theme_manager_find_theme(const gchar *name, const gchar *type);
  87
  88 /**
  89  * purple_theme_manager_add_theme:
  90  * @theme: The PurpleTheme to add to the manager.
  91  *
  92  * Adds a PurpleTheme to the theme manager.  If the theme already exists
  93  * then this function does nothing.
  94  */
  95 void purple_theme_manager_add_theme(PurpleTheme *theme);
  96
  97 /**
  98  * purple_theme_manager_remove_theme:
  99  * @theme: The PurpleTheme to remove from the manager.
 100  *
 101  * Removes a PurpleTheme from the theme manager and frees the theme.
 102  */
 103 void purple_theme_manager_remove_theme(PurpleTheme *theme);
 104
 105 /**
 106  * purple_theme_manager_register_type:
 107  * @loader: The PurpleThemeLoader to add.
 108  *
 109  * Adds a loader to the theme manager so it knows how to build themes.
 110  */
 111 void purple_theme_manager_register_type(PurpleThemeLoader *loader);
 112
 113 /**
 114  * purple_theme_manager_unregister_type:
 115  * @loader: The PurpleThemeLoader to be removed.
 116  *
 117  * Removes the loader and all themes of the same type from the loader.
 118  */
 119 void purple_theme_manager_unregister_type(PurpleThemeLoader *loader);
 120
 121 /**
 122  * purple_theme_manager_for_each_theme:
 123  * @func: (scope call): The PurpleThemeFunc to be applied to each theme.
 124  *
 125  * Calls the given function on each purple theme.
 126  */
 127 void purple_theme_manager_for_each_theme(PurpleThemeFunc func);
 128
 129 /**
 130  * purple_theme_manager_load_theme:
 131  * @theme_dir:  the directory of the theme to load
 132  * @type:               the type of theme to load
 133  *
 134  * Loads a theme of the given type without adding it to the manager
 135  *
 136  * Returns: (transfer full): The newly loaded theme.
 137  */
 138 PurpleTheme *purple_theme_manager_load_theme(const gchar *theme_dir, const gchar *type);
 139
 140 G_END_DECLS
 141
 142 #endif /* PURPLE_THEME_MANAGER_H */