KCModuleLoader

KCModuleLoader Namespace Reference

Enumerations

enum  ErrorReporting { None = 0, Inline = 1, Dialog = 2, Both = 3 }
 

Functions

KCMUTILS_EXPORT bool isDefaults (const KCModuleInfo &module, const QStringList &args=QStringList())
 
KCMUTILS_EXPORT KCModuleloadModule (const KCModuleInfo &module, ErrorReporting report, QWidget *parent=nullptr, const QStringList &args=QStringList())
 
KCMUTILS_EXPORT KCModuleloadModule (const QString &module, ErrorReporting report, QWidget *parent=nullptr, const QStringList &args=QStringList())
 
KCMUTILS_EXPORT KCModulereportError (ErrorReporting report, const QString &text, const QString &details, QWidget *parent)
 
KCMUTILS_EXPORT void unloadModule (const KCModuleInfo &mod)
 

Detailed Description

Loads a KControl Module.

KCModuleLoader tries in several ways to locate and load a KCModule. If loading fails a zero pointer is returned.
It is very unlikely KCModuleLoader is what you want and KCModuleProxy suits your needs.

Author
Matthias Hoelzer-Kluepfel [email protected][email protected]de.o[email protected]rg
Frans Englich frans[email protected].eng[email protected][email protected][email protected]teli[email protected]a.com

Enumeration Type Documentation

Determines the way errors are reported.

Enumerator
None 

no error reporting is done

Inline 

the error report is shown instead of the KCModule that should have * been loaded

Dialog 

shows a dialog with the error report

Both 

does both Inline and Dialog

Definition at line 36 of file kcmoduleloader.h.

Function Documentation

bool KCModuleLoader::isDefaults ( const KCModuleInfo module,
const QStringList args = QStringList() 
)

For a specified module, return false if configuration is not the default one and true in all other case including if module is not found.

Parameters
modulewhat module to load
Returns
a boolean representing if module configuration is in default state
Since
5.74

Definition at line 155 of file kcmoduleloader.cpp.

KCModule * KCModuleLoader::loadModule ( const KCModuleInfo module,
ErrorReporting  report,
QWidget parent = nullptr,
const QStringList args = QStringList() 
)

Loads a KCModule.

If loading fails a zero pointer is returned.

Parameters
modulewhat module to load
reportsee ErrorReporting
Returns
a pointer to the loaded KCModule

Definition at line 57 of file kcmoduleloader.cpp.

KCModule * KCModuleLoader::loadModule ( const QString module,
ErrorReporting  report,
QWidget parent = nullptr,
const QStringList args = QStringList() 
)

Loads a KCModule.

If loading fails a zero pointer is returned.

Parameters
modulewhat module to load
reportsee ErrorReporting
Returns
a pointer to the loaded KCModule

Definition at line 52 of file kcmoduleloader.cpp.

KCModule * KCModuleLoader::reportError ( ErrorReporting  report,
const QString text,
const QString details,
QWidget parent 
)

Returns a KCModule containing the messages report and text.

Parameters
reportthe type of error reporting, see ErrorReporting
textthe main message
detailsany additional details

Definition at line 189 of file kcmoduleloader.cpp.

void KCModuleLoader::unloadModule ( const KCModuleInfo mod)

Unloads the module's library.

Parameters
modWhat module to unload for

Definition at line 148 of file kcmoduleloader.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Sep 20 2020 22:42:49 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.