CodeSlayerPlugin

CodeSlayerPlugin — Represents the plugin.

Synopsis

#include <codeslayer/codeslayer-plugin.h>

struct              CodeSlayerPlugin;
CodeSlayerPlugin *  codeslayer_plugin_new               (void);
const gchar *       codeslayer_plugin_get_lib           (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_set_lib           (CodeSlayerPlugin *plugin,
                                                         const gchar *lib);
const gchar *       codeslayer_plugin_get_version       (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_set_version       (CodeSlayerPlugin *plugin,
                                                         const gchar *version);
const gchar *       codeslayer_plugin_get_name          (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_set_name          (CodeSlayerPlugin *plugin,
                                                         const gchar *name);
const gchar *       codeslayer_plugin_get_description   (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_set_description   (CodeSlayerPlugin *plugin,
                                                         const gchar *description);
const gchar *       codeslayer_plugin_get_authors       (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_set_authors       (CodeSlayerPlugin *plugin,
                                                         const gchar *authors);
const gchar *       codeslayer_plugin_get_copyright     (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_set_copyright     (CodeSlayerPlugin *plugin,
                                                         const gchar *copyright);
const gchar *       codeslayer_plugin_get_website       (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_set_website       (CodeSlayerPlugin *plugin,
                                                         const gchar *website);
gboolean            codeslayer_plugin_is_configurable   (CodeSlayerPlugin *plugin);
gboolean            codeslayer_plugin_get_enabled       (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_set_enabled       (CodeSlayerPlugin *plugin,
                                                         gboolean enabled);
void                codeslayer_plugin_set_data          (CodeSlayerPlugin *plugin,
                                                         GObject *data);
void                codeslayer_plugin_activate          (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_deactivate        (CodeSlayerPlugin *plugin);
void                codeslayer_plugin_configure         (CodeSlayerPlugin *plugin);

Object Hierarchy

  GObject
   +----CodeSlayerPlugin

Properties

  "authors"                  gchar*                : Read / Write
  "copyright"                gchar*                : Read / Write
  "description"              gchar*                : Read / Write
  "enabled"                  gboolean              : Read / Write
  "lib"                      gchar*                : Read / Write
  "name"                     gchar*                : Read / Write
  "version"                  gchar*                : Read / Write
  "website"                  gchar*                : Read / Write

Description

Details

struct CodeSlayerPlugin

struct CodeSlayerPlugin;

codeslayer_plugin_new ()

CodeSlayerPlugin *  codeslayer_plugin_new               (void);

Creates a new CodeSlayerPlugin.

Returns :

 a new CodeSlayerPlugin.

codeslayer_plugin_get_lib ()

const gchar *       codeslayer_plugin_get_lib           (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 the shared library that will be loaded.

codeslayer_plugin_set_lib ()

void                codeslayer_plugin_set_lib           (CodeSlayerPlugin *plugin,
                                                         const gchar *lib);

plugin :

 a CodeSlayerPlugin.

lib :

 the lib to set.

codeslayer_plugin_get_version ()

const gchar *       codeslayer_plugin_get_version       (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 the version of the shared library.

codeslayer_plugin_set_version ()

void                codeslayer_plugin_set_version       (CodeSlayerPlugin *plugin,
                                                         const gchar *version);

plugin :

 a CodeSlayerPlugin.

version :

 the version to set.

codeslayer_plugin_get_name ()

const gchar *       codeslayer_plugin_get_name          (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 the human readable name of the plugin.

codeslayer_plugin_set_name ()

void                codeslayer_plugin_set_name          (CodeSlayerPlugin *plugin,
                                                         const gchar *name);

codeslayer_plugin_get_description ()

const gchar *       codeslayer_plugin_get_description   (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 the plugin description.

codeslayer_plugin_set_description ()

void                codeslayer_plugin_set_description   (CodeSlayerPlugin *plugin,
                                                         const gchar *description);

codeslayer_plugin_get_authors ()

const gchar *       codeslayer_plugin_get_authors       (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 the plugin authors.

codeslayer_plugin_set_authors ()

void                codeslayer_plugin_set_authors       (CodeSlayerPlugin *plugin,
                                                         const gchar *authors);

codeslayer_plugin_get_copyright ()

const gchar *       codeslayer_plugin_get_copyright     (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 the plugin copyright.

codeslayer_plugin_set_copyright ()

void                codeslayer_plugin_set_copyright     (CodeSlayerPlugin *plugin,
                                                         const gchar *copyright);

codeslayer_plugin_get_website ()

const gchar *       codeslayer_plugin_get_website       (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 the plugin website.

codeslayer_plugin_set_website ()

void                codeslayer_plugin_set_website       (CodeSlayerPlugin *plugin,
                                                         const gchar *website);

codeslayer_plugin_is_configurable ()

gboolean            codeslayer_plugin_is_configurable   (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 is TRUE if the plugin can be configured.

codeslayer_plugin_get_enabled ()

gboolean            codeslayer_plugin_get_enabled       (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Returns :

 is TRUE if the plugin is active.

codeslayer_plugin_set_enabled ()

void                codeslayer_plugin_set_enabled       (CodeSlayerPlugin *plugin,
                                                         gboolean enabled);

plugin :

 a CodeSlayerPlugin.

enabled :

 is TRUE if the plugin is active.

codeslayer_plugin_set_data ()

void                codeslayer_plugin_set_data          (CodeSlayerPlugin *plugin,
                                                         GObject *data);

plugin :

 a CodeSlayerPlugin.

data :

 a CodeSlayer object.

codeslayer_plugin_activate ()

void                codeslayer_plugin_activate          (CodeSlayerPlugin *plugin);

Open the library and resolve the symbols.

plugin :

 a CodeSlayerPlugin.

codeslayer_plugin_deactivate ()

void                codeslayer_plugin_deactivate        (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

codeslayer_plugin_configure ()

void                codeslayer_plugin_configure         (CodeSlayerPlugin *plugin);

plugin :

 a CodeSlayerPlugin.

Property Details

The "authors" property

  "authors"                  gchar*                : Read / Write

Authors.

Default value: ""

The "copyright" property

  "copyright"                gchar*                : Read / Write

Copyright.

Default value: ""

The "description" property

  "description"              gchar*                : Read / Write

Description.

Default value: ""

The "enabled" property

  "enabled"                  gboolean              : Read / Write

Whether or not the plugin is enabled.

Default value: TRUE

The "lib" property

  "lib"                      gchar*                : Read / Write

Lib.

Default value: ""

The "name" property

  "name"                     gchar*                : Read / Write

Name.

Default value: ""

The "version" property

  "version"                  gchar*                : Read / Write

Version.

Default value: ""

The "website" property

  "website"                  gchar*                : Read / Write

Website.

Default value: ""

Generated by GTK-Doc V1.18