KPluginWidget Class

A widget that shows a list of available plugins and allows to disable/enable them and open their configuration UI. More...

Header:	`#include <KPluginWidget>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS KCMUtils)` `target_link_libraries(mytarget PRIVATE KF6::KCMUtils)`
Since:	5.89
Inherits:	QWidget

List of all members, including inherited members

Public Functions

	KPluginWidget(QWidget *parent = nullptr)
void	addPlugins(const QList<KPluginMetaData> &plugins, const QString &categoryLabel)
void	clear()
QVariantList	configurationArguments() const
void	defaults()
bool	isDefault() const
bool	isSaveNeeded() const
`(since 5.91)` void	load()
void	save()
void	setAdditionalButtonHandler(const std::function<QPushButton (const KPluginMetaData &)> &handler*)
void	setConfig(const KConfigGroup &config)
void	setConfigurationArguments(const QVariantList &arguments)
void	setDefaultsIndicatorsVisible(bool isVisible)
void	showConfiguration(const QString &pluginId)

Signals

void	changed(bool enabled)
void	defaulted(bool isDefault)
void	pluginConfigSaved(const QString &pluginId)
void	pluginEnabledChanged(const QString &pluginId, bool enabled)

Detailed Description

Plugins that get added to the KPluginWidget need to define the X-KDE-ConfigModule property. The value for this property is the namespace and file name of the KCM for the plugin.

An example value is "kf6/krunner/kcms/kcm_krunner_charrunner", "kf6/krunner/kcms" is the namespace and "kcm_krunner_charrunner" the file name. The loaded KCMs don't need any embedded JSON metadata.

Member Function Documentation

`[explicit]` KPluginWidget::KPluginWidget(QWidget **parent* = nullptr)

void KPluginWidget::addPlugins(const QList<KPluginMetaData> &plugins, const QString &categoryLabel)

Adds the plugins with the given categoryLabel to the widget.

`[signal]` void KPluginWidget::changed(bool enabled)

Emitted when any of the plugins are changed.

enabled Whether the given plugin is enabled.

See also isSaveNeeded().

void KPluginWidget::clear()

Clears all the added plugins and any unsaved changes.

QVariantList KPluginWidget::configurationArguments() const

Returns the configuration arguments that will be used.

See also setConfigurationArguments().

`[signal]` void KPluginWidget::defaulted(bool isDefault)

Emitted after configuration is changed.

isDefault Returns whether the configuration state is the default.

void KPluginWidget::defaults()

Resets the enabled state of the plugins to their defaults.

bool KPluginWidget::isDefault() const

Returns true if the enabled state of each plugin is the same as that plugin's default state.

bool KPluginWidget::isSaveNeeded() const

Returns true if the plugin selector has any changes that are not yet saved to configuration.

See also save().

`[since 5.91]` void KPluginWidget::load()

Loads the enabled state of the plugins from the config set by setConfig() and clears any changes by the user.

This function was introduced in 5.91.

`[signal]` void KPluginWidget::pluginConfigSaved(const QString &pluginId)

Emitted after the config of an embedded KCM has been saved.

The pluginId is the name of the parent component that needs to reload its config.

`[signal]` void KPluginWidget::pluginEnabledChanged(const QString &pluginId, bool enabled)

Emitted when any of the plugins are changed.

pluginId The ID of the changed plugin.

enabled Whether the given plugin is currently enabled.

void KPluginWidget::save()

Saves the changes to the config set by setConfig.

void KPluginWidget::setAdditionalButtonHandler(const std::function<QPushButton (const KPluginMetaData &)> &handler*)

Add additional widgets to each row of the plugin selector.

handler Returns the additional button that should be displayed in the row; the handler can return a null pointer if no button should be displayed.

void KPluginWidget::setConfig(const KConfigGroup &config)

Sets the config object that will be used to store the enabled state of the plugins.

When porting away from KPluginSelector, the "Plugins" group from the config root should be used. For example:

KSharedConfig::openConfig(QStringLiteral("krunnerrc"))->group("Plugins")

void KPluginWidget::setConfigurationArguments(const QVariantList &arguments)

Sets the arguments with which the configuration modules will be initialized.

See also configurationArguments().

void KPluginWidget::setDefaultsIndicatorsVisible(bool isVisible)

Shows an indicator when a plugin status is different from default.

isVisible Whether the indicator is visible.

void KPluginWidget::showConfiguration(const QString &pluginId)

Shows the configuration dialog for the plugin pluginId if it's available.

Contents