KWayland::Server::XdgForeignInterface Class Reference

#include <xdgforeign_interface.h>

Inheritance diagram for KWayland::Server::XdgForeignInterface:

Signals
void	transientChanged (KWayland::Server::SurfaceInterface *child, KWayland::Server::SurfaceInterface *parent)

Public Member Functions
	XdgForeignInterface (Display *display, QObject *parent=nullptr)
void	create ()
bool	isValid ()
SurfaceInterface *	transientFor (SurfaceInterface *surface)
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 QObject
typedef	QObjectList
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

This class encapsulates the server side logic of the XdgForeign protocol.

a process can export a surface to be identifiable by a server-wide unique string handle, and another process can in turn import that surface, and set it as transient parent for one of its own surfaces. This parent relationship is traced by the transientChanged signal and the transientFor method.

Since

5.40

Definition at line 33 of file xdgforeign_interface.h.

Member Function Documentation

create()

void KWayland::Server::XdgForeignInterface::create

(

)

Creates the native zxdg_exporter_v2 and zxdg_importer_v2 interfaces and announces them to the client.

Definition at line 45 of file xdgforeign_interface.cpp.

isValid()

bool KWayland::Server::XdgForeignInterface::isValid

(

)

Returns

true if theimporter and exporter are valid and functional

Definition at line 51 of file xdgforeign_interface.cpp.

transientChanged

void KWayland::Server::XdgForeignInterface::transientChanged ( KWayland::Server::SurfaceInterface *  child, KWayland::Server::SurfaceInterface *  parent  )

signal

A surface got a new imported transient parent.

Parameters

parent	is the surface exported by one client and imported into another, which will act as parent.
child	is the surface that the importer client did set as child of the surface that it imported. If one of the two parameters is nullptr, it means that a previously relation is not valid anymore and either one of the surfaces has been unmapped, or the parent surface is not exported anymore.

transientFor()

SurfaceInterface * KWayland::Server::XdgForeignInterface::transientFor

(

SurfaceInterface *

surface

)

If a client did import a surface and set one of its own as child of the imported one, this returns the mapping.

Parameters

surface

the child surface we want to search an imported transientParent for.

Returns

the transient parent of the surface, if found, nullptr otherwise.

Definition at line 56 of file xdgforeign_interface.cpp.

---

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

• xdgforeign_interface.h
• xdgforeign_interface.cpp