TextAddonsCore::PluginUtil Namespace

namespace TextAddonsCore::PluginUtil

Helper functions to load and save the plugin activation state. More...

Header: #include <TextAddonsCore/PluginUtil>
CMake: find_package(KF6TextAddonsCore REQUIRED)
target_link_libraries(mytarget PRIVATE KF6::TextAddonsCore)

Classes

Functions

TextAddonsCore::PluginUtilData createPluginMetaData(const KPluginMetaData &metaData)
bool isPluginActivated(const QStringList &enabledPluginsList, const QStringList &disabledPluginsList, bool isEnabledByDefault, const QString &pluginId)
TextAddonsCore::PluginUtil::PluginsStateList loadPluginSetting(const QString &configFileName, const QString &groupName, const QString &prefixSettingKey)
void savePluginSettings(const QString &groupName, const QString &prefixSettingKey, const QStringList &enabledPluginsList, const QStringList &disabledPluginsList, const QString &configFileName = {})

Detailed Description

Classes

class PluginsStateList

Structure holding lists of enabled and disabled plugins. More...

Function Documentation

TextAddonsCore::PluginUtilData PluginUtil::createPluginMetaData(const KPluginMetaData &metaData)

Returns a PluginUtilData filled from the plugin metaData.

bool PluginUtil::isPluginActivated(const QStringList &enabledPluginsList, const QStringList &disabledPluginsList, bool isEnabledByDefault, const QString &pluginId)

Returns true if the plugin pluginId is activated.

If isEnabledByDefault is true, the plugin is activated unless it is in disabledPluginsList, otherwise it is activated only if it is in enabledPluginsList. Returns false if pluginId is empty.

TextAddonsCore::PluginUtil::PluginsStateList PluginUtil::loadPluginSetting(const QString &configFileName, const QString &groupName, const QString &prefixSettingKey)

Loads the plugin state from the configuration file configFileName.

Reads the prefixSettingKey Enabled and Disabled entries of the groupName group and returns them as a PluginsStateList.

void PluginUtil::savePluginSettings(const QString &groupName, const QString &prefixSettingKey, const QStringList &enabledPluginsList, const QStringList &disabledPluginsList, const QString &configFileName = {})

Saves the plugin settings to the configuration file configFileName.

Writes enabledPluginsList and disabledPluginsList to the prefixSettingKey Enabled and Disabled entries of the groupName group. Empty lists remove the corresponding entry. If configFileName is empty, the application configuration file is used.