class KPluginInfo |
|
Information about a plugin.
This holds all the information about a plugin there is. It's used for the user to decide whether he wants to use this plugin or not.
Author Matthias Kretz |
|
Read plugin info from filename.
The file should be of the following form: [Desktop Entry] Encoding=UTF-8 Icon=mypluginicon Type=Service ServiceTypes=KPluginInfoThe Name and Comment fields must always be present. The "X-KDE-PluginInfo" keys you may add further entries which will be available using property(). The Website,Category,Require keys are optional. For EnabledByDefault look at isPluginEnabledByDefault. filename - The filename of the .desktop file. resource - If filename is relative, you need to specify a resource type (e.g. "service", "apps"... KStandardDirs). Otherwise, resource isn't used. |
|
Read plugin info from a KService object.
The .desktop file should look like this: [Desktop Entry] Encoding=UTF-8 Icon=mypluginicon Type=Service ServiceTypes=KPluginInfoIn the first three entries the Icon entry is optional. |
|
Creates an invalid plugin.
See also isValid |
|
Creates a KPluginInfo object that shares the data with copy. |
|
Returns The author of this plugin. |
|
Returns The category of this plugin (e.g. playlist/skin). |
|
Returns A comment describing the plugin. |
|
Returns If the KPluginInfo object has a KConfig object set return it, else returns an invalid KConfigGroup. |
|
Restore defaults (enabled or not). |
|
Returns A list of plugins required for this plugin to be enabled. Use the pluginName in this list. |
|
Returns The email address of the author. |
|
Returns The file containing the information about the plugin. |
|
Returns A list of KPluginInfo objects constructed from a list of
filenames. If you make a lookup using, for example,
KStandardDirs.findAllResources() you pass the list of files to this
function.
files - The list of files to construct the list of KPluginInfo objects from config - The config group where to save/load whether the plugin is enabled/disabled |
|
Returns A list of KPluginInfo objects for the KParts plugins of a
component. You only need the name of the component not a pointer to the
KComponentData object.
componentName - Use the component name to look up all KParts plugins for it. config - The config group where to save/load whether the plugin is enabled/disabled |
|
Returns A list of KPluginInfo objects constructed from a list of
KService objects. If you get a trader offer of the plugins you want
to use you can just pass them to this function.
services - The list of services to construct the list of KPluginInfo objects from config - The config group where to save/load whether the plugin is enabled/disabled |
|
Returns The iconname for this plugin |
|
Returns Whether the plugin should be hidden. |
|
Returns Whether the plugin is currently loaded.
See also setPluginEnabled() See also load() |
|
Returns The default value whether the plugin is enabled or not. Defaults to the value set in the desktop file, or if that isn't set to false. |
|
Returns whether the object is valid. Treat invalid KPluginInfo objects like you would treat a null pointer. |
|
Returns A list of Service pointers if the plugin installs one or more KCModule |
|
Returns The license of this plugin. |
|
Load the state of the plugin - enabled or not.
config - The KConfigGroup holding the information whether plugin is enabled. |
|
Returns The user visible name of the plugin. |
|
Compares two objects whether they don't share the same data. |
|
Less than relation comparing the categories and if they are the same using the names. |
|
Compares two objects whether they share the same data. |
|
Greater than relation comparing the categories and if they are the same using the names. |
|
Returns The internal name of the plugin (for KParts Plugins this is the same name as set in the .rc file). |
|
Returns The value associated the the key. You can use it if you want to read custom values. To do this you need to define your own servicetype and add it to the ServiceTypes keys. |
|
Save state of the plugin - enabled or not.
config - The KConfigGroup holding the information whether plugin is enabled. |
|
Returns The KService object for this plugin. You might need it if you
want to read custom values. To do this you need to define
your own servicetype and add it to the ServiceTypes keys.
Then you can use the KService.property() method to read your
keys.
See also property() |
|
Set the KConfigGroup to use for load()ing and save()ing the configuration. This will be overridden by the KConfigGroup passed to save() or load() (if one is passed). |
|
Set whether the plugin is currently loaded.
See also isPluginEnabled() See also save() |
|
Returns The version of the plugin. |
|
Returns The website of the plugin/author. |