diff pidgin/gtkblist-theme.h @ 26817:3912f55a1633

propagate from branch 'im.pidgin.pidgin' (head fbb4fe5da444943eecc76bdcd6c8ba967790b6c8) to branch 'im.pidgin.cpw.darkrain42.xmpp.bosh' (head 601bc627c9430320848361f0ed81c6c4c6ee53e0)

--- a/pidgin/gtkblist-theme.h	Sat Apr 18 18:17:16 2009 +0000
+++ b/pidgin/gtkblist-theme.h	Tue Apr 28 18:43:57 2009 +0000
@@ -59,12 +59,15 @@
 	PurpleThemeClass parent_class;
 };
 
+#if 0
 typedef struct
 {
 	const gchar *font;
 	const gchar *color;
 
-} FontColorPair;
+} PidginThemeFont;
+#endif
+typedef struct _PidginThemeFont PidginThemeFont;
 
 typedef struct
 {
@@ -78,13 +81,68 @@
 } PidginBlistLayout;
 
 /**************************************************************************/
-/** @name FontColorPair API                                               */
+/** @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 free_font_and_color(FontColorPair *pair);
+void pidgin_theme_font_set_font_face(PidginThemeFont *font, const gchar *face);
+
+/**
+ * Set the color of a PidginThemeFont.
+ *
+ * @param font  The PidginThemeFont
+ * @param color The color
+ */
+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                                     */
@@ -102,6 +160,8 @@
 /**
  * Returns the background color of the buddy list.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
@@ -110,6 +170,8 @@
  * Returns the opacity of the buddy list window
  * (0.0 or clear to 1.0 fully opaque).
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns The opacity
  */
 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
@@ -117,6 +179,8 @@
 /**
  * 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);
@@ -124,6 +188,8 @@
 /**
  * Returns the background color to be used with expanded groups.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
@@ -131,13 +197,17 @@
 /**
  * Returns the text font and color to be used with expanded groups.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
- FontColorPair *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
+ 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.
+ *
  * @returns A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
@@ -145,13 +215,17 @@
 /**
  * Returns the text font and color to be used with collapsed groups.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
- FontColorPair *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
+ 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);
@@ -159,65 +233,82 @@
 /**
  * Returns the text font and color to be used for expanded contacts.
  *
+ * @param theme  The PidginBlist theme.
+ *
  * @returns A font and color pair.
  */
- FontColorPair *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
+ 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.
  */
- FontColorPair *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
+ 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.
  */
- FontColorPair *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
+ 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.
  */
- FontColorPair *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
+ 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.
  */
- FontColorPair *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
+ 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.
  */
- FontColorPair *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme);
+ 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.
  */
- FontColorPair *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme);
+ 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.
  */
- FontColorPair *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme);
+ PidginThemeFont *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme);
 
 /* Set Methods */
 
 /**
  * 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);
@@ -225,6 +316,7 @@
 /**
  * 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);
@@ -232,6 +324,7 @@
 /**
  * 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);
@@ -239,6 +332,7 @@
 /**
  * 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);
@@ -246,13 +340,15 @@
 /**
  * Sets the text color and font to be used for expanded groups.
  *
- * @param pair The new text font at color pair.
+ * @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 FontColorPair *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);
@@ -260,13 +356,15 @@
 /**
  * Sets the text color and font to be used for expanded groups.
  *
- * @param pair The new text font at color pair.
+ * @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 FontColorPair *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);
@@ -274,59 +372,67 @@
 /**
  * Sets the text color and font to be used for expanded contacts.
  *
- * @param pair The new text font at color pair.
+ * @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 FontColorPair *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 pair The new text font at color pair.
+ * @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 FontColorPair *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 pair The new text font at color pair.
+ * @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 FontColorPair *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 pair The new text font at color pair.
+ * @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 FontColorPair *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 pair The new text font at color pair.
+ * @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 FontColorPair *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 pair The new text font at color pair.
+ * @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 FontColorPair *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 pair The new text font at color pair.
+ * @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 FontColorPair *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 pair The new text font at color pair.
+ * @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 FontColorPair *pair);
+void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
 
 G_END_DECLS
 #endif /* PIDGIN_BLIST_THEME_H */