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