KWayland::Client::XdgImporter
#include <xdgforeign.h>

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 *) |
![]() | |
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 ®Exp, 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 ®Exp) |
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 |
Protected Member Functions | |
XdgImporter (Private *p, QObject *parent=nullptr) | |
![]() | |
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) |
Protected Attributes | |
QScopedPointer< Private > | d |
Additional Inherited Members | |
![]() | |
objectName | |
![]() | |
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) |
![]() | |
typedef | QObjectList |
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 XdgImporter interface:
This creates the XdgImporter and sets it up directly. As an alternative this can also be done in a more low level way:
The XdgImporter 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 152 of file xdgforeign.h.
Member Function Documentation
◆ destroy()
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:
- See also
- release
Definition at line 112 of file xdgforeign.cpp.
◆ eventQueue()
EventQueue * KWayland::Client::XdgImporter::eventQueue | ( | ) |
- Returns
- The event queue to use for creating objects with this .
Definition at line 137 of file xdgforeign.cpp.
◆ importTopLevel()
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 142 of file xdgforeign.cpp.
◆ isValid()
bool KWayland::Client::XdgImporter::isValid | ( | ) | const |
- Returns
true
if managing a zxdg_importer_v2.
Definition at line 127 of file xdgforeign.cpp.
◆ release()
void KWayland::Client::XdgImporter::release | ( | ) |
Releases the zxdg_importer_v2 interface.
After the interface has been released the XdgImporter instance is no longer valid and can be setup with another zxdg_importer_v2 interface.
Definition at line 107 of file xdgforeign.cpp.
◆ removed
|
signal |
The corresponding global for this interface on the Registry got removed.
This signal gets only emitted if the XdgImporter got created by Registry::create
◆ setEventQueue()
void KWayland::Client::XdgImporter::setEventQueue | ( | EventQueue * | queue | ) |
Sets the queue
to use for creating objects with this .
Definition at line 132 of file xdgforeign.cpp.
◆ setup()
void KWayland::Client::XdgImporter::setup | ( | zxdg_importer_v2 * | importer | ) |
Setup this XdgImporter to manage the .
When using Registry::create there is no need to call this method.
Definition at line 102 of file xdgforeign.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Sep 26 2023 03:48:30 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.