pidgin/gtkconv-theme.h

   1 /* pidgin
   2  *
   3  * Pidgin is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef PIDGIN_CONV_THEME_H
  23 #define PIDGIN_CONV_THEME_H
  24 /**
  25  * SECTION:gtkconv-theme
  26  * @section_id: pidgin-gtkconv-theme
  27  * @short_description: <filename>gtkconv-theme.h</filename>
  28  * @title: Conversation Theme Class
  29  */
  30
  31 #include <glib.h>
  32 #include <glib-object.h>
  33 #include "conversation.h"
  34 #include "theme.h"
  35
  36 typedef struct _PidginConvTheme        PidginConvTheme;
  37 typedef struct _PidginConvThemeClass   PidginConvThemeClass;
  38
  39 #define PIDGIN_TYPE_CONV_THEME            (pidgin_conversation_theme_get_type ())
  40 #define PIDGIN_CONV_THEME(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), PIDGIN_TYPE_CONV_THEME, PidginConvTheme))
  41 #define PIDGIN_CONV_THEME_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PIDGIN_TYPE_CONV_THEME, PidginConvThemeClass))
  42 #define PIDGIN_IS_CONV_THEME(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PIDGIN_TYPE_CONV_THEME))
  43 #define PIDGIN_IS_CONV_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_CONV_THEME))
  44 #define PIDGIN_CONV_THEME_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_CONV_THEME, PidginConvThemeClass))
  45
  46 /**
  47  * PidginConvTheme:
  48  *
  49  * extends PurpleTheme (theme.h)
  50  * A pidgin icon theme.
  51  * This object represents a Pidgin icon theme.
  52  *
  53  * PidginConvTheme is a PurpleTheme Object.
  54  */
  55 struct _PidginConvTheme
  56 {
  57         PurpleTheme parent;
  58 };
  59
  60 struct _PidginConvThemeClass
  61 {
  62         PurpleThemeClass parent_class;
  63 };
  64
  65 typedef enum {
  66         PIDGIN_CONVERSATION_THEME_TEMPLATE_MAIN,
  67         PIDGIN_CONVERSATION_THEME_TEMPLATE_HEADER,
  68         PIDGIN_CONVERSATION_THEME_TEMPLATE_FOOTER,
  69         PIDGIN_CONVERSATION_THEME_TEMPLATE_TOPIC,
  70         PIDGIN_CONVERSATION_THEME_TEMPLATE_STATUS,
  71         PIDGIN_CONVERSATION_THEME_TEMPLATE_CONTENT,
  72         PIDGIN_CONVERSATION_THEME_TEMPLATE_INCOMING_CONTENT,
  73         PIDGIN_CONVERSATION_THEME_TEMPLATE_INCOMING_NEXT_CONTENT,
  74         PIDGIN_CONVERSATION_THEME_TEMPLATE_INCOMING_CONTEXT,
  75         PIDGIN_CONVERSATION_THEME_TEMPLATE_INCOMING_NEXT_CONTEXT,
  76         PIDGIN_CONVERSATION_THEME_TEMPLATE_OUTGOING_CONTENT,
  77         PIDGIN_CONVERSATION_THEME_TEMPLATE_OUTGOING_NEXT_CONTENT,
  78         PIDGIN_CONVERSATION_THEME_TEMPLATE_OUTGOING_CONTEXT,
  79         PIDGIN_CONVERSATION_THEME_TEMPLATE_OUTGOING_NEXT_CONTEXT,
  80         PIDGIN_CONVERSATION_THEME_TEMPLATE_BASESTYLE_CSS
  81
  82 } PidginConvThemeTemplateType;
  83
  84 /**************************************************************************/
  85 /* Pidgin Conversation Theme API                                          */
  86 /**************************************************************************/
  87 G_BEGIN_DECLS
  88
  89 /**
  90  * pidgin_conversation_theme_get_type:
  91  *
  92  * Returns: The #GType for a conversation theme.
  93  */
  94 GType pidgin_conversation_theme_get_type(void);
  95
  96 /**
  97  * pidgin_conversation_theme_get_info:
  98  * @theme: The conversation theme
  99  *
 100  * Get the Info.plist hash table from a conversation theme.
 101  *
 102  * Returns: The hash table. Keys are strings as outlined for message styles,
 103  *         values are GValue*s. This is an internal structure. Take a ref if
 104  *         necessary, but don't destroy it yourself.
 105  */
 106 const GHashTable *pidgin_conversation_theme_get_info(const PidginConvTheme *theme);
 107
 108 /**
 109  * pidgin_conversation_theme_set_info:
 110  * @theme: The conversation theme
 111  * @info:  The new hash table. The theme will take ownership of this hash
 112  *              table. Do not use it yourself afterwards with holding a ref.
 113  *              For key and value specifications, see pidgin_conversation_theme_get_info().
 114  *
 115  * Set the Info.plist hash table for a conversation theme.
 116  */
 117 void pidgin_conversation_theme_set_info(PidginConvTheme *theme, GHashTable *info);
 118
 119 /**
 120  * pidgin_conversation_theme_lookup:
 121  * @theme:    The conversation theme
 122  * @key:      The key to find
 123  * @specific: Whether to search variant-specific keys
 124  *
 125  * Lookup a key in a theme
 126  *
 127  * Returns: The key information. If @specific is %TRUE, then keys are first
 128  *         searched by variant, then by general ones. Otherwise, only general
 129  *         key values are returned.
 130  */
 131 const GValue *pidgin_conversation_theme_lookup(PidginConvTheme *theme, const char *key, gboolean specific);
 132
 133 /**
 134  * pidgin_conversation_theme_get_template:
 135  * @theme: The conversation theme
 136  * @type:  The type of template data
 137  *
 138  * Get the template data from a conversation theme.
 139  *
 140  * Returns: The template data requested. Fallback is made as required by styles.
 141  *         Subsequent calls to this function will return cached values.
 142  */
 143 const char *pidgin_conversation_theme_get_template(PidginConvTheme *theme, PidginConvThemeTemplateType type);
 144
 145 /**
 146  * pidgin_conversation_theme_add_variant:
 147  * @theme:   The conversation theme
 148  * @variant: The name of the variant
 149  *
 150  * Add an available variant name to a conversation theme.
 151  *
 152  * Note: The conversation theme will take ownership of the variant name string.
 153  *       This function should normally only be called by the theme loader.
 154  */
 155 void pidgin_conversation_theme_add_variant(PidginConvTheme *theme, char *variant);
 156
 157 /**
 158  * pidgin_conversation_theme_get_variant:
 159  * @theme: The conversation theme
 160  *
 161  * Get the currently set variant name for a conversation theme.
 162  *
 163  * Returns: The current variant name.
 164  */
 165 const char *pidgin_conversation_theme_get_variant(PidginConvTheme *theme);
 166
 167 /**
 168  * pidgin_conversation_theme_set_variant:
 169  * @theme:   The conversation theme
 170  * @variant: The name of the variant
 171  *
 172  * Set the variant name for a conversation theme.
 173  */
 174 void pidgin_conversation_theme_set_variant(PidginConvTheme *theme, const char *variant);
 175
 176 /**
 177  * pidgin_conversation_theme_get_variants:
 178  * @theme: The conversation theme
 179  *
 180  * Get a list of available variants for a conversation theme.
 181  *
 182  * Returns: The list of variants. This GList and the string data are owned by
 183  *         the theme and should not be freed by the caller.
 184  */
 185 const GList *pidgin_conversation_theme_get_variants(PidginConvTheme *theme);
 186
 187 /**
 188  * pidgin_conversation_theme_get_template_path:
 189  * @theme: The conversation theme
 190  *
 191  * Get the path to the template HTML file.
 192  *
 193  * Returns: The path to the HTML file.
 194  */
 195 char *pidgin_conversation_theme_get_template_path(PidginConvTheme *theme);
 196
 197 /**
 198  * pidgin_conversation_theme_get_css_path:
 199  * @theme: The conversation theme
 200  *
 201  * Get the path to the current variant CSS file.
 202  *
 203  * Returns: The path to the CSS file.
 204  */
 205 char *pidgin_conversation_theme_get_css_path(PidginConvTheme *theme);
 206
 207 /**
 208  * pidgin_conversation_theme_get_nick_colors:
 209  * @theme: The conversation theme
 210  *
 211  * Get (and reference) the array of nick colors
 212  *
 213  * Returns: Pointer to GArray of nick colors, or NULL if no colors in theme
 214  */
 215 GArray *pidgin_conversation_theme_get_nick_colors(PidginConvTheme *theme);
 216
 217 G_END_DECLS
 218
 219 #endif /* PIDGIN_CONV_THEME_H */
 220