KCModuleInfo Class Reference

#include <kcmoduleinfo.h>

List of all members.

Public Member Functions
	KCModuleInfo (const QString &desktopFile)
	KCModuleInfo (KService::Ptr moduleInfo)
	KCModuleInfo (const KCModuleInfo &rhs)
	KCModuleInfo ()
	~KCModuleInfo ()
QString	comment () const
QString	docPath () const
QString	fileName () const
QString	handle () const
QString	icon () 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
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.n

Note:

Any values set with the set* functions is not written back with KCModuleInfo it only reads value from the desktop file.

Author:

Matthias Hoelzer-Kluepfel mhk@k.nosp@m.de.o.nosp@m.rg

Matthias Elter elter.nosp@m.@kde.nosp@m..org

Daniel Molkentin molke.nosp@m.ntin.nosp@m.@kde..nosp@m.org

Definition at line 47 of file kcmoduleinfo.h.

---

Constructor & Destructor Documentation

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.

Definition at line 82 of file kcmoduleinfo.cpp.

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

Definition at line 87 of file kcmoduleinfo.cpp.

KCModuleInfo::KCModuleInfo

(

const KCModuleInfo &

rhs

)

Same as above but takes a KCModuleInfo as argument.

Parameters:

rhs	specifies the module

Definition at line 92 of file kcmoduleinfo.cpp.

KCModuleInfo::KCModuleInfo

(

)

Same as above but creates an empty KCModuleInfo.

You should not normally call this.

Definition at line 77 of file kcmoduleinfo.cpp.

KCModuleInfo::~KCModuleInfo

(

)

Default destructor.

Definition at line 114 of file kcmoduleinfo.cpp.

---

Member Function Documentation

QString KCModuleInfo::comment

(

)

const

Returns:

the module's (translated) comment field

Definition at line 161 of file kcmoduleinfo.cpp.

QString KCModuleInfo::docPath

(

)

const

Returns:

the path of the module's documentation

Definition at line 176 of file kcmoduleinfo.cpp.

QString KCModuleInfo::fileName

(

)

const

Returns:

the filename of the .desktop file that describes the KCM

Definition at line 141 of file kcmoduleinfo.cpp.

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)

Definition at line 184 of file kcmoduleinfo.cpp.

QString KCModuleInfo::icon

(

)

const

Returns:

the module's icon name

Definition at line 166 of file kcmoduleinfo.cpp.

QStringList KCModuleInfo::keywords

(

)

const

Returns:

the keywords associated with this KCM.

Definition at line 146 of file kcmoduleinfo.cpp.

QString KCModuleInfo::library

(

)

const

Returns:

the library name

Definition at line 171 of file kcmoduleinfo.cpp.

QString KCModuleInfo::moduleName

(

)

const

Returns:

the module\'s (translated) name

Definition at line 151 of file kcmoduleinfo.cpp.

bool KCModuleInfo::operator!=

(

const KCModuleInfo &

rhs

)

const

Returns:

true if rhs is not equal itself

Definition at line 109 of file kcmoduleinfo.cpp.

KCModuleInfo & KCModuleInfo::operator=

(

const KCModuleInfo &

rhs

)

Assignment operator.

Definition at line 98 of file kcmoduleinfo.cpp.

bool KCModuleInfo::operator==

(

const KCModuleInfo &

rhs

)

const

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

Definition at line 104 of file kcmoduleinfo.cpp.

KService::Ptr KCModuleInfo::service

(

)

const

Returns:

a KSharedPtr to KService created from the modules .desktop file

Definition at line 156 of file kcmoduleinfo.cpp.

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.

Definition at line 192 of file kcmoduleinfo.cpp.

---

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

• kcmoduleinfo.h
• kcmoduleinfo.cpp