* @file gtkblist-theme.h GTK+ Buddy List Theme API * Pidgin is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA #ifndef PIDGIN_BLIST_THEME_H #define PIDGIN_BLIST_THEME_H * A pidgin buddy list theme. * This is an object for Purple to represent a buddy list theme. * PidginBlistTheme is a PurpleTheme Object. typedef struct _PidginBlistTheme PidginBlistTheme; typedef struct _PidginBlistThemeClass PidginBlistThemeClass; #define PIDGIN_TYPE_BLIST_THEME (pidgin_blist_theme_get_type ()) #define PIDGIN_BLIST_THEME(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistTheme)) #define PIDGIN_BLIST_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass)) #define PIDGIN_IS_BLIST_THEME(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PIDGIN_TYPE_BLIST_THEME)) #define PIDGIN_IS_BLIST_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME)) #define PIDGIN_BLIST_THEME_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass)) struct _PidginBlistThemeClass PurpleThemeClass parent_class; typedef struct _PidginThemeFont PidginThemeFont; /**************************************************************************/ /** @name PidginThemeFont API */ /**************************************************************************/ * Create a new PidginThemeFont. * @param face The font face * @param color The color of the font * @return A newly created PidginThemeFont PidginThemeFont * pidgin_theme_font_new(const gchar *face, GdkColor *color); * Frees a font and color pair * @param font The theme font void pidgin_theme_font_free(PidginThemeFont *font); * Set the font-face of a PidginThemeFont. * @param font The PidginThemeFont * @param face The font-face void pidgin_theme_font_set_font_face(PidginThemeFont *font, const gchar *face); * Set the color of a PidginThemeFont. * @param font The PidginThemeFont void pidgin_theme_font_set_color(PidginThemeFont *font, const GdkColor *color); * Get the font-face of a PidginThemeFont. * @param font The PidginThemeFont * @return The font-face, or NULL if none is set. const gchar * pidgin_theme_font_get_font_face(PidginThemeFont *font); * Get the color of a PidginThemeFont as a GdkColor object. * @param font The PidginThemeFont * @return The color, or NULL if none is set. const GdkColor * pidgin_theme_font_get_color(PidginThemeFont *font); * Get the color of a PidginThemeFont. * @param font The PidginThemeFont * @return The color, or NULL if none is set. const gchar * pidgin_theme_font_get_color_describe(PidginThemeFont *font); /**************************************************************************/ /** @name Purple Buddy List Theme API */ /**************************************************************************/ GType pidgin_blist_theme_get_type(void); * Returns the background color of the buddy list. * @param theme The PidginBlist theme. GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme); * Returns the opacity of the buddy list window * (0.0 or clear to 1.0 fully opaque). * @param theme The PidginBlist theme. gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme); * Returns the layout to be used with the buddy list. * @param theme The PidginBlist theme. * @returns The buddy list layout. PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme); * Returns the background color to be used with expanded groups. * @param theme The PidginBlist theme. GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme); * Returns the text font and color to be used with expanded groups. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme); * Returns the background color to be used with collapsed groups. * @param theme The PidginBlist theme. GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme); * Returns the text font and color to be used with collapsed groups. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme); * Returns the colors to be used for contacts and chats. * @param theme The PidginBlist theme. * @returns A gdkcolor for contacts and chats. GdkColor *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme); * Returns the text font and color to be used for expanded contacts. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme); * Returns the text font and color to be used for online buddies. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme); * Returns the text font and color to be used for away and idle buddies. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme); * Returns the text font and color to be used for offline buddies. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme); * Returns the text font and color to be used for idle buddies. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme); * Returns the text font and color to be used for buddies with unread messages. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme); * Returns the text font and color to be used for chats with unread messages * that mention your nick. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme); * Returns the text font and color to be used for a buddy's status message. * @param theme The PidginBlist theme. * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme); * Sets the background color to be used for this buddy list theme. * @param theme The PidginBlist theme. * @param color The new background color. void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, const GdkColor *color); * Sets the opacity to be used for this buddy list theme. * @param theme The PidginBlist theme. * @param opacity The new opacity setting. void pidgin_blist_theme_set_opacity(PidginBlistTheme *theme, gdouble opacity); * Sets the buddy list layout to be used for this buddy list theme. * @param theme The PidginBlist theme. * @param layout The new layout. void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, const PidginBlistLayout *layout); * Sets the background color to be used for expanded groups. * @param theme The PidginBlist theme. * @param color The new background color. void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, const GdkColor *color); * Sets the text color and font to be used for expanded groups. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the background color to be used for collapsed groups. * @param theme The PidginBlist theme. * @param color The new background color. void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, const GdkColor *color); * Sets the text color and font to be used for expanded groups. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the background color to be used for contacts and chats. * @param theme The PidginBlist theme. * @param color The color to use for contacts and chats. void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, const GdkColor *color); * Sets the text color and font to be used for expanded contacts. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the text color and font to be used for online buddies. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the text color and font to be used for away and idle buddies. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the text color and font to be used for offline buddies. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the text color and font to be used for idle buddies. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the text color and font to be used for buddies with unread messages. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the text color and font to be used for a chat with unread messages * that mention your nick. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); * Sets the text color and font to be used for buddy status messages. * @param theme The PidginBlist theme. * @param pair The new text font and color pair. void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair); #endif /* PIDGIN_BLIST_THEME_H */