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 KPluginMetaData &metaData, QWidget *parent=nullptr, const QVariantList &args={})
 
KCMUTILS_EXPORT KCModuleloadModule (const QString &module, ErrorReporting report, QWidget *parent=nullptr, const QStringList &args=QStringList())
 
KCMUTILS_EXPORT KCModuleDataloadModuleData (const KCModuleInfo &module, 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

◆ ErrorReporting

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 40 of file kcmoduleloader.h.

Function Documentation

◆ isDefaults()

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
Deprecated:
Since 5.88, use KPluginFactory::instantiatePlugin<KCModuleData> and save the result in a QScopedPointer instead

Definition at line 249 of file kcmoduleloader.cpp.

◆ loadModule() [1/3]

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
Deprecated:
Since 5.88, use loadModule(KPluginMetaData, QWidget *, QVariantList) instead

Definition at line 144 of file kcmoduleloader.cpp.

◆ loadModule() [2/3]

KCModule * KCModuleLoader::loadModule ( const KPluginMetaData metaData,
QWidget parent = nullptr,
const QVariantList &  args = {} 
)

Loads a KCModule.

If loading fails a KCM which displays an error message is returned. Starting from 5.91, the validity of the metaData parameter does not need to be checked when calling this function.

Parameters
metaDataKPluginMetaData for loading the plugin
Returns
a pointer to the loaded KCModule
Since
5.84

Definition at line 54 of file kcmoduleloader.cpp.

◆ loadModule() [3/3]

QT_WARNING_PUSH 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
Deprecated:
Since 5.88, use loadModule(KPluginMetaData, QWidget *, QVariantList) instead

Definition at line 139 of file kcmoduleloader.cpp.

◆ loadModuleData()

KCModuleData * KCModuleLoader::loadModuleData ( const KCModuleInfo module,
const QStringList args = QStringList() 
)

Loads a KCModuleData.

If fails to load, return nullptr.

Parameters
modulewhat module to load
Since
5.81
Deprecated:
Since 5.88, use KPluginFactory::instantiatePlugin<KCModuleData> instead

Definition at line 259 of file kcmoduleloader.cpp.

◆ reportError()

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 115 of file kcmoduleloader.cpp.

◆ unloadModule()

void KCModuleLoader::unloadModule ( const KCModuleInfo mod)

Unloads the module's library.

Parameters
modWhat module to unload for
Deprecated:
Since 5.88, use QPluginLoader directly

Definition at line 242 of file kcmoduleloader.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed Jun 29 2022 03:55:18 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.