KWayland::Client::SubCompositor Class Reference

#include <subcompositor.h>

Inheritance diagram for KWayland::Client::SubCompositor:

Signals
void	removed ()

Public Member Functions
	SubCompositor (QObject *parent=nullptr)
SubSurface *	createSubSurface (QPointer< Surface > surface, QPointer< Surface > parentSurface, QObject *parent=nullptr)
void	destroy ()
EventQueue *	eventQueue ()
bool	isValid () const
	operator wl_subcompositor * ()
	operator wl_subcompositor * () const
void	release ()
void	setEventQueue (EventQueue *queue)
void	setup (wl_subcompositor *subcompositor)
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
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 *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 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)

Detailed Description

Wrapper for the wl_subcompositor interface.

This class is a convenient wrapper for the wl_subcompositor interface. The main purpose of this class is to create SubSurfaces.

To create an instance use Registry::createSubCompositor.

See also

Registry

Definition at line 35 of file subcompositor.h.

Member Function Documentation

SubSurface * KWayland::Client::SubCompositor::createSubSurface	(	QPointer< Surface >	surface,
		QPointer< Surface >	parentSurface,
		QObject *	parent = nullptr
	)

Creates and setup a new SubSurface with parent.

Parameters

parent

The parent to pass to the Surface.

Returns

The new created Surface

Definition at line 54 of file subcompositor.cpp.

void KWayland::Client::SubCompositor::destroy

(

)

Destroys the data held by this SubCompositor.

This method is supposed to be used when the connection to the Wayland server goes away. If the connection is not valid anymore, it's not possible to call release anymore as that calls into the Wayland connection and the call would fail. This method cleans up the data, so that the instance can be deleted or set up to a new wl_subcompositor interface once there is a new connection available.

See also

release

Definition at line 42 of file subcompositor.cpp.

EventQueue * KWayland::Client::SubCompositor::eventQueue

(

)

Returns

The event queue to use for creating a SubSurface.

Definition at line 81 of file subcompositor.cpp.

bool KWayland::Client::SubCompositor::isValid

(

)

const

Returns

true if managing a wl_subcompositor.

Definition at line 66 of file subcompositor.cpp.

void KWayland::Client::SubCompositor::release

(

)

Releases the wl_subcompositor interface.

After the interface has been released the SubCompositor instance is no longer valid and can be setup with another wl_subcompositor interface.

Definition at line 37 of file subcompositor.cpp.

void KWayland::Client::SubCompositor::removed ( )

signal

The corresponding global for this interface on the Registry got removed.

This signal gets only emitted if the Compositor got created by Registry::createSubCompositor

Since

5.5

void KWayland::Client::SubCompositor::setEventQueue

(

EventQueue *

queue

)

Sets the queue to use for creating a SubSurface.

Definition at line 86 of file subcompositor.cpp.

void KWayland::Client::SubCompositor::setup

(

wl_subcompositor *

subcompositor

)

Setup this SubCompositor to manage the subcompositor.

When using Registry::createSubCompositor there is no need to call this method.

Definition at line 47 of file subcompositor.cpp.

---

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

• subcompositor.h
• subcompositor.cpp