KPluginSelector

#include <kpluginselector.h>

Inheritance diagram for KPluginSelector:

[legend]

Public Types
enum	PluginLoadMethod { ReadConfigFile = 0, IgnoreConfigFile }

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
var	__aboutDialog

QStringList	configurationArguments

var	query

QtObject	sourceModel

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Signals
void	changed (bool hasChanged)

void	configCommitted (const QByteArray &componentName)

void	defaulted (bool isDefault)

void	defaultsIndicatorsVisible ()

Public Member Functions
	KPluginSelector (QWidget *parent=nullptr)

	~KPluginSelector () override

void	addPlugins (const QList< KPluginInfo > &pluginInfoList, PluginLoadMethod pluginLoadMethod=ReadConfigFile, const QString &categoryName=QString(), const QString &categoryKey=QString(), const KSharedConfig::Ptr &config=KSharedConfig::Ptr())

void	addPlugins (const QString &componentName, const QString &categoryName=QString(), const QString &categoryKey=QString(), KSharedConfig::Ptr config=KSharedConfig::Ptr())

void	clearPlugins ()

QStringList	configurationArguments () const

void	defaults ()

bool	isDefault () const

bool	isSaveNeeded () const

void	load ()

void	save ()

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

void	setConfigurationArguments (const QStringList &arguments)

void	setDefaultsIndicatorsVisible (bool isVisible)

void	showConfiguration (const QString &pluginId)

void	updatePluginsState ()

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

void	getContentsMargins (int left, int top, int right, int bottom) const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

virtual int	heightForWidth (int w) const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isEnabledToTLW () const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

virtual QSize	minimumSizeHint () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

virtual QSize	sizeHint () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

int	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

typedef	RenderFlags

Public Attributes inherited from QObject
typedef	QObjectList

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual bool	event (QEvent *event) override

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (QPaintDevice::PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, long result)

virtual void	paintEvent (QPaintEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

A widget to select what plugins to load and configure the plugins.

ListView for showing plugins with their info and configuration.

It shows the list of available plugins

Since the user needs a way to know what a specific plugin does every plugin should install a desktop file containing a name, comment and category field. The category is useful for applications that can use different kinds of plugins like a playlist, skin or visualization

The location of these desktop files is the share/apps/<instancename>/<plugindir> directory. But if you need you may use a different directory

You can add plugins from different KConfig[group], by just calling all times you want addPlugins method with the correct parameters

Additionally, calls to constructor with same categoryName, will add new items to the same category, even if plugins are from different categories

Author: Matthias Kretz kretz[email protected]@kde[email protected].org; Rafael Fernández López eresl[email protected]ibre[email protected]@kde.[email protected]org

Deprecated:: Since 5.90, use KPluginWidget instead

Since: 1.0 If extra butons should be added, a custom KPluginDelegate with the additionalActions property should be defined.; 5.94

Definition at line 49 of file kpluginselector.h.

Constructor & Destructor Documentation

◆ KPluginSelector()

KPluginSelector::KPluginSelector ( QWidget * parent = nullptr )

Create a new KPluginSelector.

Definition at line 255 of file kpluginselector.cpp.

◆ ~KPluginSelector()

KPluginSelector::~KPluginSelector ( )

override

Destructor.

Definition at line 303 of file kpluginselector.cpp.

Member Function Documentation

◆ addPlugins() [1/2]

void KPluginSelector::addPlugins	(	const QList< KPluginInfo > &	pluginInfoList,
		PluginLoadMethod	pluginLoadMethod = `ReadConfigFile`,
		const QString &	categoryName = `QString()`,
		const QString &	categoryKey = `QString()`,
		const KSharedConfig::Ptr &	config = `KSharedConfig::Ptr()`
	)

Add a list of non-KParts plugins.

Parameters

pluginInfoList	A list of KPluginInfo objects containing the necessary information for the plugins you want to add to the list
pluginLoadMethod	If KPluginSelector will try to load the state of the plugin when loading the dialog from the configuration file or not. This is useful if for some reason you called the setPluginEnabled() for each plugin individually before loading the dialog, and don't want KPluginSelector to override them when loading
categoryName	The translated name of the category. This is the name that is shown in the title. If the category did exist before because of another call to addPlugins, then they will be shown in that category. If `categoryName` is a new one, then a new category will be shown on the plugin window, and the list of plugins added to it
categoryKey	When you have different categories of KParts plugins you distinguish between the plugins using the Category key in the .desktop file. Use this parameter to select only those KParts plugins with the Category key == `categoryKey`. If `categoryKey` is not set the Category key is ignored and all plugins are shown. Not match case
config	The KConfig object that holds the state of the plugins being enabled or not. By default it will use KSharedConfig::openConfig(). It is recommended to always pass a KConfig object if you use KSettings::PluginPage since you never know from where the page will be called (think global config app). For example KViewCanvas passes KConfig("kviewcanvas")

Note: All plugins that were set a config group using setConfig() method will load and save their information from there. For those that weren't any config object, config will be used

Definition at line 340 of file kpluginselector.cpp.

◆ addPlugins() [2/2]

void KPluginSelector::addPlugins	(	const QString &	componentName,
		const QString &	categoryName = `QString()`,
		const QString &	categoryKey = `QString()`,
		KSharedConfig::Ptr	config = `KSharedConfig::Ptr()`
	)

Add a list of KParts plugins.

The information about the plugins will be loaded from the share/apps/<instancename>/kpartplugins directory

Parameters

componentName	The name of the component of the plugin's parent.
categoryName	The translated name of the category. This is the name that is shown in the title. If the category did exist before because of another call to addPlugins, then they will be shown in that category. If `categoryName` is a new one, then a new category will be shown on the plugin window, and the list of plugins added to it
categoryKey	When you have different categories of KParts plugins you distinguish between the plugins using the Category key in the .desktop file. Use this parameter to select only those KParts plugins with the Category key == `categoryKey`. If `categoryKey` is not set the Category key is ignored and all plugins are shown. Not match case
config	The KConfig object that holds the state of the plugins being enabled or not. By default it will be set to KSharedConfig::openConfig(componentName + "rc").

Definition at line 310 of file kpluginselector.cpp.

◆ changed

void KPluginSelector::changed ( bool hasChanged )

signal

Tells you whether the configuration is changed or not.

◆ clearPlugins()

void KPluginSelector::clearPlugins ( )

Remove all plugins from the entry list.

Since: 5.73

Definition at line 357 of file kpluginselector.cpp.

◆ configCommitted

void KPluginSelector::configCommitted ( const QByteArray & componentName )

signal

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

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

◆ configurationArguments()

QStringList KPluginSelector::configurationArguments ( ) const

Returns the configuration arguments that will be used.

Since: 5.9

◆ defaulted

void KPluginSelector::defaulted ( bool isDefault )

signal

Emitted after configuration is changed, tell if configuration represent default or not.

Since: 5.67

◆ defaults()

void KPluginSelector::defaults ( )

Change to applications defaults.

See also: isDefault()

Definition at line 402 of file kpluginselector.cpp.

◆ defaultsIndicatorsVisible

void KPluginSelector::defaultsIndicatorsVisible ( )

signal

Emitted when show defaults indicators changed.

See also: setDefaultsIndicatorsVisible

Since: 5.78

◆ isDefault()

bool KPluginSelector::isDefault ( ) const

Returns true if the plugin selector does not have any changes to application defaults.

See also: defaults()

Since: 4.3

Definition at line 421 of file kpluginselector.cpp.

◆ isSaveNeeded()

bool KPluginSelector::isSaveNeeded ( ) const

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

See also: save()

Since: 5.78

Definition at line 389 of file kpluginselector.cpp.

◆ load()

void KPluginSelector::load ( )

Load the state of the plugins (selected or not) from the KPluginInfo objects.

Definition at line 362 of file kpluginselector.cpp.

◆ save()

void KPluginSelector::save ( )

Save the configuration.

Definition at line 375 of file kpluginselector.cpp.

◆ setAdditionalButtonHandler()

void KPluginSelector::setAdditionalButtonHandler ( std::function< QPushButton *(const KPluginInfo &)> handler )

Add additional widgets to each row of the plugin selector.

Parameters

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

Since: 5.74

Definition at line 476 of file kpluginselector.cpp.

◆ setConfigurationArguments()

void KPluginSelector::setConfigurationArguments ( const QStringList & arguments )

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

Since: 5.9

Definition at line 446 of file kpluginselector.cpp.

◆ setDefaultsIndicatorsVisible()

void KPluginSelector::setDefaultsIndicatorsVisible ( bool isVisible )

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

Since: 5.78

Definition at line 481 of file kpluginselector.cpp.

◆ showConfiguration()

void KPluginSelector::showConfiguration ( const QString & pluginId )

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

Since: 5.45

Definition at line 456 of file kpluginselector.cpp.

◆ updatePluginsState()

void KPluginSelector::updatePluginsState ( )

Updates plugins state (enabled or not)

This method won't save anything on any configuration file. It will just be useful if you added plugins with the method:

void addPlugins(const QList<KPluginInfo> &pluginInfoList,
                const QString &categoryName = QString(),
                const QString &categoryKey = QString(),
                const KSharedConfig::Ptr &config = KSharedConfig::Ptr());

To sum up, this method will update your plugins state depending if plugins are ticked or not on the KPluginSelector dialog, without saving anything anywhere

Definition at line 434 of file kpluginselector.cpp.

The documentation for this class was generated from the following files:

QList

Definition: dialog.h:19

QString

KPluginSelector::addPlugins

void addPlugins(const QString &componentName, const QString &categoryName=QString(), const QString &categoryKey=QString(), KSharedConfig::Ptr config=KSharedConfig::Ptr())

Add a list of KParts plugins.

Definition: kpluginselector.cpp:310

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KCMUtils

KPluginSelector

Public Types

Properties

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KPluginSelector()

◆ ~KPluginSelector()

Member Function Documentation

◆ addPlugins() [1/2]

◆ addPlugins() [2/2]

◆ changed

◆ clearPlugins()

◆ configCommitted

◆ configurationArguments()

◆ defaulted

◆ defaults()

◆ defaultsIndicatorsVisible

◆ isDefault()

◆ isSaveNeeded()

◆ load()

◆ save()

◆ setAdditionalButtonHandler()

◆ setConfigurationArguments()

◆ setDefaultsIndicatorsVisible()

◆ showConfiguration()

◆ updatePluginsState()