diff gtk/gtkplugin.h @ 14191:009db0b357b5

This is a hand-crafted commit to migrate across subversion revisions 16854:16861, due to some vagaries of the way the original renames were done. Witness that monotone can do in one revision what svn had to spread across several.
author Ethan Blanton <elb@pidgin.im>
date Sat, 16 Dec 2006 04:59:55 +0000
parents
children 62366c6a10eb
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/gtk/gtkplugin.h	Sat Dec 16 04:59:55 2006 +0000
@@ -0,0 +1,73 @@
+/**
+ * @file gtkplugin.h GTK+ Plugin API
+ * @ingroup gtkui
+ *
+ * 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
+ */
+#ifndef _GAIM_GTKPLUGIN_H_
+#define _GAIM_GTKPLUGIN_H_
+
+#include "gtkgaim.h"
+#include "plugin.h"
+
+typedef struct _GaimGtkPluginUiInfo GaimGtkPluginUiInfo;
+
+/**
+ * A GTK+ UI structure for plugins.
+ */
+struct _GaimGtkPluginUiInfo
+{
+	GtkWidget *(*get_config_frame)(GaimPlugin *plugin);
+
+	int page_num;                                         /**< Reserved */
+};
+
+#define GAIM_GTK_PLUGIN_TYPE "gtk"
+
+#define GAIM_IS_GTK_PLUGIN(plugin) \
+	((plugin)->info != NULL && (plugin)->info->ui_info != NULL && \
+	 !strcmp((plugin)->info->ui_requirement, GAIM_GTK_PLUGIN_TYPE))
+
+#define GAIM_GTK_PLUGIN_UI_INFO(plugin) \
+	((GaimGtkPluginUiInfo *)(plugin)->info->ui_info)
+
+/**
+ * Returns the configuration frame widget for a GTK+ plugin, if one
+ * exists.
+ *
+ * @param plugin The plugin.
+ *
+ * @return The frame, if the plugin is a GTK+ plugin and provides a
+ *         configuration frame.
+ */
+GtkWidget *gaim_gtk_plugin_get_config_frame(GaimPlugin *plugin);
+
+/**
+ * Saves all loaded plugins.
+ */
+void gaim_gtk_plugins_save(void);
+
+/**
+ * Shows the Plugins dialog
+ */
+void gaim_gtk_plugin_dialog_show(void);
+
+#endif /* _GAIM_GTKPLUGIN_H_ */