pidgin/gtkblist-theme.h

   1 /**
   2  * @file gtkblist-theme.h GTK+ Buddy List Theme API
   3  */
   4
   5 /* pidgin
   6  *
   7  * Pidgin is the legal property of its developers, whose names are too numerous
   8  * to list here.  Please refer to the COPYRIGHT file distributed with this
   9  * source distribution.
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  24  */
  25
  26 #ifndef PIDGIN_BLIST_THEME_H
  27 #define PIDGIN_BLIST_THEME_H
  28
  29 #include <glib.h>
  30 #include <glib-object.h>
  31 #include <gtk/gtk.h>
  32
  33 #include "theme.h"
  34
  35 /**
  36  * A pidgin buddy list theme.
  37  * This is an object for Purple to represent a buddy list theme.
  38  *
  39  * PidginBlistTheme is a PurpleTheme Object.
  40  */
  41 typedef struct _PidginBlistTheme        PidginBlistTheme;
  42 typedef struct _PidginBlistThemeClass   PidginBlistThemeClass;
  43
  44 #define PIDGIN_TYPE_BLIST_THEME            (pidgin_blist_theme_get_type ())
  45 #define PIDGIN_BLIST_THEME(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistTheme))
  46 #define PIDGIN_BLIST_THEME_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))
  47 #define PIDGIN_IS_BLIST_THEME(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PIDGIN_TYPE_BLIST_THEME))
  48 #define PIDGIN_IS_BLIST_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME))
  49 #define PIDGIN_BLIST_THEME_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))
  50
  51 struct _PidginBlistTheme
  52 {
  53         PurpleTheme parent;
  54         gpointer priv;
  55 };
  56
  57 struct _PidginBlistThemeClass
  58 {
  59         PurpleThemeClass parent_class;
  60 };
  61
  62 #if 0
  63 typedef struct
  64 {
  65         const gchar *font;
  66         const gchar *color;
  67
  68 } PidginThemeFont;
  69 #endif
  70 typedef struct _PidginThemeFont PidginThemeFont;
  71
  72 typedef struct
  73 {
  74         gint status_icon;
  75         gint text;
  76         gint emblem;
  77         gint protocol_icon;
  78         gint buddy_icon;
  79         gboolean show_status;
  80
  81 } PidginBlistLayout;
  82
  83 /**************************************************************************/
  84 /** @name PidginThemeFont API                                               */
  85 /**************************************************************************/
  86
  87 /**
  88  * Create a new PidginThemeFont.
  89  *
  90  * @param face  The font face
  91  * @param color The color of the font
  92  *
  93  * @return A newly created PidginThemeFont
  94  */
  95 PidginThemeFont * pidgin_theme_font_new(const gchar *face, GdkColor *color);
  96
  97 /**
  98  * Frees a font and color pair
  99  *
 100  * @param font The theme font
 101  */
 102 void pidgin_theme_font_free(PidginThemeFont *font);
 103
 104 /**
 105  * Set the font-face of a PidginThemeFont.
 106  *
 107  * @param font  The PidginThemeFont
 108  * @param face  The font-face
 109  */
 110 void pidgin_theme_font_set_font_face(PidginThemeFont *font, const gchar *face);
 111
 112 /**
 113  * Set the color of a PidginThemeFont.
 114  *
 115  * @param font  The PidginThemeFont
 116  * @param color The color
 117  */
 118 void pidgin_theme_font_set_color(PidginThemeFont *font, const GdkColor *color);
 119
 120 /**
 121  * Get the font-face of a PidginThemeFont.
 122  *
 123  * @param font  The PidginThemeFont
 124  *
 125  * @return The font-face, or NULL if none is set.
 126  */
 127 const gchar * pidgin_theme_font_get_font_face(PidginThemeFont *font);
 128
 129 /**
 130  * Get the color of a PidginThemeFont as a GdkColor object.
 131  *
 132  * @param font  The PidginThemeFont
 133  *
 134  * @return The color, or NULL if none is set.
 135  */
 136 const GdkColor * pidgin_theme_font_get_color(PidginThemeFont *font);
 137
 138 /**
 139  * Get the color of a PidginThemeFont.
 140  *
 141  * @param font  The PidginThemeFont
 142  *
 143  * @return The color, or NULL if none is set.
 144  */
 145 const gchar * pidgin_theme_font_get_color_describe(PidginThemeFont *font);
 146
 147 /**************************************************************************/
 148 /** @name Purple Buddy List Theme API                                     */
 149 /**************************************************************************/
 150 G_BEGIN_DECLS
 151
 152 /**
 153  * GObject foo.
 154  * @internal.
 155  */
 156 GType pidgin_blist_theme_get_type(void);
 157
 158 /* get methods */
 159
 160 /**
 161  * Returns the background color of the buddy list.
 162  *
 163  * @param theme  The PidginBlist theme.
 164  *
 165  * @returns A gdk color.
 166  */
 167  GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
 168
 169 /**
 170  * Returns the opacity of the buddy list window
 171  * (0.0 or clear to 1.0 fully opaque).
 172  *
 173  * @param theme  The PidginBlist theme.
 174  *
 175  * @returns The opacity
 176  */
 177 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
 178
 179 /**
 180  * Returns the layout to be used with the buddy list.
 181  *
 182  * @param theme  The PidginBlist theme.
 183  *
 184  * @returns The buddy list layout.
 185  */
 186  PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
 187
 188 /**
 189  * Returns the background color to be used with expanded groups.
 190  *
 191  * @param theme  The PidginBlist theme.
 192  *
 193  * @returns A gdk color.
 194  */
 195  GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
 196
 197 /**
 198  * Returns the text font and color to be used with expanded groups.
 199  *
 200  * @param theme  The PidginBlist theme.
 201  *
 202  * @returns A font and color pair.
 203  */
 204  PidginThemeFont *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
 205
 206 /**
 207  * Returns the background color to be used with collapsed groups.
 208  *
 209  * @param theme  The PidginBlist theme.
 210  *
 211  * @returns A gdk color.
 212  */
 213  GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
 214
 215 /**
 216  * Returns the text font and color to be used with collapsed groups.
 217  *
 218  * @param theme  The PidginBlist theme.
 219  *
 220  * @returns A font and color pair.
 221  */
 222  PidginThemeFont *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
 223
 224 /**
 225  * Returns the colors to be used for contacts and chats.
 226  *
 227  * @param theme  The PidginBlist theme.
 228  *
 229  * @returns A gdkcolor for contacts and chats.
 230  */
 231  GdkColor *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme);
 232
 233 /**
 234  * Returns the text font and color to be used for expanded contacts.
 235  *
 236  * @param theme  The PidginBlist theme.
 237  *
 238  * @returns A font and color pair.
 239  */
 240  PidginThemeFont *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
 241
 242 /**
 243  * Returns the text font and color to be used for online buddies.
 244  *
 245  * @param theme  The PidginBlist theme.
 246  *
 247  * @returns A font and color pair.
 248  */
 249  PidginThemeFont *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
 250
 251 /**
 252  * Returns the text font and color to be used for away and idle buddies.
 253  *
 254  * @param theme  The PidginBlist theme.
 255  *
 256  * @returns A font and color pair.
 257  */
 258  PidginThemeFont *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
 259
 260 /**
 261  * Returns the text font and color to be used for offline buddies.
 262  *
 263  * @param theme  The PidginBlist theme.
 264  *
 265  * @returns A font and color pair.
 266  */
 267  PidginThemeFont *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
 268
 269 /**
 270  * Returns the text font and color to be used for idle buddies.
 271  *
 272  * @param theme  The PidginBlist theme.
 273  *
 274  * @returns A font and color pair.
 275  */
 276  PidginThemeFont *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
 277
 278 /**
 279  * Returns the text font and color to be used for buddies with unread messages.
 280  *
 281  * @param theme  The PidginBlist theme.
 282  *
 283  * @returns A font and color pair.
 284  */
 285  PidginThemeFont *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme);
 286
 287 /**
 288  * Returns the text font and color to be used for chats with unread messages
 289  * that mention your nick.
 290  *
 291  * @param theme  The PidginBlist theme.
 292  *
 293  * @returns A font and color pair.
 294  */
 295  PidginThemeFont *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme);
 296
 297 /**
 298  * Returns the text font and color to be used for a buddy's status message.
 299  *
 300  * @param theme  The PidginBlist theme.
 301  *
 302  * @returns A font and color pair.
 303  */
 304  PidginThemeFont *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme);
 305
 306 /* Set Methods */
 307
 308 /**
 309  * Sets the background color to be used for this buddy list theme.
 310  *
 311  * @param theme  The PidginBlist theme.
 312  * @param color The new background color.
 313  */
 314 void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, const GdkColor *color);
 315
 316 /**
 317  * Sets the opacity to be used for this buddy list theme.
 318  *
 319  * @param theme  The PidginBlist theme.
 320  * @param opacity The new opacity setting.
 321  */
 322 void pidgin_blist_theme_set_opacity(PidginBlistTheme *theme, gdouble opacity);
 323
 324 /**
 325  * Sets the buddy list layout to be used for this buddy list theme.
 326  *
 327  * @param theme  The PidginBlist theme.
 328  * @param layout The new layout.
 329  */
 330 void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, const PidginBlistLayout *layout);
 331
 332 /**
 333  * Sets the background color to be used for expanded groups.
 334  *
 335  * @param theme  The PidginBlist theme.
 336  * @param color The new background color.
 337  */
 338 void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, const GdkColor *color);
 339
 340 /**
 341  * Sets the text color and font to be used for expanded groups.
 342  *
 343  * @param theme  The PidginBlist theme.
 344  * @param pair The new text font and color pair.
 345  */
 346 void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 347
 348 /**
 349  * Sets the background color to be used for collapsed groups.
 350  *
 351  * @param theme  The PidginBlist theme.
 352  * @param color The new background color.
 353  */
 354 void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, const GdkColor *color);
 355
 356 /**
 357  * Sets the text color and font to be used for expanded groups.
 358  *
 359  * @param theme  The PidginBlist theme.
 360  * @param pair The new text font and color pair.
 361  */
 362 void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 363
 364 /**
 365  * Sets the background color to be used for contacts and chats.
 366  *
 367  * @param theme  The PidginBlist theme.
 368  * @param color The color to use for contacts and chats.
 369  */
 370 void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, const GdkColor *color);
 371
 372 /**
 373  * Sets the text color and font to be used for expanded contacts.
 374  *
 375  * @param theme  The PidginBlist theme.
 376  * @param pair The new text font and color pair.
 377  */
 378 void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 379
 380 /**
 381  * Sets the text color and font to be used for online buddies.
 382  *
 383  * @param theme  The PidginBlist theme.
 384  * @param pair The new text font and color pair.
 385  */
 386 void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 387
 388 /**
 389  * Sets the text color and font to be used for away and idle buddies.
 390  *
 391  * @param theme  The PidginBlist theme.
 392  * @param pair The new text font and color pair.
 393  */
 394 void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 395
 396 /**
 397  * Sets the text color and font to be used for offline buddies.
 398  *
 399  * @param theme  The PidginBlist theme.
 400  * @param pair The new text font and color pair.
 401  */
 402 void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 403
 404 /**
 405  * Sets the text color and font to be used for idle buddies.
 406  *
 407  * @param theme  The PidginBlist theme.
 408  * @param pair The new text font and color pair.
 409  */
 410 void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 411
 412 /**
 413  * Sets the text color and font to be used for buddies with unread messages.
 414  *
 415  * @param theme  The PidginBlist theme.
 416  * @param pair The new text font and color pair.
 417  */
 418 void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 419
 420 /**
 421  * Sets the text color and font to be used for a chat with unread messages
 422  * that mention your nick.
 423  *
 424  * @param theme  The PidginBlist theme.
 425  * @param pair The new text font and color pair.
 426  */
 427 void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 428
 429 /**
 430  * Sets the text color and font to be used for buddy status messages.
 431  *
 432  * @param theme  The PidginBlist theme.
 433  * @param pair The new text font and color pair.
 434  */
 435 void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 436
 437 G_END_DECLS
 438 #endif /* PIDGIN_BLIST_THEME_H */