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
  32 struct _GisPluginInterface
  33 {
  34         GTypeInterface parent_iface;
  35
  36         /* Virtual data */
  37         const gchar *name;
  38         const gchar *description;
  39
  40         /* Virtual functions */
  41         GtkWidget *(*get_config)(GisPlugin *plugin);
  42 };
  43
  44 GType gis_plugin_get_type();
  45
  46 /* Methods */
  47 const gchar *gis_plugin_get_name(GisPlugin *plugin);
  48
  49 const gchar *gis_plugin_get_description(GisPlugin *plugin);
  50
  51 GtkWidget *gis_plugin_get_config(GisPlugin *plugin);
  52
  53 /* Plugins API */
  54 typedef struct _GisPlugins GisPlugins;
  55
  56 #include "gis-viewer.h"
  57 #include "gis-prefs.h"
  58
  59 typedef GisPlugin *(*GisPluginConstructor)(GisViewer *viewer, GisPrefs *prefs);
  60
  61 struct _GisPlugins {
  62         gchar    *dir;
  63         GList    *plugins;
  64         GisPrefs *prefs;
  65 };
  66
  67 GisPlugins *gis_plugins_new(const gchar *dir, GisPrefs *prefs);
  68
  69 void gis_plugins_free();
  70
  71 GList *gis_plugins_available(GisPlugins *plugins);
  72
  73 GisPlugin *gis_plugins_load(GisPlugins *plugins, const char *name,
  74                 GisViewer *viewer, GisPrefs *prefs);
  75
  76 GisPlugin *gis_plugins_enable(GisPlugins *plugins, const char *name,
  77                 GisViewer *viewer, GisPrefs *prefs);
  78
  79 GList *gis_plugins_load_enabled(GisPlugins *plugins,
  80                 GisViewer *viewer, GisPrefs *prefs);
  81
  82 gboolean gis_plugins_disable(GisPlugins *plugins, const char *name);
  83
  84 gboolean gis_plugins_unload(GisPlugins *plugins, const char *name);
  85
  86 void gis_plugins_foreach(GisPlugins *plugins, GCallback callback, gpointer user_data);
  87
  88 #endif