PimCommon::GenericPluginManager Class

The GenericPluginManager class manages generic plugins Author: Laurent Montel <montel@kde.org>. More...

Header: #include <PimCommon/GenericPluginManager>
CMake: find_package(KPim6PimCommon REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::PimCommon)
Inherits: QObject

Public Types

Public Functions

GenericPluginManager(QObject *parent = nullptr)
virtual ~GenericPluginManager() override
QString configGroupName() const
QString configPrefixSettingKey() const
bool initializePlugins()
QString pluginDirectory() const
PimCommon::GenericPlugin *pluginFromIdentifier(const QString &id)
QString pluginName() const
QList<TextAddonsWidgets::PluginUtilData> pluginsDataList() const
QList<PimCommon::GenericPlugin *> pluginsList() const
void setPluginDirectory(const QString &directory)
void setPluginName(const QString &pluginName)

Detailed Description

Member Function Documentation

[explicit] GenericPluginManager::GenericPluginManager(QObject *parent = nullptr)

Constructs a GenericPluginManager. @param parent The parent QObject

[override virtual noexcept] GenericPluginManager::~GenericPluginManager()

Destructs the GenericPluginManager.

QString GenericPluginManager::configGroupName() const

Returns the configuration group name. @return The configuration group name

QString GenericPluginManager::configPrefixSettingKey() const

Returns the configuration prefix setting key. @return The configuration prefix key

bool GenericPluginManager::initializePlugins()

Initializes the plugins. @return true if initialization was successful, false otherwise

QString GenericPluginManager::pluginDirectory() const

Returns the plugin directory. @return The plugin directory path

See also setPluginDirectory().

PimCommon::GenericPlugin *GenericPluginManager::pluginFromIdentifier(const QString &id)

Returns a plugin by its identifier. @param id The plugin identifier @return The GenericPlugin with the given id, or nullptr if not found

QString GenericPluginManager::pluginName() const

Returns the plugin name filter. @return The plugin name filter

See also setPluginName().

QList<TextAddonsWidgets::PluginUtilData> GenericPluginManager::pluginsDataList() const

Returns the data list of plugins. @return A list of PluginUtilData for all plugins

QList<PimCommon::GenericPlugin *> GenericPluginManager::pluginsList() const

Returns the list of loaded plugins. @return A list of GenericPlugin instances

void GenericPluginManager::setPluginDirectory(const QString &directory)

Sets the directory where plugins are located. @param directory The plugin directory path

See also pluginDirectory().

void GenericPluginManager::setPluginName(const QString &pluginName)

Sets the plugin name filter. @param pluginName The plugin name to filter by

See also pluginName().