diff libpurple/pluginpref.h @ 15823:32c366eeeb99

sed -ie 's/gaim/purple/g'
author Sean Egan <seanegan@gmail.com>
date Mon, 19 Mar 2007 07:01:17 +0000
parents 5fe8042783c1
children 44b4e8bd759b
line wrap: on
line diff
--- a/libpurple/pluginpref.h	Mon Mar 19 06:11:46 2007 +0000
+++ b/libpurple/pluginpref.h	Mon Mar 19 07:01:17 2007 +0000
@@ -2,9 +2,9 @@
  * @file pluginpref.h Plugin Preferences API
  * @ingroup core
  *
- * gaim
+ * purple
  *
- * Gaim is the legal property of its developers, whose names are too numerous
+ * Purple is the legal property of its developers, whose names are too numerous
  * to list here.  Please refer to the COPYRIGHT file distributed with this
  * source distribution.
  *
@@ -23,28 +23,28 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
-#ifndef _GAIM_PLUGINPREF_H_
-#define _GAIM_PLUGINPREF_H_
+#ifndef _PURPLE_PLUGINPREF_H_
+#define _PURPLE_PLUGINPREF_H_
 
-typedef struct _GaimPluginPrefFrame		GaimPluginPrefFrame;
-typedef struct _GaimPluginPref			GaimPluginPref;
+typedef struct _PurplePluginPrefFrame		PurplePluginPrefFrame;
+typedef struct _PurplePluginPref			PurplePluginPref;
 
 /**
  * String format for preferences.
  */
 typedef enum
 {
-	GAIM_STRING_FORMAT_TYPE_NONE      = 0,
-	GAIM_STRING_FORMAT_TYPE_MULTILINE = 1 << 0,
-	GAIM_STRING_FORMAT_TYPE_HTML      = 1 << 1
-} GaimStringFormatType;
+	PURPLE_STRING_FORMAT_TYPE_NONE      = 0,
+	PURPLE_STRING_FORMAT_TYPE_MULTILINE = 1 << 0,
+	PURPLE_STRING_FORMAT_TYPE_HTML      = 1 << 1
+} PurpleStringFormatType;
 
 typedef enum {
-	GAIM_PLUGIN_PREF_NONE,
-	GAIM_PLUGIN_PREF_CHOICE,
-	GAIM_PLUGIN_PREF_INFO,   /**< no-value label */
-	GAIM_PLUGIN_PREF_STRING_FORMAT
-} GaimPluginPrefType;
+	PURPLE_PLUGIN_PREF_NONE,
+	PURPLE_PLUGIN_PREF_CHOICE,
+	PURPLE_PLUGIN_PREF_INFO,   /**< no-value label */
+	PURPLE_PLUGIN_PREF_STRING_FORMAT
+} PurplePluginPrefType;
 
 #include <glib.h>
 #include "prefs.h"
@@ -61,16 +61,16 @@
 /**
  * Create a new plugin preference frame
  *
- * @return a new GaimPluginPrefFrame
+ * @return a new PurplePluginPrefFrame
  */
-GaimPluginPrefFrame *gaim_plugin_pref_frame_new(void);
+PurplePluginPrefFrame *purple_plugin_pref_frame_new(void);
 
 /**
  * Destroy a plugin preference frame
  *
  * @param frame The plugin frame to destroy
  */
-void gaim_plugin_pref_frame_destroy(GaimPluginPrefFrame *frame);
+void purple_plugin_pref_frame_destroy(PurplePluginPrefFrame *frame);
 
 /**
  * Adds a plugin preference to a plugin preference frame
@@ -78,7 +78,7 @@
  * @param frame The plugin frame to add the preference to
  * @param pref  The preference to add to the frame
  */
-void gaim_plugin_pref_frame_add(GaimPluginPrefFrame *frame, GaimPluginPref *pref);
+void purple_plugin_pref_frame_add(PurplePluginPrefFrame *frame, PurplePluginPref *pref);
 
 /**
  * Get the plugin preferences from a plugin preference frame
@@ -86,46 +86,46 @@
  * @param frame The plugin frame to get the plugin preferences from
  * @return a GList of plugin preferences
  */
-GList *gaim_plugin_pref_frame_get_prefs(GaimPluginPrefFrame *frame);
+GList *purple_plugin_pref_frame_get_prefs(PurplePluginPrefFrame *frame);
 
 /**
  * Create a new plugin preference
  *
- * @return a new GaimPluginPref
+ * @return a new PurplePluginPref
  */
-GaimPluginPref *gaim_plugin_pref_new(void);
+PurplePluginPref *purple_plugin_pref_new(void);
 
 /**
  * Create a new plugin preference with name
  *
  * @param name The name of the pref
- * @return a new GaimPluginPref
+ * @return a new PurplePluginPref
  */
-GaimPluginPref *gaim_plugin_pref_new_with_name(const char *name);
+PurplePluginPref *purple_plugin_pref_new_with_name(const char *name);
 
 /**
  * Create a new plugin preference with label
  *
  * @param label The label to be displayed
- * @return a new GaimPluginPref
+ * @return a new PurplePluginPref
  */
-GaimPluginPref *gaim_plugin_pref_new_with_label(const char *label);
+PurplePluginPref *purple_plugin_pref_new_with_label(const char *label);
 
 /**
  * Create a new plugin preference with name and label
  *
  * @param name  The name of the pref
  * @param label The label to be displayed
- * @return a new GaimPluginPref
+ * @return a new PurplePluginPref
  */
-GaimPluginPref *gaim_plugin_pref_new_with_name_and_label(const char *name, const char *label);
+PurplePluginPref *purple_plugin_pref_new_with_name_and_label(const char *name, const char *label);
 
 /**
  * Destroy a plugin preference
  *
  * @param pref The preference to destroy
  */
-void gaim_plugin_pref_destroy(GaimPluginPref *pref);
+void purple_plugin_pref_destroy(PurplePluginPref *pref);
 
 /**
  * Set a plugin pref name
@@ -133,7 +133,7 @@
  * @param pref The plugin pref
  * @param name The name of the pref
  */
-void gaim_plugin_pref_set_name(GaimPluginPref *pref, const char *name);
+void purple_plugin_pref_set_name(PurplePluginPref *pref, const char *name);
 
 /**
  * Get a plugin pref name
@@ -141,7 +141,7 @@
  * @param pref The plugin pref
  * @return The name of the pref
  */
-const char *gaim_plugin_pref_get_name(GaimPluginPref *pref);
+const char *purple_plugin_pref_get_name(PurplePluginPref *pref);
 
 /**
  * Set a plugin pref label
@@ -149,7 +149,7 @@
  * @param pref  The plugin pref
  * @param label The label for the plugin pref
  */
-void gaim_plugin_pref_set_label(GaimPluginPref *pref, const char *label);
+void purple_plugin_pref_set_label(PurplePluginPref *pref, const char *label);
 
 /**
  * Get a plugin pref label
@@ -157,7 +157,7 @@
  * @param pref The plugin pref
  * @return The label for the plugin pref
  */
-const char *gaim_plugin_pref_get_label(GaimPluginPref *pref);
+const char *purple_plugin_pref_get_label(PurplePluginPref *pref);
 
 /**
  * Set the bounds for an integer pref
@@ -166,7 +166,7 @@
  * @param min  The min value
  * @param max  The max value
  */
-void gaim_plugin_pref_set_bounds(GaimPluginPref *pref, int min, int max);
+void purple_plugin_pref_set_bounds(PurplePluginPref *pref, int min, int max);
 
 /**
  * Get the bounds for an integer pref
@@ -175,7 +175,7 @@
  * @param min  The min value
  * @param max  The max value
  */
-void gaim_plugin_pref_get_bounds(GaimPluginPref *pref, int *min, int *max);
+void purple_plugin_pref_get_bounds(PurplePluginPref *pref, int *min, int *max);
 
 /**
  * Set the type of a plugin pref
@@ -183,7 +183,7 @@
  * @param pref The plugin pref
  * @param type The type
  */
-void gaim_plugin_pref_set_type(GaimPluginPref *pref, GaimPluginPrefType type);
+void purple_plugin_pref_set_type(PurplePluginPref *pref, PurplePluginPrefType type);
 
 /**
  * Get the type of a plugin pref
@@ -191,7 +191,7 @@
  * @param pref The plugin pref
  * @return The type
  */
-GaimPluginPrefType gaim_plugin_pref_get_type(GaimPluginPref *pref);
+PurplePluginPrefType purple_plugin_pref_get_type(PurplePluginPref *pref);
 
 /**
  * Set the choices for a choices plugin pref
@@ -200,7 +200,7 @@
  * @param label The label for the choice
  * @param choice  A gpointer of the choice
  */
-void gaim_plugin_pref_add_choice(GaimPluginPref *pref, const char *label, gpointer choice);
+void purple_plugin_pref_add_choice(PurplePluginPref *pref, const char *label, gpointer choice);
 
 /**
  * Get the choices for a choices plugin pref
@@ -208,7 +208,7 @@
  * @param pref The plugin pref
  * @return GList of the choices 
  */
-GList *gaim_plugin_pref_get_choices(GaimPluginPref *pref);
+GList *purple_plugin_pref_get_choices(PurplePluginPref *pref);
 
 /**
  * Set the max length for a string plugin pref
@@ -216,7 +216,7 @@
  * @param pref       The plugin pref
  * @param max_length The max length of the string
  */
-void gaim_plugin_pref_set_max_length(GaimPluginPref *pref, unsigned int max_length);
+void purple_plugin_pref_set_max_length(PurplePluginPref *pref, unsigned int max_length);
 
 /**
  * Get the max length for a string plugin pref
@@ -224,7 +224,7 @@
  * @param pref The plugin pref
  * @return the max length
  */
-unsigned int gaim_plugin_pref_get_max_length(GaimPluginPref *pref);
+unsigned int purple_plugin_pref_get_max_length(PurplePluginPref *pref);
 
 /**
  * Sets the masking of a string plugin pref
@@ -232,7 +232,7 @@
  * @param pref The plugin pref
  * @param mask The value to set
  */
-void gaim_plugin_pref_set_masked(GaimPluginPref *pref, gboolean mask);
+void purple_plugin_pref_set_masked(PurplePluginPref *pref, gboolean mask);
 
 /**
  * Gets the masking of a string plugin pref
@@ -240,16 +240,16 @@
  * @param pref The plugin pref
  * @return The masking
  */
-gboolean gaim_plugin_pref_get_masked(GaimPluginPref *pref);
+gboolean purple_plugin_pref_get_masked(PurplePluginPref *pref);
 
 /**
  * Sets the format type for a formattable-string plugin pref. You need to set the
- * pref type to GAIM_PLUGIN_PREF_STRING_FORMAT first before setting the format.
+ * pref type to PURPLE_PLUGIN_PREF_STRING_FORMAT first before setting the format.
  *
  * @param pref	 The plugin pref
  * @param format The format of the string
  */
-void gaim_plugin_pref_set_format_type(GaimPluginPref *pref, GaimStringFormatType format);
+void purple_plugin_pref_set_format_type(PurplePluginPref *pref, PurpleStringFormatType format);
 
 /**
  * Gets the format type of the formattable-string plugin pref.
@@ -257,7 +257,7 @@
  * @param pref The plugin pref
  * @return The format of the pref
  */
-GaimStringFormatType gaim_plugin_pref_get_format_type(GaimPluginPref *pref);
+PurpleStringFormatType purple_plugin_pref_get_format_type(PurplePluginPref *pref);
 
 /*@}*/
 
@@ -265,4 +265,4 @@
 }
 #endif
 
-#endif /* _GAIM_PLUGINPREF_H_ */
+#endif /* _PURPLE_PLUGINPREF_H_ */