src/pluginprivate.h

   1 /*
   2  *      pluginprivate.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2009 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   5  *      Copyright 2009 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  *      This program is distributed in the hope that it will be useful,
  13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *      GNU General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License
  18  *      along with this program; if not, write to the Free Software
  19  *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  *      MA 02110-1301, USA.
  21  *
  22  * $Id$
  23  */
  24
  25
  26 #ifndef PLUGINPRIVATE_H
  27 #define PLUGINPRIVATE_H
  28
  29 #include "ui_utils.h"   /* GeanyAutoSeparator */
  30 #include "keybindings.h"        /* GeanyKeyGroup */
  31
  32
  33 typedef struct SignalConnection
  34 {
  35         GObject *object;
  36         gulong  handler_id;
  37 }
  38 SignalConnection;
  39
  40
  41 typedef struct GeanyPluginPrivate
  42 {
  43         GModule                 *module;
  44         gchar                   *filename;                              /* plugin filename (/path/libname.so) */
  45         PluginInfo              info;                           /* plugin name, description, etc */
  46         GeanyPlugin             public;                         /* fields the plugin can read */
  47
  48         void            (*init) (GeanyData *data);                      /* Called when the plugin is enabled */
  49         GtkWidget*      (*configure) (GtkDialog *dialog);       /* plugins configure dialog, optional */
  50         void            (*configure_single) (GtkWidget *parent); /* plugin configure dialog, optional */
  51         void            (*help) (void);                                         /* Called when the plugin should show some help, optional */
  52         void            (*cleanup) (void);                                      /* Called when the plugin is disabled or when Geany exits */
  53
  54         /* extra stuff */
  55         PluginFields    fields;
  56         GeanyKeyGroup   *key_group;
  57         GeanyAutoSeparator      toolbar_separator;
  58         GArray                  *signal_ids;                    /* SignalConnection's to disconnect when unloading */
  59 }
  60 GeanyPluginPrivate;
  61
  62 typedef GeanyPluginPrivate Plugin;      /* shorter alias */
  63
  64
  65 #endif /* PLUGINPRIVATE_H */