diff pidgin/gtkblist-theme.h @ 25402:0c7b74fc558e

Lots of minor whitespace and comment changes: * Removed stray whitespace * Changed a few places that used space indentation to use tabs * Changed some places that used tabs for alignment in the middle of a line of code to use spaces * Use two tabs to indent code that spans more than one line instead of a few tabs and a few spaces in an effort to align the subsequent lines with the initial one * Changed "#ifdef _BLAH_H" to "#ifdef BLAH_H" because an underscore followed by a capital letter is reserved for use by the compiler and system libraries. I also changed the path to the sound theme.xml file from root_node = xmlnode_from_file(dir, "theme.xml", "sound themes", "sound-loader"); to root_node = xmlnode_from_file(dir, "theme.xml", "sound themes", "sound-theme-loader");

--- a/pidgin/gtkblist-theme.h	Sat Jan 24 03:11:09 2009 +0000
+++ b/pidgin/gtkblist-theme.h	Sun Jan 25 22:55:23 2009 +0000
@@ -23,8 +23,8 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
 
-#ifndef _PIDGIN_BLIST_THEME_H_
-#define _PIDGIN_BLIST_THEME_H_
+#ifndef PIDGIN_BLIST_THEME_H
+#define PIDGIN_BLIST_THEME_H
 
 #include <glib.h>
 #include <glib-object.h>
@@ -33,7 +33,6 @@
 #include "theme.h"
 
 /**
- * extends PurpleTheme (theme.h)
  * A pidgin buddy list theme.
  * This is an object for Purple to represent a buddy list theme.
  *
@@ -42,12 +41,12 @@
 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))
+#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 _PidginBlistTheme
 {
@@ -74,12 +73,12 @@
 	gint emblem;
 	gint protocol_icon;
 	gint buddy_icon;
-	gboolean show_status; 
+	gboolean show_status;
 
 } PidginBlistLayout;
 
 /**************************************************************************/
-/** @name FontColorPair API 		                                  */
+/** @name FontColorPair API                                               */
 /**************************************************************************/
 
 /**
@@ -101,101 +100,101 @@
 /* get methods */
 
 /**
- * Returns the background color of the buddy list
+ * Returns the background color of the buddy list.
  *
- * @returns 	a gdk color
+ * @returns A gdk color.
  */
  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)
+ * (0.0 or clear to 1.0 fully opaque).
  *
- * @returns 	the opacity
+ * @returns The opacity
  */
 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
 
 /**
- * Returns the layout to be used with the buddy list
+ * Returns the layout to be used with the buddy list.
  *
- * @returns 	the buddy list layout
+ * @returns The buddy list layout.
  */
  PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
 
 /**
- * Returns the background color to be used with expanded groups
+ * Returns the background color to be used with expanded groups.
  *
- * @returns 	a gdk color
+ * @returns A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used with expanded groups
+ * Returns the text font and color to be used with expanded groups.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the background color to be used with collapsed groups
+ * Returns the background color to be used with collapsed groups.
  *
- * @returns 	a gdk color
+ * @returns A gdk color.
  */
  GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used with collapsed groups
+ * Returns the text font and color to be used with collapsed groups.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the colors to be used for contacts and chats
+ * Returns the colors to be used for contacts and chats.
  *
- * @returns 	a gdkcolor for contacts and chats
+ * @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
+ * Returns the text font and color to be used for expanded contacts.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for online buddies
+ * Returns the text font and color to be used for online buddies.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for away and idle buddies
+ * Returns the text font and color to be used for away and idle buddies.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for offline buddies
+ * Returns the text font and color to be used for offline buddies.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for idle buddies
+ * Returns the text font and color to be used for idle buddies.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
 
 /**
- * Returns the text font and color to be used for buddies with unread messages
+ * Returns the text font and color to be used for buddies with unread messages.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme);
 
@@ -203,131 +202,131 @@
  * Returns the text font and color to be used for chats with unread messages
  * that mention your nick.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *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 
+ * Returns the text font and color to be used for a buddy's status message.
  *
- * @returns 	a font and color pair
+ * @returns A font and color pair.
  */
  FontColorPair *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme);
 
 /* Set Methods */
 
 /**
- * Sets the background color to be used for this buddy list theme
+ * Sets the background color to be used for this buddy list theme.
  *
- * @param color		the new background color
+ * @param color The new background color.
  */
 void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, GdkColor *color);
 
 /**
- * Sets the opacity to be used for this buddy list theme
+ * Sets the opacity to be used for this buddy list theme.
  *
- * @param opacity	the new opacity setting
+ * @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
+ * Sets the buddy list layout to be used for this buddy list theme.
  *
- * @param layout		the new layout
+ * @param layout The new layout.
  */
 void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, PidginBlistLayout *layout);
 
 /**
- * Sets the background color to be used for expanded groups
+ * Sets the background color to be used for expanded groups.
  *
- * @param color		the new background color
+ * @param color The new background color.
  */
 void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, GdkColor *color);
 
 /**
- * Sets the text color and font to be used for expanded groups
+ * Sets the text color and font to be used for expanded groups.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
- * Sets the background color to be used for collapsed groups
+ * Sets the background color to be used for collapsed groups.
  *
- * @param color		the new background color
+ * @param color The new background color.
  */
 void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, GdkColor *color);
 
 /**
- * Sets the text color and font to be used for expanded groups
+ * Sets the text color and font to be used for expanded groups.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
- * Sets the background color to be used for contacts and chats
+ * Sets the background color to be used for contacts and chats.
  *
- * @param color		the color to use for contacts and chats
+ * @param color The color to use for contacts and chats.
  */
 void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, GdkColor *color);
 
 /**
- * Sets the text color and font to be used for expanded contacts
+ * Sets the text color and font to be used for expanded contacts.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
- * Sets the text color and font to be used for online buddies
+ * Sets the text color and font to be used for online buddies.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
- * Sets the text color and font to be used for away and idle buddies
+ * Sets the text color and font to be used for away and idle buddies.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
- * Sets the text color and font to be used for offline buddies
+ * Sets the text color and font to be used for offline buddies.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
- * Sets the text color and font to be used for idle buddies
+ * Sets the text color and font to be used for idle buddies.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
- * Sets the text color and font to be used for buddies with unread messages
+ * Sets the text color and font to be used for buddies with unread messages.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
  * Sets the text color and font to be used for a chat with unread messages
- * that mention your nick
+ * that mention your nick.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 /**
- * Sets the text color and font to be used for buddy status messages
+ * Sets the text color and font to be used for buddy status messages.
  *
- * @param pair		the new text font at color pair
+ * @param pair The new text font at color pair.
  */
 void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, FontColorPair *pair);
 
 G_END_DECLS
-#endif /* _PIDGIN_BLIST_THEME_H_ */
+#endif /* PIDGIN_BLIST_THEME_H */