GfPluginInfo

GfPluginInfo — GfPluginInfo Object API

Synopsis




            GfPluginInfo;
GfPluginInfo* gf_plugin_info_new            (guint32 abi_version,
                                             const gchar *name,
                                             const gchar *version,
                                             const gchar *summary,
                                             const gchar *description,
                                             const gchar *author,
                                             const gchar *website);
GfPluginInfo* gf_plugin_info_copy           (const GfPluginInfo *info);
void        gf_plugin_info_free             (GfPluginInfo *info);
guint32     gf_plugin_info_get_abi_version  (const GfPluginInfo *info);
const gchar* gf_plugin_info_get_name        (const GfPluginInfo *info);
const gchar* gf_plugin_info_get_version     (const GfPluginInfo *info);
const gchar* gf_plugin_info_get_summary     (const GfPluginInfo *info);
const gchar* gf_plugin_info_get_description (const GfPluginInfo *info);
const gchar* gf_plugin_info_get_author      (const GfPluginInfo *info);
const gchar* gf_plugin_info_get_website     (const GfPluginInfo *info);

Description

GfPluginInfo is a boxed structure thats holds information about GfPlugin's.

Details

GfPluginInfo

typedef struct {
	guint32 abi_version;
	gchar *name;
	gchar *version;
	gchar *summary;
	gchar *description;
	gchar *author;
	gchar *website;
} GfPluginInfo;

The boxed structure that holds infromation about a GfPlugin.

guint32 abi_version; The abi version that this plugin was compiled for.
gchar *name; The name of the plugin.
gchar *version; The version of the plugin.
gchar *summary; The summary of the plugin.
gchar *description; The description of the plugin.
gchar *author; The author of the plugin.
gchar *website; The website of the plugin.

gf_plugin_info_new ()

GfPluginInfo* gf_plugin_info_new            (guint32 abi_version,
                                             const gchar *name,
                                             const gchar *version,
                                             const gchar *summary,
                                             const gchar *description,
                                             const gchar *author,
                                             const gchar *website);

Creates a newly allocated GfPluginInfo for the given values.

Note: name must NOT be NULL.

abi_version : The abi version of the plugin.
name : The name of the plugin.
version : The version of the plugin.
summary : The summary of the plugin.
description : The description of the plugin.
author : The author of the plugin.
website : The website of the plugin.
Returns : The newly allocated GfPluginInfo for the given value.

gf_plugin_info_copy ()

GfPluginInfo* gf_plugin_info_copy           (const GfPluginInfo *info);

Copies info.

info : The GfPluginInfo to copy.
Returns : A new copy of info.

gf_plugin_info_free ()

void        gf_plugin_info_free             (GfPluginInfo *info);

Frees info.

info : The GfPluginInfo instance.

gf_plugin_info_get_abi_version ()

guint32     gf_plugin_info_get_abi_version  (const GfPluginInfo *info);

Gets the abi version from info.

info : The GfPluginInfo instance.
Returns : The abi version from info.

gf_plugin_info_get_name ()

const gchar* gf_plugin_info_get_name        (const GfPluginInfo *info);

Gets the name for info.

info : The GfPluginInfo instance.
Returns : The name for info.

gf_plugin_info_get_version ()

const gchar* gf_plugin_info_get_version     (const GfPluginInfo *info);

Gets the version for info.

info : The GfPluginInfo instance.
Returns : The version of info.

gf_plugin_info_get_summary ()

const gchar* gf_plugin_info_get_summary     (const GfPluginInfo *info);

Gets the summary for info.

info : The GfPluginInfo instance.
Returns : The summary for info.

gf_plugin_info_get_description ()

const gchar* gf_plugin_info_get_description (const GfPluginInfo *info);

Gets the description for info.

info : The GfPluginInfo instance.
Returns : The description for info.

gf_plugin_info_get_author ()

const gchar* gf_plugin_info_get_author      (const GfPluginInfo *info);

Gets the author for info.

info : The GfPluginInfo instance.
Returns : The author for info.

gf_plugin_info_get_website ()

const gchar* gf_plugin_info_get_website     (const GfPluginInfo *info);

Gets the website for info.

info : The GfPluginInfo instance.
Returns : The website for info.