KPluginModel

#include <KPluginModel>

Inheritance diagram for KPluginModel:

[legend]

Public Types
enum	Roles { NameRole = Qt::DisplayRole , IconRole = Qt::DecorationRole , EnabledRole = Qt::CheckStateRole , DescriptionRole = Qt::UserRole + 1 , IsChangeableRole , MetaDataRole , ConfigRole , IdRole , EnabledByDefaultRole , SortableRole }

Public Types inherited from QAbstractItemModel
enum	CheckIndexOption

enum	LayoutChangeHint

Public Member Functions
	KPluginModel (QObject *parent=nullptr)

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

void	addUnsortablePlugins (const QList< KPluginMetaData > &plugins, const QString &categoryLabel)

void	clear ()

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

Q_SIGNAL void	defaulted (bool isDefaulted)

void	defaults ()

KPluginMetaData	findConfigForPluginId (const QString &pluginId) const

bool	isSaveNeeded ()

Q_SIGNAL void	isSaveNeededChanged ()

void	load ()

bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild) override

void	removePlugin (const KPluginMetaData &data)

QHash< int, QByteArray >	roleNames () const override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

void	save ()

void	setConfig (const KConfigGroup &config)

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

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

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

virtual Qt::ItemFlags	flags (const QModelIndex &index) const const override

virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const const override

virtual QModelIndex	sibling (int row, int column, const QModelIndex &idx) const const override

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

virtual QModelIndex	buddy (const QModelIndex &index) const const

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const

virtual bool	canFetchMore (const QModelIndex &parent) const const

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options) const const

virtual bool	clearItemData (const QModelIndex &index)

virtual int	columnCount (const QModelIndex &parent) const const=0

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)

virtual void	fetchMore (const QModelIndex &parent)

virtual bool	hasChildren (const QModelIndex &parent) const const

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role) const const

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

bool	insertColumn (int column, const QModelIndex &parent)

virtual bool	insertColumns (int column, int count, const QModelIndex &parent)

bool	insertRow (int row, const QModelIndex &parent)

virtual bool	insertRows (int row, int count, const QModelIndex &parent)

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const const

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const

virtual QStringList	mimeTypes () const const

void	modelAboutToBeReset ()

void	modelReset ()

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const

virtual QModelIndex	parent (const QModelIndex &index) const const=0

bool	removeColumn (int column, const QModelIndex &parent)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

virtual bool	removeRows (int row, int count, const QModelIndex &parent)

virtual void	revert ()

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)

virtual void	sort (int column, Qt::SortOrder order)

virtual QSize	span (const QModelIndex &index) const const

virtual bool	submit ()

virtual Qt::DropActions	supportedDragActions () const const

virtual Qt::DropActions	supportedDropActions () const const

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

QBindable< QString >	bindableObjectName ()

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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, 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

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

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_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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	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	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

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

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

bool	signalsBlocked () const const

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

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

QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName

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)

Public Attributes inherited from QAbstractItemModel
typedef	CheckIndexOptions

	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, const void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const const

virtual void	resetInternalData ()

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 model that provides a list of available plugins and allows to disable/enable them.

Plugins need to define the X-KDE-ConfigModule property for their config modules to be found. 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.

See also: KPluginWidget

Since: 5.94

Definition at line 35 of file kpluginmodel.h.

Member Enumeration Documentation

◆ Roles

enum KPluginModel::Roles

Definition at line 40 of file kpluginmodel.h.

Constructor & Destructor Documentation

◆ KPluginModel()

KPluginModel::KPluginModel ( QObject * parent = nullptr )

explicit

Definition at line 71 of file kpluginmodel.cpp.

Member Function Documentation

◆ addPlugins()

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

Append plugins to the model.

This will not replace existing entries.

Parameters

plugins	the plugins to be added.
categoryLabel	a user-visible label for the section the plugins are added to.

Definition at line 189 of file kpluginmodel.cpp.

◆ addUnsortablePlugins()

void KPluginModel::addUnsortablePlugins	(	const QList< KPluginMetaData > &	plugins,
		const QString &	categoryLabel )

Add plugins that should not be sorted automatically based on their name This is useful in case your app has a custom sorting mechanism or implements reordering of plugins.

Since: 6.0

Definition at line 163 of file kpluginmodel.cpp.

◆ clear()

void KPluginModel::clear ( )

Removes all plugins.

Definition at line 224 of file kpluginmodel.cpp.

◆ data()

QVariant KPluginModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 79 of file kpluginmodel.cpp.

◆ defaulted()

Q_SIGNAL void KPluginModel::defaulted ( bool isDefaulted )

Emitted when the enabled state matches the default changes.

See also: defaults

◆ defaults()

void KPluginModel::defaults ( )

Reset the enabled state of the plugins to its defaults.

Definition at line 270 of file kpluginmodel.cpp.

◆ findConfigForPluginId()

KPluginMetaData KPluginModel::findConfigForPluginId ( const QString & pluginId ) const

Returns the KPluginMetaData object of the plugin's config module.

If no plugin is found or the plugin does not have a config, the resulting KPluginMetaData object will be invalid.

Since: 5.94

Definition at line 250 of file kpluginmodel.cpp.

◆ isSaveNeeded()

bool KPluginModel::isSaveNeeded ( )

Whether or not there are unsaved changes to the enabled state of the plugins.

Definition at line 289 of file kpluginmodel.cpp.

◆ isSaveNeededChanged()

Q_SIGNAL void KPluginModel::isSaveNeededChanged ( )

Emitted when isSaveNeeded is changed.

◆ load()

void KPluginModel::load ( )

Load the enabled state of the plugins from the config group set by setConfig.

Definition at line 260 of file kpluginmodel.cpp.

◆ moveRows()

bool KPluginModel::moveRows	(	const QModelIndex &	sourceParent,
		int	sourceRow,
		int	count,
		const QModelIndex &	destinationParent,
		int	destinationChild )

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 169 of file kpluginmodel.cpp.

◆ removePlugin()

void KPluginModel::removePlugin ( const KPluginMetaData & data )

Since: 6.0

Definition at line 205 of file kpluginmodel.cpp.

◆ roleNames()

QHash< int, QByteArray > KPluginModel::roleNames ( ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 148 of file kpluginmodel.cpp.

◆ rowCount()

int KPluginModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 143 of file kpluginmodel.cpp.

◆ save()

void KPluginModel::save ( )

Save the enabled state of the plugins to the config group set by setConfig.

Definition at line 238 of file kpluginmodel.cpp.

◆ setConfig()

void KPluginModel::setConfig ( const KConfigGroup & config )

Set the KConfigGroup that is used to load/save the enabled state.

Definition at line 215 of file kpluginmodel.cpp.

◆ setData()

bool KPluginModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = Qt::EditRole )

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 118 of file kpluginmodel.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KCMUtils

KPluginModel

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Roles

Constructor & Destructor Documentation

◆ KPluginModel()

Member Function Documentation

◆ addPlugins()

◆ addUnsortablePlugins()

◆ clear()

◆ data()

◆ defaulted()

◆ defaults()

◆ findConfigForPluginId()

◆ isSaveNeeded()

◆ isSaveNeededChanged()

◆ load()

◆ moveRows()

◆ removePlugin()

◆ roleNames()

◆ rowCount()

◆ save()

◆ setConfig()

◆ setData()