view libpurple/theme.h @ 25904:64d255b0a5a7

Use "Add Buddy Pounce" and "Modify Buddy Pounce" as the buddy pounce dialog titles instead of "New Buddy Pounce" and "Edit Buddy Pounce" to match the "Add Account" and "Modify Account" dialogs. I went this way figuring more people are likely to have seen the account dialogs than the buddy pounce dialogs, but if we like New/Edit better than Add/Modify we can switch the other way.

/**
 * @file theme.h  Purple Theme 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_H_
#define _PURPLE_THEME_H_

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

/**
 * A purple theme.
 * This is an abstract class for Purple to use with the Purple theme manager.
 *
 * PurpleTheme is a GObject.
 */
typedef struct _PurpleTheme        PurpleTheme;
typedef struct _PurpleThemeClass   PurpleThemeClass;

#define PURPLE_TYPE_THEME		  (purple_theme_get_type ())
#define PURPLE_THEME(obj)		  (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_TYPE_THEME, PurpleTheme))
#define PURPLE_THEME_CLASS(klass)	  (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_TYPE_THEME, PurpleThemeClass))
#define PURPLE_IS_THEME(obj)	  	  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_TYPE_THEME))
#define PURPLE_IS_THEME_CLASS(klass) 	  (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_THEME))
#define PURPLE_THEME_GET_CLASS(obj)  	  (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_THEME, PurpleThemeClass))

struct _PurpleTheme
{
	GObject parent;
	gpointer priv;
};

struct _PurpleThemeClass
{
	GObjectClass parent_class;
};

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

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

/**
 * Returns the name of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 *
 * @return The string representating the name of the theme
 */
const gchar *purple_theme_get_name(PurpleTheme *theme);

/**
 * Sets the name of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 * @param name 		the name of the PurpleTheme object
 */
void purple_theme_set_name(PurpleTheme *theme, const gchar *name);

/**
 * Returns the description of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 *
 * @return A short description of the theme
 */
const gchar *purple_theme_get_description(PurpleTheme *theme);

/**
 * Sets the description of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 * @param description	the description of the PurpleTheme object
 */
void purple_theme_set_description(PurpleTheme *theme, const gchar *description);

/**
 * Returns the author of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 *
 * @return The author of the theme
 */
const gchar *purple_theme_get_author(PurpleTheme *theme);

/**
 * Sets the author of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 * @param author	the author of the PurpleTheme object
 */
void purple_theme_set_author(PurpleTheme *theme, const gchar *author);

/**
 * Returns the type (string) of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 *
 * @return The string represtenting the type
 */
const gchar *purple_theme_get_type_string(PurpleTheme *theme);

/**
 * Returns the directory of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 *
 * @return The string represtenting the theme directory 
 */
const gchar *purple_theme_get_dir(PurpleTheme *theme);

/**
 * Sets the directory of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 * @param dir		the directory of the PurpleTheme object
 */
void purple_theme_set_dir(PurpleTheme *theme, const gchar *dir);

/**
 * Returns the image preview of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 *
 * @return The image preview of the PurpleTheme object
 */
const gchar *purple_theme_get_image(PurpleTheme *theme);

/**
 * Returns the image preview and directory of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 *
 * @return The image preview of the PurpleTheme object
 */
gchar *purple_theme_get_image_full(PurpleTheme *theme);

/**
 * Sets the directory of the PurpleTheme object
 * 
 * @param theme 	the purple theme
 * @param img		the image preview of the PurpleTheme object
 */
void purple_theme_set_image(PurpleTheme *theme, const gchar *img);

G_END_DECLS
#endif /* _PURPLE_THEME_H_ */