kutils Library API Documentation

KCModuleInfo Class Reference

A class that provides information about a Control Module. More...

#include <kcmoduleinfo.h>

List of all members.

Public Member Functions

 KCModuleInfo (const QString &desktopFile)
 KCModuleInfo (KService::Ptr moduleInfo)
 KCModuleInfo (const KCModuleInfo &rhs)
KCModuleInfooperator= (const KCModuleInfo &rhs)
bool operator== (const KCModuleInfo &rhs) const
bool operator!= (const KCModuleInfo &rhs) const
QString fileName () const
const QStringListkeywords () const
QString moduleName () const
KService::Ptr service () const
QString comment () const
QString icon () const
QString docPath () const
QString library () const
QString handle () const
int weight () const
bool needsRootPrivileges () const
bool isHiddenByDefault () const KDE_DEPRECATED

Protected Member Functions

void setKeywords (const QStringList &k)
void setName (const QString &name)
void setComment (const QString &comment)
void setIcon (const QString &icon)
void setLibrary (const QString &lib)
void setHandle (const QString &handle)
void setWeight (int weight)
void setNeedsRootPrivileges (bool needsRootPrivileges)
void setIsHiddenByDefault (bool isHiddenByDefault)
void setDocPath (const QString &p)
void loadAll ()


Detailed Description

A class that provides information about a Control Module.

Definition at line 44 of file kcmoduleinfo.h.


Constructor & Destructor Documentation

KCModuleInfo::KCModuleInfo const QString desktopFile  ) 
 

Constructs a KCModuleInfo, note that you will have to take care about the deletion yourself!

Definition at line 32 of file kcmoduleinfo.cpp.

KCModuleInfo::KCModuleInfo KService::Ptr  moduleInfo  ) 
 

Construct a KCModuleInfo from a KService object.

Definition at line 41 of file kcmoduleinfo.cpp.

References k_funcinfo, and kdDebug().


Member Function Documentation

QString KCModuleInfo::fileName  )  const [inline]
 

Returns:
the filename of the .desktop file that describes the KCM

Definition at line 69 of file kcmoduleinfo.h.

const QStringList& KCModuleInfo::keywords  )  const [inline]
 

Returns:
the keywords associated with this KCM.

Definition at line 74 of file kcmoduleinfo.h.

QString KCModuleInfo::moduleName  )  const [inline]
 

Returns:
the module\'s (translated) name

Definition at line 80 of file kcmoduleinfo.h.

Referenced by KCMultiDialog::addModule().

KService::Ptr KCModuleInfo::service  )  const [inline]
 

Returns:
a KSharedPtr to KService created from the modules .desktop file

Definition at line 85 of file kcmoduleinfo.h.

Referenced by KCMultiDialog::addModule().

QString KCModuleInfo::comment  )  const [inline]
 

Returns:
the module's (translated) comment field

Definition at line 90 of file kcmoduleinfo.h.

Referenced by KCMultiDialog::addModule().

QString KCModuleInfo::icon  )  const [inline]
 

Returns:
the module's icon name

Definition at line 95 of file kcmoduleinfo.h.

Referenced by KCMultiDialog::addModule().

QString KCModuleInfo::docPath  )  const
 

Returns:
the path of the module's documentation

Definition at line 134 of file kcmoduleinfo.cpp.

Referenced by KCMultiDialog::addModule().

QString KCModuleInfo::library  )  const [inline]
 

Returns:
the library name

Definition at line 105 of file kcmoduleinfo.h.

QString KCModuleInfo::handle  )  const
 

Returns:
a handle (usually the contents of the FactoryName field)

Definition at line 143 of file kcmoduleinfo.cpp.

References QString::isEmpty().

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 155 of file kcmoduleinfo.cpp.

bool KCModuleInfo::needsRootPrivileges  )  const
 

Returns:
whether the module might require root permissions

Definition at line 164 of file kcmoduleinfo.cpp.

bool KCModuleInfo::isHiddenByDefault  )  const
 

Deprecated:
Returns:
the isHiddenByDefault attribute.

Definition at line 173 of file kcmoduleinfo.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kutils Library Version 3.2.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Mar 4 22:44:56 2004 by doxygen 1.3.6-20040222 written by Dimitri van Heesch, © 1997-2003