Frameworks/libpurple.framework/Versions/0.6.0/Headers/theme.h
changeset 2592 e8d15275025e
parent 2591 f66a716bfc79
child 2593 b4bd28402abc
     1.1 --- a/Frameworks/libpurple.framework/Versions/0.6.0/Headers/theme.h	Fri Aug 21 13:24:36 2009 -0700
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,175 +0,0 @@
     1.4 -/**
     1.5 - * @file theme.h  Purple Theme Abstact Class API
     1.6 - */
     1.7 -
     1.8 -/* purple
     1.9 - *
    1.10 - * Purple is the legal property of its developers, whose names are too numerous
    1.11 - * to list here.  Please refer to the COPYRIGHT file distributed with this
    1.12 - * source distribution.
    1.13 - *
    1.14 - * This program is free software; you can redistribute it and/or modify
    1.15 - * it under the terms of the GNU General Public License as published by
    1.16 - * the Free Software Foundation; either version 2 of the License, or
    1.17 - * (at your option) any later version.
    1.18 - *
    1.19 - * This program is distributed in the hope that it will be useful,
    1.20 - * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.21 - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.22 - * GNU General Public License for more details.
    1.23 - *
    1.24 - * You should have received a copy of the GNU General Public License
    1.25 - * along with this program; if not, write to the Free Software
    1.26 - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
    1.27 - */
    1.28 -
    1.29 -#ifndef PURPLE_THEME_H
    1.30 -#define PURPLE_THEME_H
    1.31 -
    1.32 -#include <glib.h>
    1.33 -#include <glib-object.h>
    1.34 -#include "imgstore.h"
    1.35 -
    1.36 -/**
    1.37 - * A purple theme.
    1.38 - * This is an abstract class for Purple to use with the Purple theme manager.
    1.39 - *
    1.40 - * PurpleTheme is a GObject.
    1.41 - */
    1.42 -typedef struct _PurpleTheme        PurpleTheme;
    1.43 -typedef struct _PurpleThemeClass   PurpleThemeClass;
    1.44 -
    1.45 -#define PURPLE_TYPE_THEME            (purple_theme_get_type ())
    1.46 -#define PURPLE_THEME(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), PURPLE_TYPE_THEME, PurpleTheme))
    1.47 -#define PURPLE_THEME_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_TYPE_THEME, PurpleThemeClass))
    1.48 -#define PURPLE_IS_THEME(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PURPLE_TYPE_THEME))
    1.49 -#define PURPLE_IS_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_THEME))
    1.50 -#define PURPLE_THEME_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_THEME, PurpleThemeClass))
    1.51 -
    1.52 -struct _PurpleTheme
    1.53 -{
    1.54 -	GObject parent;
    1.55 -	gpointer priv;
    1.56 -};
    1.57 -
    1.58 -struct _PurpleThemeClass
    1.59 -{
    1.60 -	GObjectClass parent_class;
    1.61 -};
    1.62 -
    1.63 -/**************************************************************************/
    1.64 -/** @name Purple Theme API                                                */
    1.65 -/**************************************************************************/
    1.66 -G_BEGIN_DECLS
    1.67 -
    1.68 -/**
    1.69 - * GObject foo.
    1.70 - * @internal.
    1.71 - */
    1.72 -GType purple_theme_get_type(void);
    1.73 -
    1.74 -/**
    1.75 - * Returns the name of the PurpleTheme object.
    1.76 - *
    1.77 - * @param theme  The purple theme.
    1.78 - *
    1.79 - * @return The string representating the name of the theme.
    1.80 - */
    1.81 -const gchar *purple_theme_get_name(PurpleTheme *theme);
    1.82 -
    1.83 -/**
    1.84 - * Sets the name of the PurpleTheme object.
    1.85 - *
    1.86 - * @param theme The purple theme.
    1.87 - * @param name  The name of the PurpleTheme object.
    1.88 - */
    1.89 -void purple_theme_set_name(PurpleTheme *theme, const gchar *name);
    1.90 -
    1.91 -/**
    1.92 - * Returns the description of the PurpleTheme object.
    1.93 - *
    1.94 - * @param theme  The purple theme.
    1.95 - *
    1.96 - * @return A short description of the theme.
    1.97 - */
    1.98 -const gchar *purple_theme_get_description(PurpleTheme *theme);
    1.99 -
   1.100 -/**
   1.101 - * Sets the description of the PurpleTheme object.
   1.102 - *
   1.103 - * @param theme  The purple theme.
   1.104 - * @param description The description of the PurpleTheme object.
   1.105 - */
   1.106 -void purple_theme_set_description(PurpleTheme *theme, const gchar *description);
   1.107 -
   1.108 -/**
   1.109 - * Returns the author of the PurpleTheme object.
   1.110 - *
   1.111 - * @param theme  The purple theme.
   1.112 - *
   1.113 - * @return The author of the theme.
   1.114 - */
   1.115 -const gchar *purple_theme_get_author(PurpleTheme *theme);
   1.116 -
   1.117 -/**
   1.118 - * Sets the author of the PurpleTheme object.
   1.119 - *
   1.120 - * @param theme  The purple theme.
   1.121 - * @param author The author of the PurpleTheme object.
   1.122 - */
   1.123 -void purple_theme_set_author(PurpleTheme *theme, const gchar *author);
   1.124 -
   1.125 -/**
   1.126 - * Returns the type (string) of the PurpleTheme object.
   1.127 - *
   1.128 - * @param theme  The purple theme.
   1.129 - *
   1.130 - * @return The string represtenting the type.
   1.131 - */
   1.132 -const gchar *purple_theme_get_type_string(PurpleTheme *theme);
   1.133 -
   1.134 -/**
   1.135 - * Returns the directory of the PurpleTheme object.
   1.136 - *
   1.137 - * @param theme  The purple theme.
   1.138 - *
   1.139 - * @return The string represtenting the theme directory.
   1.140 - */
   1.141 -const gchar *purple_theme_get_dir(PurpleTheme *theme);
   1.142 -
   1.143 -/**
   1.144 - * Sets the directory of the PurpleTheme object.
   1.145 - *
   1.146 - * @param theme  The purple theme.
   1.147 - * @param dir    The directory of the PurpleTheme object.
   1.148 - */
   1.149 -void purple_theme_set_dir(PurpleTheme *theme, const gchar *dir);
   1.150 -
   1.151 -/**
   1.152 - * Returns the image preview of the PurpleTheme object.
   1.153 - *
   1.154 - * @param theme  The purple theme.
   1.155 - *
   1.156 - * @return The image preview of the PurpleTheme object.
   1.157 - */
   1.158 -const gchar *purple_theme_get_image(PurpleTheme *theme);
   1.159 -
   1.160 -/**
   1.161 - * Returns the image preview and directory of the PurpleTheme object.
   1.162 - *
   1.163 - * @param theme  The purple theme.
   1.164 - *
   1.165 - * @return The image preview of the PurpleTheme object.
   1.166 - */
   1.167 -gchar *purple_theme_get_image_full(PurpleTheme *theme);
   1.168 -
   1.169 -/**
   1.170 - * Sets the directory of the PurpleTheme object.
   1.171 - *
   1.172 - * @param theme	 The purple theme.
   1.173 - * @param img    The image preview of the PurpleTheme object.
   1.174 - */
   1.175 -void purple_theme_set_image(PurpleTheme *theme, const gchar *img);
   1.176 -
   1.177 -G_END_DECLS
   1.178 -#endif /* PURPLE_THEME_H */