KWayland::Client::XdgImporter Class Reference

#include <xdgforeign.h>

Inheritance diagram for KWayland::Client::XdgImporter:

Signals
void	removed ()

Public Member Functions
void	destroy ()
EventQueue *	eventQueue ()
XdgImported *	importTopLevel (const QString &handle, QObject *parent=nullptr)
bool	isValid () const
	operator zxdg_importer_v2 * ()
	operator zxdg_importer_v2 * () const
void	release ()
void	setEventQueue (EventQueue *queue)
void	setup (zxdg_importer_v2 *)
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

Protected Member Functions
	XdgImporter (Private *p, 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
QScopedPointer< Private >	d

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)

Detailed Description

Wrapper for the zxdg_importer_v2 interface.

This class provides a convenient wrapper for the zxdg_importer_v2 interface.

To use this class one needs to interact with the Registry. There are two possible ways to create the interface:

*c = registry->create(name, version);

This creates the and sets it up directly. As an alternative this can also be done in a more low level way:

 *c = new ;
c->setup(registry->bind(name, version));

The can be used as a drop-in replacement for any zxdg_importer_v2 pointer as it provides matching cast operators.

See also

Registry

Definition at line 167 of file xdgforeign.h.

Member Function Documentation

void KWayland::Client::XdgImporter::destroy

(

)

Destroys the data held by this .

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 zxdg_importer_v2 interface once there is a new connection available.

It is suggested to connect this method to ConnectionThread::connectionDied:

connect(connection, &ConnectionThread::connectionDied, , &::destroy);

See also

release

Definition at line 127 of file xdgforeign.cpp.

EventQueue * KWayland::Client::XdgImporter::eventQueue

(

)

Returns

The event queue to use for creating objects with this .

Definition at line 150 of file xdgforeign.cpp.

XdgImported * KWayland::Client::XdgImporter::importTopLevel	(	const QString &	handle,
		QObject *	parent = nullptr
	)

Imports a surface from any client given a handle retrieved by exporting said surface using XdgExporter::exportTopLevel.

When called, a new XdgImported object will be created. This new object represents the imported surface, and the importing client can manipulate its relationship using it.

Parameters

handle	the unique handle that represent an exported toplevel surface. it has to have been generated by the XdgExporter by either this or some other process (which would have communicated the handle in some way, such as command line or a DBus call)
parent	the parent in the QObject's hierarchy of the new XdgImported

Definition at line 155 of file xdgforeign.cpp.

bool KWayland::Client::XdgImporter::isValid

(

)

const

Returns

true if managing a zxdg_importer_v2.

Definition at line 140 of file xdgforeign.cpp.

void KWayland::Client::XdgImporter::release

(

)

Releases the zxdg_importer_v2 interface.

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

Definition at line 122 of file xdgforeign.cpp.

void KWayland::Client::XdgImporter::removed ( )

signal

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

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

void KWayland::Client::XdgImporter::setEventQueue

(

EventQueue *

queue

)

Sets the queue to use for creating objects with this .

Definition at line 145 of file xdgforeign.cpp.

void KWayland::Client::XdgImporter::setup

(

zxdg_importer_v2 *

importer

)

Setup this to manage the .

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

Definition at line 117 of file xdgforeign.cpp.

---

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

• xdgforeign.h
• xdgforeign.cpp