KWayland::Server::SubSurfaceInterface Class Reference

#include <subcompositor_interface.h>

Inheritance diagram for KWayland::Server::SubSurfaceInterface:

Public Types
enum	Mode { Synchronized, Desynchronized }

Properties
KWayland::Server::SubSurfaceInterface::Mode	mode
QPoint	position
Properties inherited from QObject
	objectName

Signals
void	modeChanged (KWayland::Server::SubSurfaceInterface::Mode)
void	positionChanged (const QPoint &)
Signals inherited from KWayland::Server::Resource
void	aboutToBeUnbound ()
void	unbound ()

Public Member Functions
bool	isSynchronized () const
QPointer< SurfaceInterface >	mainSurface () const
Mode	mode () const
QPointer< SurfaceInterface >	parentSurface ()
QPointer< SurfaceInterface >	parentSurface () const
QPoint	position () const
QPointer< SurfaceInterface >	surface ()
QPointer< SurfaceInterface >	surface () const
Public Member Functions inherited from KWayland::Server::Resource
ClientConnection *	client ()
void	create (ClientConnection *client, quint32 version, quint32 id)
Global *	global ()
quint32	id () const
wl_resource *	parentResource () const
wl_resource *	resource ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const

Additional Inherited Members
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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from KWayland::Server::Resource
	Resource (Private *d, QObject *parent=nullptr)
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
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Protected Attributes inherited from KWayland::Server::Resource
QScopedPointer< Private >	d

Detailed Description

Todo:

Add documentation

Definition at line 63 of file subcompositor_interface.h.

Member Function Documentation

bool KWayland::Server::SubSurfaceInterface::isSynchronized

(

)

const

Whether this SubSurfaceInterface is in synchronized mode.

A SubSurface is in synchronized mode if either mode is Mode::Synchronized or if the parent surface is in synchronized mode. If a SubSurfaceInterface is in synchronized mode all child SubSurfaceInterfaces are also in synchronized mode ignoring the actual mode.

Returns

Whether this SubSurfaceInterface is in synchronized mode.

See also

mode

Since

5.22

Definition at line 342 of file subcompositor_interface.cpp.

QPointer< SurfaceInterface > KWayland::Server::SubSurfaceInterface::mainSurface

(

)

const

Returns

the main surface for the sub-surface tree, that is the first surface without a parent

Since

5.22

Definition at line 360 of file subcompositor_interface.cpp.

QPointer< SurfaceInterface > KWayland::Server::SubSurfaceInterface::parentSurface

(

)

const

Returns

The parent surface for which this SubSurfaceInterface is a child

Since

5.22

Definition at line 330 of file subcompositor_interface.cpp.

QPointer< SurfaceInterface > KWayland::Server::SubSurfaceInterface::surface

(

)

const

Returns

The surface this SubSurfaceInterface was created on.

Since

5.22

Definition at line 317 of file subcompositor_interface.cpp.

---

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

• subcompositor_interface.h
• subcompositor_interface.cpp