KCModuleInfo Class Reference

#include <kcmoduleinfo.h>

Public Member Functions
	KCModuleInfo ()
	KCModuleInfo (const KCModuleInfo &rhs)
	KCModuleInfo (const KPluginInfo &pluginInfo)
	KCModuleInfo (const QString &desktopFile)
	KCModuleInfo (KService::Ptr moduleInfo)
	~KCModuleInfo ()
QString	comment () const
QString	docPath () const
QString	fileName () const
QString	handle () const
QString	icon () const
bool	isValid () const
QStringList	keywords () const
QString	library () const
QString	moduleName () const
bool	operator!= (const KCModuleInfo &rhs) const
KCModuleInfo &	operator= (const KCModuleInfo &rhs)
bool	operator== (const KCModuleInfo &rhs) const
KPluginInfo	pluginInfo () const
QVariant	property (const QString &key) const
KService::Ptr	service () const
int	weight () const

Detailed Description

A class that provides information about a KCModule.

KCModuleInfo provides various technical information, such as icon, library etc. about a KCModule.

Note

Any values set with the set* functions are not written back, KCModuleInfo only reads values from the desktop file.

Author

Matthias Hoelzer-Kluepfel [email protected][email protected]de.o[email protected]rg

Matthias Elter elter[email protected]@kde[email protected].org

Daniel Molkentin molke[email protected]ntin[email protected]@kde.[email protected]org

Definition at line 36 of file kcmoduleinfo.h.

Constructor & Destructor Documentation

KCModuleInfo() [1/5]

KCModuleInfo::KCModuleInfo

(

const QString &

desktopFile

)

Constructs a KCModuleInfo.

Note

a KCModuleInfo object will have to be manually deleted, it is not done automatically for you.

Parameters

desktopFile

the desktop file representing the module, or the name of the module.

Deprecated:

Since 5.88, use KPluginMetaData API instead

Definition at line 93 of file kcmoduleinfo.cpp.

KCModuleInfo() [2/5]

KCModuleInfo::KCModuleInfo

(

const KPluginInfo &

pluginInfo

)

Same as above but takes a KPluginInfo as argument.

This allows to encapsulate both the case of KService (desktop file) and the case of KPluginMetaData (JSon data in .so file) under the same API.

Parameters

pluginInfo

specifies the module

Since

5.70

Deprecated:

Since 5.88, use KPluginMetaData API instead

Definition at line 103 of file kcmoduleinfo.cpp.

KCModuleInfo() [3/5]

KCModuleInfo::KCModuleInfo

(

KService::Ptr

moduleInfo

)

Same as above but takes a KService::Ptr as argument.

Note

moduleInfo must be a valid pointer.

Parameters

moduleInfo

specifies the module

Deprecated:

Since 5.88, use KPluginMetaData API instead

Definition at line 98 of file kcmoduleinfo.cpp.

KCModuleInfo() [4/5]

KCModuleInfo::KCModuleInfo

(

const KCModuleInfo &

rhs

)

Copy constructor.

Parameters

rhs	specifies the module info to copy

Deprecated:

Since 5.88, use KPluginMetaData API instead

Definition at line 108 of file kcmoduleinfo.cpp.

KCModuleInfo() [5/5]

KCModuleInfo::KCModuleInfo

(

)

Same as above but creates an empty KCModuleInfo.

You should not normally call this.

Definition at line 88 of file kcmoduleinfo.cpp.

~KCModuleInfo()

KCModuleInfo::~KCModuleInfo

(

)

Default destructor.

Definition at line 130 of file kcmoduleinfo.cpp.

Member Function Documentation

comment()

QString KCModuleInfo::comment

(

)

const

Returns

the module's (translated) comment field

Definition at line 214 of file kcmoduleinfo.cpp.

docPath()

QString KCModuleInfo::docPath

(

)

const

Returns

the path of the module's documentation

Definition at line 229 of file kcmoduleinfo.cpp.

fileName()

QString KCModuleInfo::fileName

(

)

const

Returns

the filename of the .desktop file that describes the KCM

Definition at line 179 of file kcmoduleinfo.cpp.

handle()

QString KCModuleInfo::handle

(

)

const

Returns

a handle (the contents of the X-KDE-FactoryName field if it exists, else the same as the library name)

Deprecated:

Since 5.85, use KPluginMetaData::pluginId or KCModuleInfo::library instead

Definition at line 239 of file kcmoduleinfo.cpp.

icon()

QString KCModuleInfo::icon

(

)

const

Returns

the module's icon name

Definition at line 219 of file kcmoduleinfo.cpp.

isValid()

bool KCModuleInfo::isValid

(

)

const

Returns true if the KCM was found.

Since

5.71

Definition at line 135 of file kcmoduleinfo.cpp.

keywords()

QStringList KCModuleInfo::keywords

(

)

const

Returns

the keywords associated with this KCM.

Definition at line 184 of file kcmoduleinfo.cpp.

library()

QString KCModuleInfo::library

(

)

const

Returns

the library name

Definition at line 224 of file kcmoduleinfo.cpp.

moduleName()

QString KCModuleInfo::moduleName

(

)

const

Returns

the module\'s (translated) name

Definition at line 189 of file kcmoduleinfo.cpp.

operator!=()

bool KCModuleInfo::operator!=

(

const KCModuleInfo &

rhs

)

const

Returns

true if rhs is not the same KCModule as this object.

Definition at line 125 of file kcmoduleinfo.cpp.

operator=()

KCModuleInfo & KCModuleInfo::operator=

(

const KCModuleInfo &

rhs

)

Assignment operator.

Definition at line 114 of file kcmoduleinfo.cpp.

operator==()

bool KCModuleInfo::operator==

(

const KCModuleInfo &

rhs

)

const

Returns true if rhs describes the same KCModule as this object.

Definition at line 120 of file kcmoduleinfo.cpp.

pluginInfo()

KPluginInfo KCModuleInfo::pluginInfo

(

)

const

Returns

the KPluginInfo containing more information about this module

Since

5.70

Definition at line 209 of file kcmoduleinfo.cpp.

property()

QVariant KCModuleInfo::property

(

const QString &

key

)

const

Returns

The value associated to 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.

Since

5.71

Definition at line 258 of file kcmoduleinfo.cpp.

service()

KService::Ptr KCModuleInfo::service

(

)

const

Returns

a QExplicitlySharedDataPointer to KService created from the modules .desktop file

Warning

This will be null if this KCModuleInfo was created from a KPluginInfo coming from KPluginMetaData. Prefer using pluginInfo() instead, which works for both kinds.

Definition at line 194 of file kcmoduleinfo.cpp.

weight()

int KCModuleInfo::weight

(

)

const

Returns

the weight of the module which determines the order of the pages in the KCMultiDialog. It's set by the X-KDE-Weight field.

Deprecated:

Since 5.88, read X-KDE-Weight from KPluginMetaData instance instead

Definition at line 249 of file kcmoduleinfo.cpp.

---

The documentation for this class was generated from the following files:

• kcmoduleinfo.h
• kcmoduleinfo.cpp