![]() |
![]() |
![]() |
![]() |
#define | gplugin_plugin_info_new() |
const gchar * | gplugin_plugin_info_get_id () |
guint32 | gplugin_plugin_info_get_abi_version () |
gboolean | gplugin_plugin_info_get_internal () |
gboolean | gplugin_plugin_info_get_load_on_query () |
const gchar * | gplugin_plugin_info_get_name () |
const gchar * | gplugin_plugin_info_get_version () |
const gchar * | gplugin_plugin_info_get_license_id () |
const gchar * | gplugin_plugin_info_get_license_text () |
const gchar * | gplugin_plugin_info_get_license_url () |
const gchar * | gplugin_plugin_info_get_icon () |
const gchar * | gplugin_plugin_info_get_summary () |
const gchar * | gplugin_plugin_info_get_description () |
const gchar * | gplugin_plugin_info_get_category () |
const gchar * const * | gplugin_plugin_info_get_authors () |
const gchar * | gplugin_plugin_info_get_website () |
const gchar * const * | gplugin_plugin_info_get_dependencies () |
GPluginVersionCompareFunc | gplugin_plugin_info_get_version_func () |
const gchar * | gplugin_plugin_info_get_help () |
guint | abi-version | Read / Write / Construct Only |
GStrv | authors | Read / Write / Construct Only |
gboolean | bind-local | Read / Write / Construct Only |
char * | category | Read / Write / Construct Only |
GStrv | dependencies | Read / Write / Construct Only |
char * | description | Read / Write / Construct Only |
char * | help | Read / Write / Construct Only |
char * | icon | Read / Write / Construct Only |
char * | id | Read / Write / Construct Only |
gboolean | internal | Read / Write / Construct Only |
char * | license-id | Read / Write / Construct Only |
char * | license-text | Read / Write / Construct Only |
char * | license-url | Read / Write / Construct Only |
gboolean | load-on-query | Read / Write / Construct Only |
char * | name | Read / Write / Construct Only |
char * | summary | Read / Write / Construct Only |
char * | version | Read / Write / Construct Only |
gpointer | version-func | Read / Write / Construct Only |
char * | website | Read / Write / Construct Only |
#define gplugin_plugin_info_new(id, abi_version, ...)
Creates a new GPluginPluginInfo instance.
id |
The id of the plugin |
|
abi_version |
The GPlugin ABI version that the plugin uses |
|
... |
name/value pairs of properties to set, followed by |
const gchar *
gplugin_plugin_info_get_id (GPluginPluginInfo *info
);
Returns the id that the plugin identifies itself as.
guint32
gplugin_plugin_info_get_abi_version (GPluginPluginInfo *info
);
Returns the ABI or Application Binary Interface version that the plugin is supposed to work against.
gboolean
gplugin_plugin_info_get_internal (GPluginPluginInfo *info
);
Returns where or not this plugin is is considered an internal plugin. An internal plugin would be something like a plugin loader or another plugin that should not be shown to users.
gboolean
gplugin_plugin_info_get_load_on_query (GPluginPluginInfo *info
);
Returns whether or not this plugin should be loaded when queried. This is useful for internal plugins that are adding functionality and should always be turned on. The plugin loaders use this to make sure all plugins can always be loaded.
const gchar *
gplugin_plugin_info_get_name (GPluginPluginInfo *info
);
Returns the name of the plugin as specified in info
.
const gchar *
gplugin_plugin_info_get_version (GPluginPluginInfo *info
);
Returns the version of the plugin as specified in info
.
const gchar *
gplugin_plugin_info_get_license_id (GPluginPluginInfo *info
);
Returns the liences id for the plugin as specified in info
.
const gchar *
gplugin_plugin_info_get_license_text (GPluginPluginInfo *info
);
Returns the license text for the plugin as specified in info
.
const gchar *
gplugin_plugin_info_get_license_url (GPluginPluginInfo *info
);
Returns the url of the license for the plugin as specified in info
const gchar *
gplugin_plugin_info_get_icon (GPluginPluginInfo *info
);
Returns the name of the icon for the plugin as specified in info
.
const gchar *
gplugin_plugin_info_get_summary (GPluginPluginInfo *info
);
Returns the summery for the plugin as specified in info
.
const gchar *
gplugin_plugin_info_get_description (GPluginPluginInfo *info
);
Returns the description for the plugin as specified in info
.
const gchar *
gplugin_plugin_info_get_category (GPluginPluginInfo *info
);
Returns the category of the plugin as specified in info
.
const gchar * const *
gplugin_plugin_info_get_authors (GPluginPluginInfo *info
);
Returns the authors of the plugin as specified in info
.
const gchar *
gplugin_plugin_info_get_website (GPluginPluginInfo *info
);
Returns the website for the plugin as specified in info
.
const gchar * const *
gplugin_plugin_info_get_dependencies (GPluginPluginInfo *info
);
Returns the dependencies of the plugins as specified in info
.
GPluginVersionCompareFunc
gplugin_plugin_info_get_version_func (GPluginPluginInfo *info
);
Returns the GPluginVersionCompareFunc used to compare versions of the plugin.
[skip]
const gchar *
gplugin_plugin_info_get_help (GPluginPluginInfo *info
);
Returns the help text for the plugin as specified in info
.
#define GPLUGIN_TYPE_PLUGIN_INFO (gplugin_plugin_info_get_type())
The standard _get_type macro for GPluginPluginInfo.
struct GPluginPluginInfoClass { };
The class structure for GPluginPluginInfo.
typedef struct _GPluginPluginInfo GPluginPluginInfo;
GPluginPluginInfo holds all of the data about a plugin. It is created when a plugin is queried.
“abi-version”
property“abi-version” guint
The GPlugin ABI version that the plugin was compiled against.
GPlugin only uses the first byte (0xff000000) of this value. The remaining 3 bytes are available for the application to use.
Take the following example from an application:
#define ABI_VERSION (GPLUGIN_NATIVE_ABI_VERSION | (APPLICATION_MAJOR_VERSION << 8) | (APPLICATION_MINOR_VERSION))
The application here uses the thrid and fourth bytes, but could use the second as well.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: 0
“authors”
property“authors” GStrv
A gchar ** of the names and email addresses of the authors.
It is recommended to use the RFC 822, 2822 format of: "First Last user@domain.com" with additional authors separated by a comma.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
“bind-local”
property“bind-local” gboolean
Determines whether the plugin should be have it's symbols bound locally.
Note: This should only be used by the native plugin loader.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: FALSE
“category”
property“category” char *
The category of this plugin.
This property is used to organize plugins into categories in a user interface. It is recommended that an application has a well defined set of categories that plugin authors should use, and put all plugins that don't match this category into an "Other" category.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“dependencies”
property“dependencies” GStrv
A comma separated list of plugin id's that this plugin depends on.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
“description”
property“description” char *
The full description of the plugin that will be used in a "more information" section in a user interface.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“help”
property“help” char *
The url of the plugin that can be represented in a user interface.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“icon”
property“icon” char *
A string representing an icon for the plugin. The actual use of this is determined by the application/library using GPlugin.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“id”
property“id” char *
The id of the plugin.
While not required, the recommended convention is to use the following format: <application or library>/<name of the plugin>.
For example, the python loader in GPlugin has an id of "gplugin/python-plugin-loader".
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“internal”
property“internal” gboolean
Whether or not the plugin is considered an "internal" plugin.
Defaults to FALSE.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: FALSE
“license-id”
property“license-id” char *
The short name of the license.
It is recommended to use the identifier of the license from http://dep.debian.net/deps/dep5/license-specification and should be "Other" for licenses that are not mentioned in DEP5.
If a plugin has multiple license, they should be separated by a pipe (|). In the odd case that you have multiple licenses that are used at the same time, they should be separated by an ampersand (&).
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“license-text”
property“license-text” char *
The text of the license for this plugin. This should only be used when the plugin is licensed under a license that is not listed in DEP5.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“license-url”
property“license-url” char *
The url to the text of the license. This should primarily only be used for licenses not listed in DEP5.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“load-on-query”
property“load-on-query” gboolean
Whether or not the plugin should be loaded when it's queried.
This is used by the loaders and may be useful to your application as well.
Defaults to FALSE.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: FALSE
“name”
property“name” char *
The display name of the plugin. This should be a translated string.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“summary”
property“summary” char *
A short description of the plugin that can be listed with the name in a user interface.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“version”
property“version” char *
The version of the plugin.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL
“version-func”
property“version-func” gpointer
The function to use to compare versions of this plugin.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
“website”
property“website” char *
The url of the plugin that can be represented in a user interface.
Owner: GPluginPluginInfo
Flags: Read / Write / Construct Only
Default value: NULL