pidgin/gtkblist-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_BLIST_THEME_H
  23 #define PIDGIN_BLIST_THEME_H
  24 /**
  25  * SECTION:gtkblist-theme
  26  * @section_id: pidgin-gtkblist-theme
  27  * @short_description: <filename>gtkblist-theme.h</filename>
  28  * @title: Buddy List Theme API
  29  */
  30
  31 #include <glib.h>
  32 #include <glib-object.h>
  33 #include <gtk/gtk.h>
  34
  35 #include "theme.h"
  36
  37 typedef struct _PidginBlistTheme        PidginBlistTheme;
  38 typedef struct _PidginBlistThemeClass   PidginBlistThemeClass;
  39
  40 #define PIDGIN_TYPE_BLIST_THEME            (pidgin_blist_theme_get_type ())
  41 #define PIDGIN_BLIST_THEME(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistTheme))
  42 #define PIDGIN_BLIST_THEME_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))
  43 #define PIDGIN_IS_BLIST_THEME(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PIDGIN_TYPE_BLIST_THEME))
  44 #define PIDGIN_IS_BLIST_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME))
  45 #define PIDGIN_BLIST_THEME_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))
  46
  47 #define PIDGIN_TYPE_THEME_FONT             (pidgin_theme_font_get_type())
  48
  49 #define PIDGIN_TYPE_BLIST_LAYOUT           (pidgin_blist_layout_get_type())
  50
  51 /**
  52  * PidginBlistTheme:
  53  *
  54  * A pidgin buddy list theme.
  55  * This is an object for Purple to represent a buddy list theme.
  56  *
  57  * PidginBlistTheme is a PurpleTheme Object.
  58  */
  59 struct _PidginBlistTheme
  60 {
  61         PurpleTheme parent;
  62 };
  63
  64 struct _PidginBlistThemeClass
  65 {
  66         PurpleThemeClass parent_class;
  67 };
  68
  69 typedef struct _PidginThemeFont PidginThemeFont;
  70
  71 typedef struct _PidginBlistLayout PidginBlistLayout;
  72
  73 struct _PidginBlistLayout
  74 {
  75         gint status_icon;
  76         gint text;
  77         gint emblem;
  78         gint protocol_icon;
  79         gint buddy_icon;
  80         gboolean show_status;
  81
  82 };
  83
  84 G_BEGIN_DECLS
  85
  86 /**************************************************************************/
  87 /* PidginThemeFont API                                                    */
  88 /**************************************************************************/
  89
  90 /**
  91  * pidgin_theme_font_get_type:
  92  *
  93  * Returns: The #GType for the #PidginThemeFont boxed structure.
  94  */
  95 GType pidgin_theme_font_get_type(void);
  96
  97 /**
  98  * pidgin_theme_font_new:
  99  * @face:  The font face
 100  * @color: The color of the font
 101  *
 102  * Create a new PidginThemeFont.
 103  *
 104  * Returns: A newly created PidginThemeFont
 105  */
 106 PidginThemeFont *pidgin_theme_font_new(const gchar *face, GdkRGBA *color);
 107
 108 /**
 109  * pidgin_theme_font_free:
 110  * @font: The theme font
 111  *
 112  * Frees a font and color pair
 113  */
 114 void pidgin_theme_font_free(PidginThemeFont *font);
 115
 116 /**
 117  * pidgin_theme_font_set_font_face:
 118  * @font:  The PidginThemeFont
 119  * @face:  The font-face
 120  *
 121  * Set the font-face of a PidginThemeFont.
 122  */
 123 void pidgin_theme_font_set_font_face(PidginThemeFont *font, const gchar *face);
 124
 125 /**
 126  * pidgin_theme_font_set_color:
 127  * @font:  The PidginThemeFont
 128  * @color: The color
 129  *
 130  * Set the color of a PidginThemeFont.
 131  */
 132 void pidgin_theme_font_set_color(PidginThemeFont *font, const GdkRGBA *color);
 133
 134 /**
 135  * pidgin_theme_font_get_font_face:
 136  * @font:  The PidginThemeFont
 137  *
 138  * Get the font-face of a PidginThemeFont.
 139  *
 140  * Returns: The font-face, or NULL if none is set.
 141  */
 142 const gchar * pidgin_theme_font_get_font_face(PidginThemeFont *font);
 143
 144 /**
 145  * pidgin_theme_font_get_color:
 146  * @font:  The PidginThemeFont
 147  *
 148  * Get the color of a PidginThemeFont as a GdkRGBA object.
 149  *
 150  * Returns: The color, or NULL if none is set.
 151  */
 152 const GdkRGBA *pidgin_theme_font_get_color(PidginThemeFont *font);
 153
 154 /**
 155  * pidgin_theme_font_get_color_describe:
 156  * @font:  The PidginThemeFont
 157  *
 158  * Get the color of a PidginThemeFont.
 159  *
 160  * Returns: The color, or NULL if none is set.
 161  */
 162 const gchar * pidgin_theme_font_get_color_describe(PidginThemeFont *font);
 163
 164 /**************************************************************************/
 165 /* Purple Buddy List Theme API                                            */
 166 /**************************************************************************/
 167
 168 /**
 169  * pidgin_blist_theme_get_type:
 170  *
 171  * Returns: The #GType for a blist theme.
 172  */
 173 GType pidgin_blist_theme_get_type(void);
 174
 175 /**
 176  * pidgin_blist_layout_get_type:
 177  *
 178  * Returns: The #GType for the #PidginBlistLayout boxed structure.
 179  */
 180 GType pidgin_blist_layout_get_type(void);
 181
 182 /* get methods */
 183
 184 /**
 185  * pidgin_blist_theme_get_background_color:
 186  * @theme:  The PidginBlist theme.
 187  *
 188  * Returns the background color of the buddy list.
 189  *
 190  * Returns: A gdk color.
 191  */
 192 GdkRGBA *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
 193
 194 /**
 195  * pidgin_blist_theme_get_opacity:
 196  * @theme:  The PidginBlist theme.
 197  *
 198  * Returns the opacity of the buddy list window
 199  * (0.0 or clear to 1.0 fully opaque).
 200  *
 201  * Returns: The opacity
 202  */
 203 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
 204
 205 /**
 206  * pidgin_blist_theme_get_layout:
 207  * @theme:  The PidginBlist theme.
 208  *
 209  * Returns the layout to be used with the buddy list.
 210  *
 211  * Returns: The buddy list layout.
 212  */
 213 PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
 214
 215 /**
 216  * pidgin_blist_theme_get_expanded_background_color:
 217  * @theme:  The PidginBlist theme.
 218  *
 219  * Returns the background color to be used with expanded groups.
 220  *
 221  * Returns: A gdk color.
 222  */
 223 GdkRGBA *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
 224
 225 /**
 226  * pidgin_blist_theme_get_expanded_text_info:
 227  * @theme:  The PidginBlist theme.
 228  *
 229  * Returns the text font and color to be used with expanded groups.
 230  *
 231  * Returns: A font and color pair.
 232  */
 233 PidginThemeFont *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
 234
 235 /**
 236  * pidgin_blist_theme_get_collapsed_background_color:
 237  * @theme:  The PidginBlist theme.
 238  *
 239  * Returns the background color to be used with collapsed groups.
 240  *
 241  * Returns: A gdk color.
 242  */
 243 GdkRGBA *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
 244
 245 /**
 246  * pidgin_blist_theme_get_collapsed_text_info:
 247  * @theme:  The PidginBlist theme.
 248  *
 249  * Returns the text font and color to be used with collapsed groups.
 250  *
 251  * Returns: A font and color pair.
 252  */
 253 PidginThemeFont *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
 254
 255 /**
 256  * pidgin_blist_theme_get_contact_color:
 257  * @theme:  The PidginBlist theme.
 258  *
 259  * Returns the colors to be used for contacts and chats.
 260  *
 261  * Returns: A gdkcolor for contacts and chats.
 262  */
 263 GdkRGBA *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme);
 264
 265 /**
 266  * pidgin_blist_theme_get_contact_text_info:
 267  * @theme:  The PidginBlist theme.
 268  *
 269  * Returns the text font and color to be used for expanded contacts.
 270  *
 271  * Returns: A font and color pair.
 272  */
 273 PidginThemeFont *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
 274
 275 /**
 276  * pidgin_blist_theme_get_online_text_info:
 277  * @theme:  The PidginBlist theme.
 278  *
 279  * Returns the text font and color to be used for online buddies.
 280  *
 281  * Returns: A font and color pair.
 282  */
 283 PidginThemeFont *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
 284
 285 /**
 286  * pidgin_blist_theme_get_away_text_info:
 287  * @theme:  The PidginBlist theme.
 288  *
 289  * Returns the text font and color to be used for away and idle buddies.
 290  *
 291  * Returns: A font and color pair.
 292  */
 293 PidginThemeFont *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
 294
 295 /**
 296  * pidgin_blist_theme_get_offline_text_info:
 297  * @theme:  The PidginBlist theme.
 298  *
 299  * Returns the text font and color to be used for offline buddies.
 300  *
 301  * Returns: A font and color pair.
 302  */
 303 PidginThemeFont *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
 304
 305 /**
 306  * pidgin_blist_theme_get_idle_text_info:
 307  * @theme:  The PidginBlist theme.
 308  *
 309  * Returns the text font and color to be used for idle buddies.
 310  *
 311  * Returns: A font and color pair.
 312  */
 313 PidginThemeFont *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
 314
 315 /**
 316  * pidgin_blist_theme_get_unread_message_text_info:
 317  * @theme:  The PidginBlist theme.
 318  *
 319  * Returns the text font and color to be used for buddies with unread messages.
 320  *
 321  * Returns: A font and color pair.
 322  */
 323 PidginThemeFont *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme);
 324
 325 /**
 326  * pidgin_blist_theme_get_unread_message_nick_said_text_info:
 327  * @theme:  The PidginBlist theme.
 328  *
 329  * Returns the text font and color to be used for chats with unread messages
 330  * that mention your nick.
 331  *
 332  * Returns: A font and color pair.
 333  */
 334 PidginThemeFont *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme);
 335
 336 /**
 337  * pidgin_blist_theme_get_status_text_info:
 338  * @theme:  The PidginBlist theme.
 339  *
 340  * Returns the text font and color to be used for a buddy's status message.
 341  *
 342  * Returns: A font and color pair.
 343  */
 344 PidginThemeFont *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme);
 345
 346 /* Set Methods */
 347
 348 /**
 349  * pidgin_blist_theme_set_background_color:
 350  * @theme:  The PidginBlist theme.
 351  * @color: The new background color.
 352  *
 353  * Sets the background color to be used for this buddy list theme.
 354  */
 355 void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, const GdkRGBA *color);
 356
 357 /**
 358  * pidgin_blist_theme_set_opacity:
 359  * @theme:  The PidginBlist theme.
 360  * @opacity: The new opacity setting.
 361  *
 362  * Sets the opacity to be used for this buddy list theme.
 363  */
 364 void pidgin_blist_theme_set_opacity(PidginBlistTheme *theme, gdouble opacity);
 365
 366 /**
 367  * pidgin_blist_theme_set_layout:
 368  * @theme:  The PidginBlist theme.
 369  * @layout: The new layout.
 370  *
 371  * Sets the buddy list layout to be used for this buddy list theme.
 372  */
 373 void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, const PidginBlistLayout *layout);
 374
 375 /**
 376  * pidgin_blist_theme_set_expanded_background_color:
 377  * @theme:  The PidginBlist theme.
 378  * @color: The new background color.
 379  *
 380  * Sets the background color to be used for expanded groups.
 381  */
 382 void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, const GdkRGBA *color);
 383
 384 /**
 385  * pidgin_blist_theme_set_expanded_text_info:
 386  * @theme:  The PidginBlist theme.
 387  * @pair: The new text font and color pair.
 388  *
 389  * Sets the text color and font to be used for expanded groups.
 390  */
 391 void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 392
 393 /**
 394  * pidgin_blist_theme_set_collapsed_background_color:
 395  * @theme:  The PidginBlist theme.
 396  * @color: The new background color.
 397  *
 398  * Sets the background color to be used for collapsed groups.
 399  */
 400 void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, const GdkRGBA *color);
 401
 402 /**
 403  * pidgin_blist_theme_set_collapsed_text_info:
 404  * @theme:  The PidginBlist theme.
 405  * @pair: The new text font and color pair.
 406  *
 407  * Sets the text color and font to be used for expanded groups.
 408  */
 409 void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 410
 411 /**
 412  * pidgin_blist_theme_set_contact_color:
 413  * @theme:  The PidginBlist theme.
 414  * @color: The color to use for contacts and chats.
 415  *
 416  * Sets the background color to be used for contacts and chats.
 417  */
 418 void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, const GdkRGBA *color);
 419
 420 /**
 421  * pidgin_blist_theme_set_contact_text_info:
 422  * @theme:  The PidginBlist theme.
 423  * @pair: The new text font and color pair.
 424  *
 425  * Sets the text color and font to be used for expanded contacts.
 426  */
 427 void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 428
 429 /**
 430  * pidgin_blist_theme_set_online_text_info:
 431  * @theme:  The PidginBlist theme.
 432  * @pair: The new text font and color pair.
 433  *
 434  * Sets the text color and font to be used for online buddies.
 435  */
 436 void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 437
 438 /**
 439  * pidgin_blist_theme_set_away_text_info:
 440  * @theme:  The PidginBlist theme.
 441  * @pair: The new text font and color pair.
 442  *
 443  * Sets the text color and font to be used for away and idle buddies.
 444  */
 445 void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 446
 447 /**
 448  * pidgin_blist_theme_set_offline_text_info:
 449  * @theme:  The PidginBlist theme.
 450  * @pair: The new text font and color pair.
 451  *
 452  * Sets the text color and font to be used for offline buddies.
 453  */
 454 void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 455
 456 /**
 457  * pidgin_blist_theme_set_idle_text_info:
 458  * @theme:  The PidginBlist theme.
 459  * @pair: The new text font and color pair.
 460  *
 461  * Sets the text color and font to be used for idle buddies.
 462  */
 463 void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 464
 465 /**
 466  * pidgin_blist_theme_set_unread_message_text_info:
 467  * @theme:  The PidginBlist theme.
 468  * @pair: The new text font and color pair.
 469  *
 470  * Sets the text color and font to be used for buddies with unread messages.
 471  */
 472 void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 473
 474 /**
 475  * pidgin_blist_theme_set_unread_message_nick_said_text_info:
 476  * @theme:  The PidginBlist theme.
 477  * @pair: The new text font and color pair.
 478  *
 479  * Sets the text color and font to be used for a chat with unread messages
 480  * that mention your nick.
 481  */
 482 void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 483
 484 /**
 485  * pidgin_blist_theme_set_status_text_info:
 486  * @theme:  The PidginBlist theme.
 487  * @pair: The new text font and color pair.
 488  *
 489  * Sets the text color and font to be used for buddy status messages.
 490  */
 491 void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 492
 493 G_END_DECLS
 494
 495 #endif /* PIDGIN_BLIST_THEME_H */