#include <glib-object.h>
#include <gtk/gtk.h>
+/********************
+ * Plugin interface *
+ ********************/
#define GIS_TYPE_PLUGIN (gis_plugin_get_type())
#define GIS_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIS_TYPE_PLUGIN, GisPlugin))
#define GIS_IS_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIS_TYPE_PLUGIN))
typedef struct _GisPlugin GisPlugin;
typedef struct _GisPluginInterface GisPluginInterface;
-typedef struct _GisPlugins GisPlugins;
struct _GisPluginInterface
{
const gchar *description;
/* Virtual functions */
- GtkWidget *(*get_config)(GisPlugin *self);
+ GtkWidget *(*get_config)(GisPlugin *plugin);
};
GType gis_plugin_get_type();
/* Methods */
-const gchar *gis_plugin_get_name(GisPlugin *self);
+const gchar *gis_plugin_get_name(GisPlugin *plugin);
-const gchar *gis_plugin_get_description(GisPlugin *self);
+const gchar *gis_plugin_get_description(GisPlugin *plugin);
-GtkWidget *gis_plugin_get_config(GisPlugin *self);
+GtkWidget *gis_plugin_get_config(GisPlugin *plugin);
+
+/***************
+ * Plugins API *
+ ***************/
+typedef struct _GisPlugins GisPlugins;
-/* Plugins API */
#include "gis-viewer.h"
#include "gis-prefs.h"
+/**
+ * GisPluginConstructor:
+ * @viewer: the viewer the plugin is associated with
+ * @prefs: preferences the plugin can use for storing informtion
+ *
+ * Create a new instance of a plugin. Each plugin should supply a constructor named
+ * gis_plugin_NAME_new in it's shared object.
+ *
+ * Returns: the new plugin
+ */
+typedef GisPlugin *(*GisPluginConstructor)(GisViewer *viewer, GisPrefs *prefs);
+
struct _GisPlugins {
gchar *dir;
GList *plugins;
GisPrefs *prefs;
};
-typedef GisPlugin *(*GisPluginConstructor)(GisViewer *viewer, GisPrefs *prefs);
-
GisPlugins *gis_plugins_new(const gchar *dir, GisPrefs *prefs);
void gis_plugins_free();
GisPlugin *gis_plugins_load(GisPlugins *plugins, const char *name,
GisViewer *viewer, GisPrefs *prefs);
-GisPlugin *gis_plugins_enable(GisPlugins *self, const char *name,
+GisPlugin *gis_plugins_enable(GisPlugins *plugins, const char *name,
GisViewer *viewer, GisPrefs *prefs);
-GList *gis_plugins_load_enabled(GisPlugins *self,
+GList *gis_plugins_load_enabled(GisPlugins *plugins,
GisViewer *viewer, GisPrefs *prefs);
-gboolean gis_plugins_disable(GisPlugins *self, const char *name);
+gboolean gis_plugins_disable(GisPlugins *plugins, const char *name);
gboolean gis_plugins_unload(GisPlugins *plugins, const char *name);