KPluginInfo Class Reference
[Main classes, Plugin handling classes]
#include <kplugininfo.h>
Detailed Description
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 <kretz@kde.org>
- Since:
- 3.2
Definition at line 42 of file kplugininfo.h.
Public Types | |
typedef QValueList< KPluginInfo * > | List |
Public Member Functions | |
KPluginInfo (const QString &filename, const char *resource=0) | |
KPluginInfo (const KService::Ptr service) | |
virtual | ~KPluginInfo () |
bool | isHidden () const |
virtual void | setPluginEnabled (bool enabled) |
virtual bool | isPluginEnabled () const |
bool | isPluginEnabledByDefault () const |
QVariant | property (const QString &key) const |
QVariant | operator[] (const QString &key) const |
const QString & | name () const |
const QString & | comment () const |
const QString & | icon () const |
const QString & | specfile () const |
const QString & | author () const |
const QString & | email () const |
const QString & | category () const |
const QString & | pluginName () const |
const QString & | version () const |
const QString & | website () const |
const QString & | license () const |
const QStringList & | dependencies () const |
KService::Ptr | service () const |
const QValueList< KService::Ptr > & | kcmServices () const |
void | setConfig (KConfig *config, const QString &group) |
KConfig * | config () const |
const QString & | configgroup () const |
virtual void | save (KConfigGroup *config=0) |
virtual void | load (KConfigGroup *config=0) |
virtual void | defaults () |
Static Public Member Functions | |
static KPluginInfo::List | fromServices (const KService::List &services, KConfig *config=0, const QString &group=QString::null) |
static KPluginInfo::List | fromFiles (const QStringList &files, KConfig *config=0, const QString &group=QString::null) |
static KPluginInfo::List | fromKPartsInstanceName (const QString &, KConfig *config=0, const QString &group=QString::null) |
Constructor & Destructor Documentation
|
Read plugin info from The file should be of the following form: [Desktop Entry] Name=User Visible Name Comment=Description of what the plugin does [X-KDE Plugin Info] Author=Author's Name Email=author@foo.bar PluginName=internalname Version=1.1 Website=http://www.plugin.org/ Category=playlist Depends=plugin1,plugin3 License=GPL EnabledByDefault=true 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.
Definition at line 70 of file kplugininfo.cpp. |
|
Read plugin info from a KService object. The .desktop file should look like this: [Desktop Entry] Encoding=UTF-8 Icon=mypluginicon Type=Service ServiceTypes=KPluginInfo X-KDE-PluginInfo-Author=Author's Name X-KDE-PluginInfo-Email=author@foo.bar X-KDE-PluginInfo-Name=internalname X-KDE-PluginInfo-Version=1.1 X-KDE-PluginInfo-Website=http://www.plugin.org/ X-KDE-PluginInfo-Category=playlist X-KDE-PluginInfo-Depends=plugin1,plugin3 X-KDE-PluginInfo-License=GPL X-KDE-PluginInfo-EnabledByDefault=true Name=User Visible Name Comment=Description of what the plugin does Definition at line 115 of file kplugininfo.cpp. |
Member Function Documentation
|
Definition at line 230 of file kplugininfo.cpp. |
|
Definition at line 240 of file kplugininfo.cpp. |
|
Definition at line 215 of file kplugininfo.cpp. |
|
Definition at line 296 of file kplugininfo.cpp. |
|
Definition at line 301 of file kplugininfo.cpp. |
|
Restore defaults (enabled or not).
Definition at line 353 of file kplugininfo.cpp. |
|
Definition at line 265 of file kplugininfo.cpp. |
|
Definition at line 235 of file kplugininfo.cpp. |
|
Definition at line 168 of file kplugininfo.cpp. |
|
Definition at line 180 of file kplugininfo.cpp. |
|
Definition at line 154 of file kplugininfo.cpp. |
|
Definition at line 220 of file kplugininfo.cpp. |
|
Definition at line 187 of file kplugininfo.cpp. |
|
Definition at line 198 of file kplugininfo.cpp. |
|
Definition at line 204 of file kplugininfo.cpp. |
|
Definition at line 275 of file kplugininfo.cpp. |
|
Definition at line 260 of file kplugininfo.cpp. |
|
Load the state of the plugin - enabled or not. This function is provided for reimplementation if you need to save somewhere else.
Definition at line 336 of file kplugininfo.cpp. |
|
Definition at line 210 of file kplugininfo.cpp. |
|
This is the same as property(). It is provided for convenience.
Definition at line 314 of file kplugininfo.cpp. |
|
Definition at line 245 of file kplugininfo.cpp. |
|
Definition at line 306 of file kplugininfo.cpp. |
|
Save state of the plugin - enabled or not. This function is provided for reimplementation if you need to save somewhere else.
Definition at line 319 of file kplugininfo.cpp. |
|
Definition at line 270 of file kplugininfo.cpp. |
|
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). Definition at line 290 of file kplugininfo.cpp. |
|
Set whether the plugin is currently loaded. You might need to reimplement this method for special needs.
Definition at line 192 of file kplugininfo.cpp. |
|
Definition at line 225 of file kplugininfo.cpp. |
|
Definition at line 250 of file kplugininfo.cpp. |
|
Definition at line 255 of file kplugininfo.cpp. |
The documentation for this class was generated from the following files: