KWayland::Client::PlasmaWindowModel Class Reference

#include <plasmawindowmodel.h>

Inheritance diagram for KWayland::Client::PlasmaWindowModel:

Public Types
enum	AdditionalRoles {   AppId = Qt::UserRole + 1, IsActive, IsFullscreenable, IsFullscreen,   IsMaximizable, IsMaximized, IsMinimizable, IsMinimized,   IsKeepAbove, IsKeepBelow, VirtualDesktop, IsOnAllDesktops,   IsDemandingAttention, SkipTaskbar, IsShadeable, IsShaded,   IsMovable, IsResizable, IsVirtualDesktopChangeable, IsCloseable,   Geometry, Pid, SkipSwitcher, VirtualDesktops,   Uuid, LastRole }
Public Types inherited from QAbstractItemModel
enum	CheckIndexOption
enum	LayoutChangeHint

Public Member Functions
	PlasmaWindowModel (PlasmaWindowManagement *parent)
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
QModelIndex	index (int row, int column=0, const QModelIndex &parent=QModelIndex()) const override
QMap< int, QVariant >	itemData (const QModelIndex &index) const override
Q_INVOKABLE void	requestActivate (int row)
Q_INVOKABLE void	requestClose (int row)
Q_INVOKABLE void	requestEnterVirtualDesktop (int row, const QString &id)
Q_INVOKABLE void	requestMove (int row)
Q_INVOKABLE void	requestResize (int row)
Q_INVOKABLE void	requestToggleKeepAbove (int row)
Q_INVOKABLE void	requestToggleKeepBelow (int row)
Q_INVOKABLE void	requestToggleMaximized (int row)
Q_INVOKABLE void	requestToggleMinimized (int row)
Q_INVOKABLE void	requestToggleShaded (int row)
Q_INVOKABLE void	requestVirtualDesktop (int row, quint32 desktop)
QHash< int, QByteArray >	roleNames () const override
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
Q_INVOKABLE void	setMinimizedGeometry (int row, Surface *panel, const QRect &geom)
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	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, QAbstractItemModel::CheckIndexOptions options) const const
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 &parent, int start, int end, const QModelIndex &destination, int column)
void	columnsRemoved (const QModelIndex &parent, int first, int last)
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< 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)
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 bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)
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 &parent, int start, int end, const QModelIndex &destination, int row)
void	rowsRemoved (const QModelIndex &parent, int first, int last)
virtual bool	setData (const QModelIndex &index, const QVariant &value, int role)
virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)
virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
void	setSupportedDragActions (Qt::DropActions actions)
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)
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	event (QEvent *e)
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

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)
QString	trUtf8 (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, quintptr id) const const
QModelIndex	createIndex (int row, int column, void *ptr) const const
void	endInsertColumns ()
void	endInsertRows ()
void	endMoveColumns ()
void	endMoveRows ()
void	endRemoveColumns ()
void	endRemoveRows ()
void	endResetModel ()
QModelIndexList	persistentIndexList () const const
void	reset ()
void	resetInternalData ()
void	setRoleNames (const QHash< int, QByteArray > &roleNames)
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

Exposes the window list and window state as a Qt item model.

This class is a QAbstractListModel implementation that exposes information from a PlasmaWindowManagement instance passed as parent and enables convenient calls to PlasmaWindow methods through a model row index.

The model is destroyed when the PlasmaWindowManagement parent is.

The model resets when the PlasmaWindowManagement parent signals that its interface is about to be destroyed.

To use this class you can create an instance yourself, or preferably use the convenience method in PlasmaWindowManagement:

PlasmaWindowModel *model = wm->createWindowModel();

See also

PlasmaWindowManagement

PlasmaWindow

Definition at line 42 of file plasmawindowmodel.h.

Member Enumeration Documentation

AdditionalRoles

enum KWayland::Client::PlasmaWindowModel::AdditionalRoles

Enumerator
VirtualDesktop	Deprecated: Since 5.53, use VirtualDesktops
IsShadeable	Since 5.22
IsShaded	Since 5.22
IsMovable	Since 5.22
IsResizable	Since 5.22
IsVirtualDesktopChangeable	Since 5.22
IsCloseable	Since 5.22
Geometry	Since 5.25
Pid	Since 5.35
SkipSwitcher	Since 5.47
VirtualDesktops	Since 5.53
Uuid	Since 5.73

Definition at line 47 of file plasmawindowmodel.h.

Member Function Documentation

index()

QModelIndex KWayland::Client::PlasmaWindowModel::index ( int  row, int  column = 0, const QModelIndex &  parent = QModelIndex()  ) const

overridevirtual

Returns an index with internalPointer() pointing to a PlasmaWindow instance.

Reimplemented from QAbstractListModel.

Definition at line 292 of file plasmawindowmodel.cpp.

requestActivate()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestActivate

(

int

row

)

Request the window at this model row index be activated.

Definition at line 297 of file plasmawindowmodel.cpp.

requestClose()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestClose

(

int

row

)

Request the window at this model row index be closed.

Definition at line 304 of file plasmawindowmodel.cpp.

requestEnterVirtualDesktop()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestEnterVirtualDesktop	(	int	row,
		const QString &	id
	)

Request the window at the model index row to be moved to the virtual desktop id.

Since

5.90

Definition at line 334 of file plasmawindowmodel.cpp.

requestMove()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestMove

(

int

row

)

Request an interactive move for the window at this model row index.

Since

5.22

Definition at line 311 of file plasmawindowmodel.cpp.

requestResize()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestResize

(

int

row

)

Request an interactive resize for the window at this model row index.

Since

5.22

Definition at line 318 of file plasmawindowmodel.cpp.

requestToggleKeepAbove()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestToggleKeepAbove

(

int

row

)

Requests the window at this model row index have its keep above state toggled.

Since

5.35

Definition at line 341 of file plasmawindowmodel.cpp.

requestToggleKeepBelow()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestToggleKeepBelow

(

int

row

)

Requests the window at this model row index have its keep above state toggled.

Since

5.35

Definition at line 348 of file plasmawindowmodel.cpp.

requestToggleMaximized()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestToggleMaximized

(

int

row

)

Requests the window at this model row index have its maximized state toggled.

Definition at line 362 of file plasmawindowmodel.cpp.

requestToggleMinimized()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestToggleMinimized

(

int

row

)

Requests the window at this model row index have its minimized state toggled.

Definition at line 355 of file plasmawindowmodel.cpp.

requestToggleShaded()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestToggleShaded

(

int

row

)

Requests the window at this model row index have its shaded state toggled.

Since

5.22

Definition at line 376 of file plasmawindowmodel.cpp.

requestVirtualDesktop()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::requestVirtualDesktop	(	int	row,
		quint32	desktop
	)

Request the window at this model row index be moved to this virtual desktop.

Deprecated:

Since 5.52; starting from 5.90, use requestEnterVirtualDesktop(int row, const QString &id) instead.

Definition at line 326 of file plasmawindowmodel.cpp.

setMinimizedGeometry()

Q_INVOKABLE void KWayland::Client::PlasmaWindowModel::setMinimizedGeometry	(	int	row,
		Surface *	panel,
		const QRect &	geom
	)

Sets the geometry of the taskbar entry for the window at the model row relative to a panel in particular.

QRectF, intended for use from QML

Since

5.5

Definition at line 369 of file plasmawindowmodel.cpp.

---

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

• plasmawindowmodel.h
• plasmawindowmodel.cpp