PeasExtensionBase

PeasExtensionBase — Base class for C extensions.

Synopsis

struct              PeasExtensionBase;
struct              PeasExtensionBaseClass;
PeasPluginInfo *    peas_extension_base_get_plugin_info (PeasExtensionBase *extbase);
gchar *             peas_extension_base_get_data_dir    (PeasExtensionBase *extbase);

Object Hierarchy

  GObject
   +----PeasExtensionBase

Properties

  "data-dir"                 gchar*                : Read
  "plugin-info"              PeasPluginInfo*       : Read / Write / Construct Only

Description

PeasExtensionBase can optionally be used as a base class for the extensions of your plugin. By inheriting from it, you will make your extension able to access the related PeasPluginInfo, and especially the location where all the data of your plugin lives.

Non-C extensions will usually not inherit from this class: Python, Seed and GJS plugins automatically get a "plugin_info" attribute that serves the same purpose.

Details

struct PeasExtensionBase

struct PeasExtensionBase;

Base class for C extensions.


struct PeasExtensionBaseClass

struct PeasExtensionBaseClass {
  GObjectClass parent_class;
};

The class structure of PeasExtensionBase.

GObjectClass parent_class;

The parent class.

peas_extension_base_get_plugin_info ()

PeasPluginInfo *    peas_extension_base_get_plugin_info (PeasExtensionBase *extbase);

Get information relative to extbase.

extbase :

A PeasExtensionBase.

Returns :

the PeasPluginInfo relative to the PeasExtensionBase. [transfer none]

peas_extension_base_get_data_dir ()

gchar *             peas_extension_base_get_data_dir    (PeasExtensionBase *extbase);

Get the path of the directory where the plugin should look for its data files.

extbase :

A PeasExtensionBase.

Returns :

A newly allocated string with the path of the directory where the plugin should look for its data files

Property Details

The "data-dir" property

  "data-dir"                 gchar*                : Read

The full path of the directory where the plugin should look for its data files.

Default value: NULL


The "plugin-info" property

  "plugin-info"              PeasPluginInfo*       : Read / Write / Construct Only

Information related to the current plugin.

See Also

PeasPluginInfo