Pileus Git - grits/blob - src/gis-plugin.h

   1 /*
   2  * Copyright (C) 2009-2010 Andy Spencer <andy753421@gmail.com>
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef __GIS_PLUGIN_H__
  19 #define __GIS_PLUGIN_H__
  20
  21 #include <glib-object.h>
  22 #include <gtk/gtk.h>
  23
  24 #define GIS_TYPE_PLUGIN                (gis_plugin_get_type())
  25 #define GIS_PLUGIN(obj)                (G_TYPE_CHECK_INSTANCE_CAST   ((obj),  GIS_TYPE_PLUGIN, GisPlugin))
  26 #define GIS_IS_PLUGIN(obj)             (G_TYPE_CHECK_INSTANCE_TYPE   ((obj),  GIS_TYPE_PLUGIN))
  27 #define GIS_PLUGIN_GET_INTERFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE((inst), GIS_TYPE_PLUGIN, GisPluginInterface))
  28
  29 typedef struct _GisPlugin          GisPlugin;
  30 typedef struct _GisPluginInterface GisPluginInterface;
  31 typedef struct _GisPlugins         GisPlugins;
  32
  33 struct _GisPluginInterface
  34 {
  35         GTypeInterface parent_iface;
  36
  37         /* Virtual data */
  38         const gchar *name;
  39         const gchar *description;
  40
  41         /* Virtual functions */
  42         GtkWidget *(*get_config)(GisPlugin *plugin);
  43 };
  44
  45 GType gis_plugin_get_type();
  46
  47 /* Methods */
  48 const gchar *gis_plugin_get_name(GisPlugin *plugin);
  49
  50 const gchar *gis_plugin_get_description(GisPlugin *plugin);
  51
  52 GtkWidget *gis_plugin_get_config(GisPlugin *plugin);
  53
  54 /* Plugins API */
  55 #include "gis-viewer.h"
  56 #include "gis-prefs.h"
  57
  58 struct _GisPlugins {
  59         gchar    *dir;
  60         GList    *plugins;
  61         GisPrefs *prefs;
  62 };
  63
  64 typedef GisPlugin *(*GisPluginConstructor)(GisViewer *viewer, GisPrefs *prefs);
  65
  66 GisPlugins *gis_plugins_new(const gchar *dir, GisPrefs *prefs);
  67
  68 void gis_plugins_free();
  69
  70 GList *gis_plugins_available(GisPlugins *plugins);
  71
  72 GisPlugin *gis_plugins_load(GisPlugins *plugins, const char *name,
  73                 GisViewer *viewer, GisPrefs *prefs);
  74
  75 GisPlugin *gis_plugins_enable(GisPlugins *plugin, const char *name,
  76                 GisViewer *viewer, GisPrefs *prefs);
  77
  78 GList *gis_plugins_load_enabled(GisPlugins *plugin,
  79                 GisViewer *viewer, GisPrefs *prefs);
  80
  81 gboolean gis_plugins_disable(GisPlugins *plugin, const char *name);
  82
  83 gboolean gis_plugins_unload(GisPlugins *plugins, const char *name);
  84
  85 void gis_plugins_foreach(GisPlugins *plugins, GCallback callback, gpointer user_data);
  86
  87 #endif