KUtils
KCModuleInfo Class Reference
#include <kcmoduleinfo.h>
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.
Definition at line 47 of file kcmoduleinfo.h.
Public Member Functions | |
QString | comment () const |
QString | docPath () const |
QString | fileName () const |
QString | handle () const |
QString | icon () const |
KCModuleInfo () | |
KCModuleInfo (const KCModuleInfo &rhs) | |
KCModuleInfo (KService::Ptr moduleInfo) | |
KCModuleInfo (const QString &desktopFile) | |
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 |
~KCModuleInfo () |
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 | ( | ) |
Member Function Documentation
QString KCModuleInfo::comment | ( | ) | const |
QString KCModuleInfo::docPath | ( | ) | const |
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 |
QStringList KCModuleInfo::keywords | ( | ) | const |
QString KCModuleInfo::library | ( | ) | const |
QString KCModuleInfo::moduleName | ( | ) | const |
bool KCModuleInfo::operator!= | ( | const KCModuleInfo & | rhs | ) | const |
KCModuleInfo & KCModuleInfo::operator= | ( | const KCModuleInfo & | rhs | ) |
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: