FarsightPlugin

FarsightPlugin — A class for defining Farsight plugins

Synopsis




                    FarsightPluginInfo;
                    FarsightPlugin;
                    FarsightPluginClass;
#define             FARSIGHT_INIT_PLUGIN                (initfunc, plugininfo)
GObject*            farsight_plugin_create              (const gchar *name,
                                                         const gchar *type_suffix,
                                                         FarsightPlugin **pluginptr);
const gchar*        farsight_plugin_get_name            (FarsightPlugin *plugin);
const gchar*        farsight_plugin_get_description     (FarsightPlugin *plugin);
const gchar*        farsight_plugin_get_version         (FarsightPlugin *plugin);
const gchar*        farsight_plugin_get_author          (FarsightPlugin *plugin);
const gchar*        farsight_plugin_get_homepage        (FarsightPlugin *plugin);

Object Hierarchy


  GObject
   +----GTypeModule
         +----FarsightPlugin

Implemented Interfaces

FarsightPlugin implements GTypePlugin.

Description

Details

FarsightPluginInfo

typedef struct {
  guint major_version;          /* major version of core that plugin was compiled for */
  guint minor_version;          /* minor version of core that plugin was compiled for */
 
  gchar *description;           /* description of plugin */
  gchar *version;               /* version of the plugin */
  gchar *author;                /* author of the plugin */
  gchar *homepage;              /* homepage of the plugin */

  /* callbacks */
  /* This function is called when the last instance of the plugin is
   * unloaded. It can be useful to deallocate resources common for all
   * instances of the plugin. */
  void (*unload) (FarsightPlugin * plugin);
  /* This function is called to generate a new object of the type used by the 
     plugin */
  GObject* (*new_) (void);
} FarsightPluginInfo;

FarsightPlugin

typedef struct _FarsightPlugin FarsightPlugin;

FarsightPluginClass

typedef struct {
  GTypeModuleClass parent_class;
} FarsightPluginClass;

FARSIGHT_INIT_PLUGIN()

#define             FARSIGHT_INIT_PLUGIN(initfunc, plugininfo)

initfunc :

plugininfo :

farsight_plugin_create ()

GObject*            farsight_plugin_create              (const gchar *name,
                                                         const gchar *type_suffix,
                                                         FarsightPlugin **pluginptr);

Loads the appropriate plugin if necessary and creates a GObject of the requested type

name :

 The name of the plugin to load

type_suffix :

 The type of plugin to load (normally "session" or "transmitter"

pluginptr :

 A pointer to the location where a pointer to the FarsightPlugin used can be stored

Returns :

 the created GObject, or NULL if it fails

farsight_plugin_get_name ()

const gchar*        farsight_plugin_get_name            (FarsightPlugin *plugin);

Returns the name of the given plugin plugin.

plugin :

 a FarsightPlugin to get it's name

Returns :

 a string to the name of the plugin, NULL if invalid.

farsight_plugin_get_description ()

const gchar*        farsight_plugin_get_description     (FarsightPlugin *plugin);

Returns the description of the given plugin plugin.

plugin :

 a FarsightPlugin to get it's description

Returns :

 a string containing the description, NULL if invalid.

farsight_plugin_get_version ()

const gchar*        farsight_plugin_get_version         (FarsightPlugin *plugin);

Returns the version of the given plugin plugin.

plugin :

 a FarsightPlugin to get it's version

Returns :

 a string containing the version, NULL if invalid.

farsight_plugin_get_author ()

const gchar*        farsight_plugin_get_author          (FarsightPlugin *plugin);

Returns the author of the given plugin plugin.

plugin :

 a FarsightPlugin to get it's author

Returns :

 a string containing the author, NULL if invalid.

farsight_plugin_get_homepage ()

const gchar*        farsight_plugin_get_homepage        (FarsightPlugin *plugin);

Returns the homepage of the given plugin plugin.

plugin :

 a FarsightPlugin to get it's homepage

Returns :

 a string containing the homepage, NULL if invalid.