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

   1 /*
   2  * Copyright (C) 2009 Andy Spencer <spenceal@rose-hulman.edu>
   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 GPtrArray                  GisPlugins;
  32
  33 struct _GisPluginInterface
  34 {
  35         GTypeInterface parent_iface;
  36
  37         /* Virtual functions */
  38         void       (*expose    )(GisPlugin *self);
  39         GtkWidget *(*get_config)(GisPlugin *self);
  40 };
  41
  42 GType gis_plugin_get_type();
  43
  44 /* Methods */
  45 void       gis_plugin_expose(GisPlugin *self);
  46 GtkWidget *gis_plugin_get_config(GisPlugin *self);
  47
  48 /* Plugins API */
  49 #include "gis-world.h"
  50 #include "gis-view.h"
  51 #include "gis-opengl.h"
  52 #include "gis-prefs.h"
  53
  54 typedef GisPlugin *(*GisPluginConstructor)(GisWorld *world, GisView *view, GisOpenGL *opengl, GisPrefs *prefs);
  55
  56 GisPlugins *gis_plugins_new();
  57 void        gis_plugins_free();
  58 GList      *gis_plugins_available();
  59 GisPlugin  *gis_plugins_load(GisPlugins *self, const char *name,
  60                 GisWorld *world, GisView *view, GisOpenGL *opengl, GisPrefs *prefs);
  61 gboolean    gis_plugins_unload(GisPlugins *self, const char *name);
  62 void        gis_plugins_foreach(GisPlugins *self, GCallback callback, gpointer user_data);
  63
  64 #endif