peas-plugin-info

peas-plugin-info — Information about a plugin.

Synopsis

#define             PEAS_TYPE_PLUGIN_INFO
#define             PEAS_PLUGIN_INFO                    (obj)
                    PeasPluginInfo;
GType               peas_plugin_info_get_type           (void);
gboolean            peas_plugin_info_is_loaded          (PeasPluginInfo *info);
gboolean            peas_plugin_info_is_available       (PeasPluginInfo *info);
const gchar *       peas_plugin_info_get_module_name    (PeasPluginInfo *info);
const gchar *       peas_plugin_info_get_module_dir     (PeasPluginInfo *info);
const gchar *       peas_plugin_info_get_data_dir       (PeasPluginInfo *info);
const gchar *       peas_plugin_info_get_name           (PeasPluginInfo *info);
const gchar *       peas_plugin_info_get_description    (PeasPluginInfo *info);
const gchar **      peas_plugin_info_get_authors        (PeasPluginInfo *info);
const gchar *       peas_plugin_info_get_website        (PeasPluginInfo *info);
const gchar *       peas_plugin_info_get_copyright      (PeasPluginInfo *info);
const gchar *       peas_plugin_info_get_version        (PeasPluginInfo *info);
gint                peas_plugin_info_get_iage           (PeasPluginInfo *info);
const GHashTable *  peas_plugin_info_get_keys           (PeasPluginInfo *info);
void                peas_plugin_info_set_visible        (PeasPluginInfo *info,
                                                         gboolean visible);
gboolean            peas_plugin_info_get_visible        (PeasPluginInfo *info);

Description

A PeasPluginInfo contains all the information available about a plugin.

Details

PEAS_TYPE_PLUGIN_INFO

#define PEAS_TYPE_PLUGIN_INFO   (peas_plugin_info_get_type ())

PEAS_PLUGIN_INFO()

#define PEAS_PLUGIN_INFO(obj)   ((PeasPluginInfo *) (obj))

PeasPluginInfo

typedef struct _PeasPluginInfo PeasPluginInfo;

Boxed type for the information relative to a plugin.


peas_plugin_info_get_type ()

GType               peas_plugin_info_get_type           (void);

Retrieves the GType object which is associated with the PeasPluginInfo class.

Returns :

the GType associated with PeasPluginInfo.

peas_plugin_info_is_loaded ()

gboolean            peas_plugin_info_is_loaded          (PeasPluginInfo *info);

Check if the plugin is loaded.

info :

A PeasPluginInfo.

Returns :

TRUE if the plugin is loaded.

peas_plugin_info_is_available ()

gboolean            peas_plugin_info_is_available       (PeasPluginInfo *info);

Check if the plugin is available. A plugin is marked as not available when there is no loader available to load it, or when there has been an error when trying to load it previously.

info :

A PeasPluginInfo.

Returns :

TRUE if the plugin is available.

peas_plugin_info_get_module_name ()

const gchar *       peas_plugin_info_get_module_name    (PeasPluginInfo *info);

Gets the module name.

info :

A PeasPluginInfo.

Returns :

the module name.

peas_plugin_info_get_module_dir ()

const gchar *       peas_plugin_info_get_module_dir     (PeasPluginInfo *info);

Gets the module directory.

info :

A PeasPluginInfo.

Returns :

the module directory.

peas_plugin_info_get_data_dir ()

const gchar *       peas_plugin_info_get_data_dir       (PeasPluginInfo *info);

Gets the data dir of the plugin.

info :

A PeasPluginInfo.

Returns :

the plugin's data dir.

peas_plugin_info_get_name ()

const gchar *       peas_plugin_info_get_name           (PeasPluginInfo *info);

Gets the name of the plugin.

info :

A PeasPluginInfo.

Returns :

the plugin's name.

peas_plugin_info_get_description ()

const gchar *       peas_plugin_info_get_description    (PeasPluginInfo *info);

Gets the description of the plugin.

info :

A PeasPluginInfo.

Returns :

the plugin's description.

peas_plugin_info_get_authors ()

const gchar **      peas_plugin_info_get_authors        (PeasPluginInfo *info);

Gets a NULL-terminated array of strings with the authors of the plugin.

info :

A PeasPluginInfo.

Returns :

the plugin's author list.

peas_plugin_info_get_website ()

const gchar *       peas_plugin_info_get_website        (PeasPluginInfo *info);

Gets the website of the plugin.

info :

A PeasPluginInfo.

Returns :

the plugin's associated website.

peas_plugin_info_get_copyright ()

const gchar *       peas_plugin_info_get_copyright      (PeasPluginInfo *info);

Gets the copyright of the plugin.

info :

A PeasPluginInfo.

Returns :

the plugin's copyright information.

peas_plugin_info_get_version ()

const gchar *       peas_plugin_info_get_version        (PeasPluginInfo *info);

Gets the version of the plugin.

info :

A PeasPluginInfo.

Returns :

the plugin's version.

peas_plugin_info_get_iage ()

gint                peas_plugin_info_get_iage           (PeasPluginInfo *info);

Gets the interface age of the plugin.

info :

A PeasPluginInfo.

Returns :

the interface age of the plugin or 0 if not known.

peas_plugin_info_get_keys ()

const GHashTable *  peas_plugin_info_get_keys           (PeasPluginInfo *info);

Gets a hash table of string keys present and GValue values, present in the plugin information file, but not handled by libpeas. Note that libpeas only handles booleans and strings, and that strings that are recognised as booleans, as done by g_key_file_get_boolean, will be of boolean type.

info :

A PeasPluginInfo.

Returns :

a GHashTable of string keys and GValue values. Do not free or destroy any data in this hashtable.

peas_plugin_info_set_visible ()

void                peas_plugin_info_set_visible        (PeasPluginInfo *info,
                                                         gboolean visible);

Sets whether the plugin should be visible in the plugin manager.

info :

A PeasPluginInfo.

visible :

visibility of the plugin

peas_plugin_info_get_visible ()

gboolean            peas_plugin_info_get_visible        (PeasPluginInfo *info);

Gets the visibility of the plugin.

info :

A PeasPluginInfo.

Returns :

TRUE if the plugin should be visible, FALSE if not.