KPluginInfo Class Reference
Information about a plugin. More...
#include <kplugininfo.h>
Public Types | |
typedef QValueList< KPluginInfo * > | List |
Public Member Functions | |
KPluginInfo (const QString &filename, const char *resource=0) | |
KPluginInfo (const KService::Ptr service) | |
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 | |
KPluginInfo::List | fromServices (const KService::List &services, KConfig *config=0, const QString &group=QString::null) |
KPluginInfo::List | fromFiles (const QStringList &files, KConfig *config=0, const QString &group=QString::null) |
KPluginInfo::List | fromKPartsInstanceName (const QString &, KConfig *config=0, const QString &group=QString::null) |
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 want's to use this plugin or not.
- Author:
- Matthias Kretz <kretz@kde.org>
- Since:
- 3.2
Definition at line 40 of file kplugininfo.h.
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.
References KConfigBase::readBoolEntry(), KConfigBase::readEntry(), KConfigBase::readListEntry(), KConfigBase::readPathEntry(), and KConfigBase::setDesktopGroup(). Referenced by fromFiles(), and fromServices(). |
|
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 References KService::Ptr. |
Member Function Documentation
|
References KPluginInfo(), KService::List, and setConfig(). |
|
References KPluginInfo(), and setConfig(). Referenced by fromKPartsInstanceName(). |
|
References KGlobal::dirs(), KStandardDirs::findAllResources(), and fromFiles(). |
|
|
|
Set whether the plugin is currently loaded. You might need to reimplement this method for special needs.
References endl(), k_funcinfo, and kdDebug(). Referenced by defaults(), load(), and KPluginSelectionWidget::save(). |
|
References endl(), k_funcinfo, and kdDebug(). Referenced by KPluginSelectionWidget::load(), and save(). |
|
References endl(), k_funcinfo, and kdDebug(). Referenced by defaults(), and load(). |
|
Referenced by operator[](). |
|
This is the same as property(). It is provided for convenience.
References property(). |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
References KService::Ptr. |
|
|
|
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 289 of file kplugininfo.cpp. Referenced by fromFiles(), and fromServices(). |
|
|
|
|
|
Save state of the plugin - enabled or not. This function is provided for reimplementation if you need to save somewhere else.
References endl(), isPluginEnabled(), k_funcinfo, kdDebug(), kdWarning(), and KConfigBase::writeEntry(). Referenced by KPluginSelectionWidget::save(). |
|
Load the state of the plugin - enabled or not. This function is provided for reimplementation if you need to save somewhere else.
References endl(), isPluginEnabledByDefault(), k_funcinfo, kdDebug(), kdWarning(), KConfigBase::readBoolEntry(), and setPluginEnabled(). Referenced by KPluginSelectionWidget::load(). |
|
Restore defaults (enabled or not). Definition at line 352 of file kplugininfo.cpp. References endl(), isPluginEnabledByDefault(), k_funcinfo, kdDebug(), and setPluginEnabled(). |
The documentation for this class was generated from the following files: