diff src/pluginpref.c @ 8713:7024b595b6ae

[gaim-migrate @ 9467] " Expansion from my original protocol prefs to plugin prefs. Things are handled a bit different in this iteration of it, but I have already modified msn and jabber to use it, and included an example plugin to show how to use it. It will also generate pages with doxygen. The example plugin doesn't not contain any translatable strings seeing as we're in the string freeze. And it's an example, whats the point of translating it..? Also, I tweaked the documentation for 2 functions in gtkprefs, gaim_gtk_prefs_dropdown and gaim_gtk_prefs_dropdown_from_list. Nothing major in that, just made it say that the list should be a list of pairs label/value. Also there's 5 new files that will need to be added to cvs: src/pluginpref.h src/pluginpref.c src/gtkpluginpref.h src/gtkpluginpref.c plugins/pluginpref_example.c the tarball already has them structured correctly and contains the diff" --Gary Kramlich - amc_grim and the german translator pointed out that sean missed the novell file for POTFILES.in committer: Tailor Script <[e-mail]>

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/pluginpref.c	Mon Apr 19 21:12:45 2004 +0000
@@ -0,0 +1,290 @@
+/**
+ * gaim
+ *
+ * Gaim 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.
+ *
+ * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
+#include <glib.h>
+
+#include "debug.h"
+#include "internal.h"
+#include "pluginpref.h"
+#include "prefs.h"
+
+struct _GaimPluginPrefFrame {
+	GList *prefs;
+};
+
+struct _GaimPluginPref {
+	char *name;
+	char *label;
+
+	GaimPluginPrefType type;
+
+	int min;
+	int max;
+	GList *choices;
+	unsigned int max_length;
+};
+
+GaimPluginPrefFrame *
+gaim_plugin_pref_frame_new() {
+	GaimPluginPrefFrame *frame;
+
+	frame = g_new0(GaimPluginPrefFrame, 1);
+
+	return frame;
+}
+
+void
+gaim_plugin_pref_frame_destroy(GaimPluginPrefFrame *frame) {
+	GaimPluginPref *pref;
+	GList *l, *ll;
+
+	g_return_if_fail(frame);
+
+	for(l = frame->prefs; l != NULL; l = ll) {
+		ll = l->next;
+
+		pref = (GaimPluginPref *)l->data;
+		gaim_plugin_pref_destroy(pref);
+
+		g_list_free_1(l);
+	}
+
+	frame = NULL;
+}
+
+void
+gaim_plugin_pref_frame_add(GaimPluginPrefFrame *frame, GaimPluginPref *pref) {
+	g_return_if_fail(frame);
+	g_return_if_fail(pref);
+
+	frame->prefs = g_list_append(frame->prefs, (gpointer)pref);
+}
+
+GList *
+gaim_plugin_pref_frame_get_prefs(GaimPluginPrefFrame *frame) {
+	return frame->prefs;
+}
+
+GaimPluginPref *
+gaim_plugin_pref_new() {
+	GaimPluginPref *pref;
+
+	pref = g_new0(GaimPluginPref, 1);
+
+	return pref;
+}
+
+GaimPluginPref *
+gaim_plugin_pref_new_with_name(char *name) {
+	GaimPluginPref *pref;
+
+	g_return_val_if_fail(name, NULL);
+
+	pref = g_new0(GaimPluginPref, 1);
+	pref->name = g_strdup(name);
+
+	return pref;
+}
+
+GaimPluginPref *
+gaim_plugin_pref_new_with_label(char *label) {
+	GaimPluginPref *pref;
+
+	g_return_val_if_fail(label, NULL);
+
+	pref = g_new0(GaimPluginPref, 1);
+	pref->label = g_strdup(label);
+
+	return pref;
+}
+
+GaimPluginPref *
+gaim_plugin_pref_new_with_name_and_label(char *name, char *label) {
+	GaimPluginPref *pref;
+
+	g_return_val_if_fail(name, NULL);
+	g_return_val_if_fail(label, NULL);
+
+	pref = g_new0(GaimPluginPref, 1);
+	pref->name = g_strdup(name);
+	pref->label = g_strdup(label);
+
+	return pref;
+}
+
+void
+gaim_plugin_pref_destroy(GaimPluginPref *pref) {
+	GList *l, *ll;
+
+	g_return_if_fail(pref);
+
+	if(pref->name)
+		g_free(pref->name);
+
+	if(pref->label)
+		g_free(pref->label);
+
+	l = pref->choices;
+	while(l) {
+		ll = l->next;
+
+		g_free(l->data);
+		g_list_free_1(l);
+
+		l = l->next;
+	}
+
+	g_free(pref);
+}
+
+void
+gaim_plugin_pref_set_name(GaimPluginPref *pref, char *name) {
+	g_return_if_fail(pref);
+	g_return_if_fail(name);
+
+	if(pref->name)
+		g_free(pref->name);
+
+	pref->name = g_strdup(name);
+}
+
+char *
+gaim_plugin_pref_get_name(GaimPluginPref *pref) {
+	g_return_val_if_fail(pref, NULL);
+
+	return pref->name;
+}
+
+void
+gaim_plugin_pref_set_label(GaimPluginPref *pref, char *label) {
+	g_return_if_fail(pref);
+	g_return_if_fail(label);
+
+	if(pref->label)
+		g_free(pref->label);
+
+	pref->label = g_strdup(label);
+}
+
+char *
+gaim_plugin_pref_get_label(GaimPluginPref *pref) {
+	g_return_val_if_fail(pref, NULL);
+
+	return pref->label;
+}
+
+void
+gaim_plugin_pref_set_bounds(GaimPluginPref *pref, int min, int max) {
+	int tmp;
+
+	g_return_if_fail(pref);
+	g_return_if_fail(pref->name);
+
+	if(gaim_prefs_get_type(pref->name) != GAIM_PREF_INT) {
+		gaim_debug(GAIM_DEBUG_INFO, "pluginpref",
+				"gaim_plugin_pref_set_bounds: %s is not an integer pref\n",
+				pref->name);
+		return;
+	}
+		
+	if(min > max) {
+		tmp = min;
+		min = max;
+		max = tmp;
+	}
+
+	pref->min = min;
+	pref->max = max;
+}
+
+void gaim_plugin_pref_get_bounds(GaimPluginPref *pref, int *min, int *max) {
+	g_return_if_fail(pref);
+	g_return_if_fail(pref->name);
+
+	if(gaim_prefs_get_type(pref->name) != GAIM_PREF_INT) {
+		gaim_debug(GAIM_DEBUG_INFO, "pluginpref",
+				"gaim_plugin_pref_get_bounds: %s is not an integer pref\n",
+				pref->name);
+		return;
+	}
+
+	*min = pref->min;
+	*max = pref->max;
+}
+
+void
+gaim_plugin_pref_set_type(GaimPluginPref *pref, GaimPluginPrefType type) {
+	g_return_if_fail(pref);
+
+	pref->type = type;
+}
+
+GaimPluginPrefType
+gaim_plugin_pref_get_type(GaimPluginPref *pref) {
+	g_return_val_if_fail(pref, GAIM_PLUGIN_PREF_NONE);
+
+	return pref->type;
+}
+
+void
+gaim_plugin_pref_add_choice(GaimPluginPref *pref, char *label, gpointer choice) {
+	g_return_if_fail(pref);
+	g_return_if_fail(label);
+	g_return_if_fail(choice);
+
+	pref->choices = g_list_append(pref->choices, label);
+	pref->choices = g_list_append(pref->choices, choice);
+}
+
+gpointer
+gaim_plugin_pref_get_choice(GaimPluginPref *pref, unsigned int index) {
+	g_return_val_if_fail(pref, NULL);
+
+	if(index > g_list_length(pref->choices))
+		return NULL;
+
+	return g_list_nth_data(pref->choices, index);
+}
+
+GList *
+gaim_plugin_pref_get_choices(GaimPluginPref *pref) {
+	g_return_val_if_fail(pref, NULL);
+
+	return pref->choices;
+}
+
+void
+gaim_plugin_pref_set_max_length(GaimPluginPref *pref, unsigned int max_length) {
+	g_return_if_fail(pref);
+
+	pref->max_length = max_length;
+}
+
+unsigned int
+gaim_plugin_pref_get_max_length(GaimPluginPref *pref) {
+	g_return_val_if_fail(pref, 0);
+
+	return pref->max_length;
+}