Class
PurplePluginInfo
since: 3.0.0
Description [src]
class Purple.PluginInfo : GPlugin.PluginInfo {
parent_instance: GPluginPluginInfo
}
PurplePluginInfo
is a GPluginPluginInfo
subclass that adds additional
libpurple specific properties.
Available since: 3.0.0
Constructors
purple_plugin_info_new
Creates a new PurplePluginInfo
instance to be returned from
plugin_query of a plugin, using the provided name/value pairs.
since: 3.0.0
Instance methods
purple_plugin_info_get_action_group
Gets the [class:Gio.ActionGroup] from info
if one is set.
since: 3.0.0
purple_plugin_info_get_action_menu
Gets the [class:Gio.MenuModel] from info
if one is set.
since: 3.0.0
purple_plugin_info_get_error
Returns an error in the plugin info that would prevent the plugin from being loaded.
since: 3.0.0
purple_plugin_info_get_pref_frame_cb
Returns the callback that retrieves the preferences frame for a plugin, set via the “pref-frame-cb” property of the plugin info.
since: 3.0.0
purple_plugin_info_get_pref_request_cb
Returns the callback that retrieves the preferences request handle for a plugin, set via the “pref-request-cb” property of the plugin info.
since: 3.0.0
Methods inherited from GPluginPluginInfo (23)
gplugin_plugin_info_get_abi_version
Returns the ABI or Application Binary Interface version that the plugin is supposed to work against.
gplugin_plugin_info_get_authors
Returns the authors of the plugin as specified in info
.
gplugin_plugin_info_get_auto_load
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.
since: 0.39.0
gplugin_plugin_info_get_bind_global
This property and therefore function is only used by the native plugin loader.
gplugin_plugin_info_get_category
Returns the category of the plugin as specified in info
.
gplugin_plugin_info_get_dependencies
Returns the dependencies of the plugins as specified in info
.
gplugin_plugin_info_get_description
Returns the description for the plugin as specified in info
.
gplugin_plugin_info_get_icon_name
Returns the name of the icon for the plugin as specified in info
.
gplugin_plugin_info_get_id
Returns the id that the plugin identifies itself as.
gplugin_plugin_info_get_id_normalized
Gets the normalized version of the id from info
. That is, a version where
only alphanumeric and -‘s are in the id.
gplugin_plugin_info_get_internal
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.
gplugin_plugin_info_get_license_id
Returns the liences id for the plugin as specified in info
.
gplugin_plugin_info_get_license_text
Returns the license text for the plugin as specified in info
.
gplugin_plugin_info_get_license_url
Returns the url of the license for the plugin as specified in info
.
gplugin_plugin_info_get_load_on_query
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.
deprecated: 0.39.0
gplugin_plugin_info_get_name
Returns the name of the plugin as specified in info
.
gplugin_plugin_info_get_priority
Gets the priority of the plugin as specified in info
.
since: 0.32.0
gplugin_plugin_info_get_provides
Gets the provides of the plugin as specified in info
.
since: 0.32.0
gplugin_plugin_info_get_settings_schema
Returns the ID of the GSettings
schema as specified in info
.
since: 0.39.0
gplugin_plugin_info_get_summary
Returns the summery for the plugin as specified in info
.
gplugin_plugin_info_get_unloadable
Gets whether or not the plugin is unloadable. Certain libraries can not be
shutdown cleanly and then re-enabled during the life time of a program. A
plugin using one of these libraries should set the
GPluginPluginInfo:unloadable
property to FALSE
to tell
GPluginManager
to not even attempt to unload it.
since: 0.35.0
gplugin_plugin_info_get_version
Returns the version of the plugin as specified in info
.
gplugin_plugin_info_get_website
Returns the website for the plugin as specified in info
.
Properties
Properties inherited from GPluginPluginInfo (22)
GPlugin.PluginInfo:abi-version
The GPlugin ABI version that the plugin was compiled against.
GPlugin.PluginInfo:authors
A list of the names and email addresses of the authors.
GPlugin.PluginInfo:auto-load
Whether or not the plugin should be loaded when it’s queried.
since: 0.39.0
GPlugin.PluginInfo:bind-global
Determines whether the plugin should be have its symbols bound globally.
GPlugin.PluginInfo:category
The category of this plugin.
GPlugin.PluginInfo:dependencies
A comma separated list of plugin id’s that this plugin depends on.
GPlugin.PluginInfo:description
The full description of the plugin that will be used in a “more information” section in a user interface.
GPlugin.PluginInfo:icon-name
A XDG icon name for the plugin. The actual use of this is determined by the application/library using GPlugin.
GPlugin.PluginInfo:id
The id of the plugin.
GPlugin.PluginInfo:internal
Whether or not the plugin is considered an “internal” plugin.
GPlugin.PluginInfo:license-id
The short name of the license.
GPlugin.PluginInfo:license-text
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 at spdx.org.
GPlugin.PluginInfo:license-url
The url to the text of the license. This should primarily only be used for licenses not listed at spdx.org.
GPlugin.PluginInfo:load-on-query
Whether or not the plugin should be loaded when it’s queried.
deprecated: 0.39.0
GPlugin.PluginInfo:name
The display name of the plugin. This should be a translated string.
GPlugin.PluginInfo:priority
The priority that this plugin should have when determining which plugin to use when multiple plugins have the same id or provides. Higher values take precedence over lower values. If two plugins have the same id and priority, the first one found will be used.
since: 0.32.0
GPlugin.PluginInfo:provides
A list of additional plugin ids and versions that this plugin can provide. This mechanism is used so that plugins can replace and extend the behavior of other plugins.
since: 0.32.0
GPlugin.PluginInfo:settings-schema
The ID of the GSettings
schema for the plugin.
since: 0.39.0
GPlugin.PluginInfo:summary
A short description of the plugin that can be listed with the name in a user interface.
GPlugin.PluginInfo:unloadable
Sets whether or not a plugin is unloadable. See
gplugin_plugin_info_get_unloadable()
for more information.
since: 0.35.0
GPlugin.PluginInfo:version
The version of the plugin. Preferably a semantic version.
GPlugin.PluginInfo:website
The url of the plugin that can be represented in a user interface.
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.