KWayland::Client::XdgShell
#include <xdgshell.h>

Signals | |
void | removed () |
Public Member Functions | |
XdgShellPopup * | createPopup (Surface *surface, Surface *parentSurface, Seat *seat, quint32 serial, const QPoint &parentPos, QObject *parent=nullptr) |
XdgShellPopup * | createPopup (Surface *surface, XdgShellPopup *parentSurface, const XdgPositioner &positioner, QObject *parent=nullptr) |
XdgShellPopup * | createPopup (Surface *surface, XdgShellSurface *parentSurface, const XdgPositioner &positioner, QObject *parent=nullptr) |
XdgShellSurface * | createSurface (Surface *surface, QObject *parent=nullptr) |
void | destroy () |
EventQueue * | eventQueue () |
bool | isValid () const |
operator xdg_shell * () | |
operator xdg_shell * () const | |
operator xdg_wm_base * () | |
operator xdg_wm_base * () const | |
operator zxdg_shell_v6 * () | |
operator zxdg_shell_v6 * () const | |
void | release () |
void | setEventQueue (EventQueue *queue) |
void | setup (xdg_shell *xdgshellv5) |
void | setup (xdg_wm_base *xdg_wm_base) |
void | setup (zxdg_shell_v6 *xdgshellv6) |
![]() | |
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 | |
XdgShell (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) |
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 xdg_shell interface.
This class provides a convenient wrapper for the xdg_shell interface.
To use this class one needs to interact with the Registry. There are two possible ways to create the XdgShell interface:
This creates the XdgShell and sets it up directly. As an alternative this can also be done in a more low level way:
The XdgShell can be used as a drop-in replacement for any xdg_shell pointer as it provides matching cast operators.
- See also
- Registry
- Since
- 5.25
Definition at line 155 of file xdgshell.h.
Member Function Documentation
◆ createPopup() [1/3]
XdgShellPopup * KWayland::Client::XdgShell::createPopup | ( | Surface * | surface, |
Surface * | parentSurface, | ||
Seat * | seat, | ||
quint32 | serial, | ||
const QPoint & | parentPos, | ||
QObject * | parent = nullptr |
||
) |
Creates a new XdgShellPopup for the given surface
on top of parentSurface
.
This method is only valid for Xdgv5
Definition at line 106 of file xdgshell.cpp.
◆ createPopup() [2/3]
XdgShellPopup * KWayland::Client::XdgShell::createPopup | ( | Surface * | surface, |
XdgShellPopup * | parentSurface, | ||
const XdgPositioner & | positioner, | ||
QObject * | parent = nullptr |
||
) |
Creates a new XdgShellPopup for the given surface
on top of parentSurface
with the given positioner
.
- Since
- 5.39
Definition at line 116 of file xdgshell.cpp.
◆ createPopup() [3/3]
XdgShellPopup * KWayland::Client::XdgShell::createPopup | ( | Surface * | surface, |
XdgShellSurface * | parentSurface, | ||
const XdgPositioner & | positioner, | ||
QObject * | parent = nullptr |
||
) |
Creates a new XdgShellPopup for the given surface
on top of parentSurface
with the given positioner
.
This method is only valid for Xdgv6 onwards.
- Since
- 5.39
Definition at line 111 of file xdgshell.cpp.
◆ createSurface()
XdgShellSurface * KWayland::Client::XdgShell::createSurface | ( | Surface * | surface, |
QObject * | parent = nullptr |
||
) |
Creates a new XdgShellSurface for the given surface
.
Definition at line 101 of file xdgshell.cpp.
◆ destroy()
void KWayland::Client::XdgShell::destroy | ( | ) |
Destroys the data held by this XdgShell.
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 xdg_shell interface once there is a new connection available.
This method is automatically invoked when the Registry which created this XdgShell gets destroyed.
- See also
- release
Definition at line 51 of file xdgshell.cpp.
◆ eventQueue()
EventQueue * KWayland::Client::XdgShell::eventQueue | ( | ) |
- Returns
- The event queue to use for creating objects with this XdgShell.
Definition at line 61 of file xdgshell.cpp.
◆ isValid()
bool KWayland::Client::XdgShell::isValid | ( | ) | const |
- Returns
true
if managing a xdg_shell.
Definition at line 96 of file xdgshell.cpp.
◆ release()
void KWayland::Client::XdgShell::release | ( | ) |
Releases the xdg_shell interface.
After the interface has been released the XdgShell instance is no longer valid and can be setup with another xdg_shell interface.
Definition at line 46 of file xdgshell.cpp.
◆ removed
|
signal |
The corresponding global for this interface on the Registry got removed.
This signal gets only emitted if the XdgShell got created by Registry::createXdgShell
◆ setEventQueue()
void KWayland::Client::XdgShell::setEventQueue | ( | EventQueue * | queue | ) |
Sets the queue
to use for creating objects with this XdgShell.
Definition at line 56 of file xdgshell.cpp.
◆ setup() [1/3]
void KWayland::Client::XdgShell::setup | ( | xdg_shell * | xdgshellv5 | ) |
Setup this XdgShell to manage the xdgshellv5
.
When using Registry::createXdgShell there is no need to call this method.
Definition at line 31 of file xdgshell.cpp.
◆ setup() [2/3]
void KWayland::Client::XdgShell::setup | ( | xdg_wm_base * | xdg_wm_base | ) |
Setup this XdgShell to manage the xdg_wm_base
.
When using Registry::createXdgShell there is no need to call this method.
Definition at line 41 of file xdgshell.cpp.
◆ setup() [3/3]
void KWayland::Client::XdgShell::setup | ( | zxdg_shell_v6 * | xdgshellv6 | ) |
Setup this XdgShell to manage the xdgshellv6
.
When using Registry::createXdgShell there is no need to call this method.
Definition at line 36 of file xdgshell.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Feb 5 2023 03:56:52 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.