comparison libpurple/theme-loader.h @ 23452:68b7691aa3ed

Added theme loader class abstract whose only (current/planned) function is to build themes

23452:68b7691aa3ed

/**
 * @file purpletheme.h  Purple Theme Loader Abstact Class API
 */

/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */

#ifndef _PURPLE_THEME_LOADER_H_
#define _PURPLE_THEME_LOADER_H_

#include <glib.h>
#include <glib-object.h>
#include "theme.h"

/**
 * A purple theme loader.
 * This is an abstract class for Purple to use with the Purple theme manager.
 * The loader is responsible for building each type of theme
 *
 * PurpleThemeLoader is a GObject.
 */
typedef struct _PurpleThemeLoader        PurpleThemeLoader;
typedef struct _PurpleThemeLoaderClass   PurpleThemeLoaderClass;

#define PURPLE_TYPE_THEME_LOADER		  (purple_theme_loader_get_type ())
#define PURPLE_THEME_LOADER(obj)	 	  (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_TYPE_THEME_LOADER, PurpleThemeLoader))
#define PURPLE_THEME_LOADER_CLASS(klass)	  (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_TYPE_THEME_LOADER, PurpleThemeLoaderClass))
#define PURPLE_IS_THEME_LOADER(obj)	  	  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_TYPE_THEME_LOADER))
#define PURPLE_IS_THEME_LOADER_CLASS(klass) 	  (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_THEME_LOADER))
#define PURPLE_THEME_LOADER_GET_CLASS(obj)  	  (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_THEME_LOADER, PurpleThemeLoaderClass))

struct _PurpleThemeLoader
{
	GObject parent;
	gpointer priv;
};

struct _PurpleThemeLoaderClass
{
	GObjectClass parent_class;
	PurpleTheme *(*_purple_theme_loader_build)(const gchar);
};

/**************************************************************************/
/** @name Purple Theme-Loader API                                         */
/**************************************************************************/
G_BEGIN_DECLS

/**
 * GObject foo.
 * @internal.
 */
GType purple_theme_loader_get_type(void);

/**
 * Returns the string represtenting the type of the theme loader
 *
 * @param self 		the theme loader
 *
 * @returns 		the string represting this type
 */
gchar *purple_theme_loader_get_type_string(PurpleThemeLoader *self);

/**
 * Creates a new PurpleTheme
 *
 * @param dir 		the directory containing the theme
 *
 * @returns 		PurpleTheme containing the information from the directory
 */
PurpleTheme *purple_theme_loader_build(PurpleThemeLoader *loader, const gchar *dir);

G_END_DECLS
#endif /* _PURPLE_THEME_LOADER_H_ */