finch/gntplugin.h

   1 /* finch
   2  *
   3  * Finch is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   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, MA  02111-1301  USA
  20  */
  21
  22 #ifndef _GNT_PLUGIN_H
  23 #define _GNT_PLUGIN_H
  24 /**
  25  * SECTION:gntplugin
  26  * @section_id: finch-gntplugin
  27  * @short_description: <filename>gntplugin.h</filename>
  28  * @title: Plugin API
  29  */
  30
  31 #include <gnt.h>
  32
  33 #include <plugins.h>
  34 #include <pluginpref.h>
  35
  36 #include <string.h>
  37
  38 #include "finch.h"
  39
  40 #define FINCH_TYPE_PLUGIN_INFO             (finch_plugin_info_get_type())
  41 #define FINCH_PLUGIN_INFO(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfo))
  42 #define FINCH_PLUGIN_INFO_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfoClass))
  43 #define FINCH_IS_PLUGIN_INFO(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), FINCH_TYPE_PLUGIN_INFO))
  44 #define FINCH_IS_PLUGIN_INFO_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), FINCH_TYPE_PLUGIN_INFO))
  45 #define FINCH_PLUGIN_INFO_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfoClass))
  46
  47 typedef struct _FinchPluginInfo FinchPluginInfo;
  48 typedef struct _FinchPluginInfoClass FinchPluginInfoClass;
  49
  50 typedef GntWidget* (*FinchPluginPrefFrameCb) (void);
  51
  52 /**
  53  * FinchPluginInfo:
  54  *
  55  * Extends #PurplePluginInfo to hold UI information for finch.
  56  */
  57 struct _FinchPluginInfo {
  58         PurplePluginInfo parent;
  59 };
  60
  61 /**
  62  * FinchPluginInfoClass:
  63  *
  64  * The base class for all #FinchPluginInfo's.
  65  */
  66 struct _FinchPluginInfoClass {
  67         PurplePluginInfoClass parent_class;
  68
  69         /*< private >*/
  70         void (*_gnt_reserved1)(void);
  71         void (*_gnt_reserved2)(void);
  72         void (*_gnt_reserved3)(void);
  73         void (*_gnt_reserved4)(void);
  74 };
  75
  76 /**********************************************************************
  77  * Plugin Info API
  78  **********************************************************************/
  79
  80 /**
  81  * finch_plugin_info_get_type:
  82  *
  83  * Returns: The #GType for the #FinchPluginInfo object.
  84  */
  85 GType finch_plugin_info_get_type(void);
  86
  87 /**
  88  * finch_plugin_info_new:
  89  * @first_property:  The first property name
  90  * @...:  The value of the first property, followed optionally by more
  91  *             name/value pairs, followed by %NULL
  92  *
  93  * Creates a new #FinchPluginInfo instance to be returned from
  94  * #plugin_query of a finch plugin, using the provided name/value
  95  * pairs.
  96  *
  97  * See purple_plugin_info_new() for a list of available property names.
  98  * Additionally, you can provide the property
  99  * <literal>"gnt-pref-frame-cb"</literal>, which should be a callback that
 100  * returns a #GntWidget for the plugin's preferences
 101  * (see #FinchPluginPrefFrameCb).
 102  *
 103  * See purple_plugin_info_new().
 104  *
 105  * Returns: A new #FinchPluginInfo instance.
 106  */
 107 FinchPluginInfo *finch_plugin_info_new(const char *first_property, ...)
 108                  G_GNUC_NULL_TERMINATED;
 109
 110 /**********************************************************************
 111  * GNT Plugins API
 112  **********************************************************************/
 113
 114 /**
 115  * finch_plugins_show_all:
 116  *
 117  * Show a list of plugins.
 118  */
 119 void finch_plugins_show_all(void);
 120
 121 /**
 122  * finch_plugins_save_loaded:
 123  *
 124  * Save the list of loaded plugins.
 125  */
 126 void finch_plugins_save_loaded(void);
 127
 128 #endif