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

Signals | |
void | configureRequested (const QRect &relativePosition, quint32 serial) |
void | popupDone () |
Public Member Functions | |
void | ackConfigure (quint32 serial) |
void | destroy () |
EventQueue * | eventQueue () |
bool | isValid () const |
operator xdg_popup * () | |
operator xdg_popup * () const | |
operator xdg_surface * () | |
operator xdg_surface * () const | |
operator zxdg_popup_v6 * () | |
operator zxdg_popup_v6 * () const | |
operator zxdg_surface_v6 * () | |
operator zxdg_surface_v6 * () const | |
void | release () |
void | requestGrab (Seat *seat, quint32 serial) |
void | setEventQueue (EventQueue *queue) |
void | setup (xdg_popup *xdgpopupv5) |
void | setup (xdg_surface *xdgsurface, xdg_popup *xdgpopup) |
void | setup (zxdg_surface_v6 *xdgsurfacev6, zxdg_popup_v6 *xdgpopup6) |
void | setWindowGeometry (const QRect &windowGeometry) |
![]() | |
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 | |
XdgShellPopup (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
A XdgShellPopup is a short-lived, temporary surface that can be used to implement menus.
It takes an explicit grab on the surface that will be dismissed when the user dismisses the popup. This can be done by the user clicking outside the surface, using the keyboard, or even locking the screen through closing the lid or a timeout.
- Since
- 5.25
Definition at line 511 of file xdgshell.h.
Member Function Documentation
◆ ackConfigure()
void KWayland::Client::XdgShellPopup::ackConfigure | ( | quint32 | serial | ) |
When a configure event is received, if a client commits the Surface in response to the configure event, then the client must make an ackConfigure request sometime before the commit request, passing along the serial
of the configure event.
- See also
- configureRequested
- Since
- 5.56
Definition at line 364 of file xdgshell.cpp.
◆ configureRequested
|
signal |
Emitted when the server has configured the popup with the final location of relativePosition
This is emitted for V6 surfaces only.
- Since
- 5.39
◆ destroy()
void KWayland::Client::XdgShellPopup::destroy | ( | ) |
Destroys the data held by this XdgShellPopup.
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_popup interface once there is a new connection available.
It is suggested to connect this method to ConnectionThread::connectionDied:
- See also
- release
Definition at line 344 of file xdgshell.cpp.
◆ eventQueue()
EventQueue * KWayland::Client::XdgShellPopup::eventQueue | ( | ) |
- Returns
- The event queue to use for bound proxies.
Definition at line 354 of file xdgshell.cpp.
◆ isValid()
bool KWayland::Client::XdgShellPopup::isValid | ( | ) | const |
- Returns
true
if managing an xdg_popup.
Definition at line 414 of file xdgshell.cpp.
◆ popupDone
|
signal |
This signal is emitted when a XdgShellPopup is dismissed by the compositor.
The user should delete this instance at this point.
◆ release()
void KWayland::Client::XdgShellPopup::release | ( | ) |
Releases the xdg_popup interface.
After the interface has been released the XdgShellPopup instance is no longer valid and can be setup with another xdg_popup interface.
Definition at line 339 of file xdgshell.cpp.
◆ requestGrab()
void KWayland::Client::XdgShellPopup::requestGrab | ( | Seat * | seat, |
quint32 | serial | ||
) |
◆ setEventQueue()
void KWayland::Client::XdgShellPopup::setEventQueue | ( | EventQueue * | queue | ) |
Sets the queue
to use for bound proxies.
Definition at line 349 of file xdgshell.cpp.
◆ setup() [1/3]
void KWayland::Client::XdgShellPopup::setup | ( | xdg_popup * | xdgpopupv5 | ) |
Setup this XdgShellPopup to manage the xdgpopupv5
.
When using XdgShell::createXdgShellPopup there is no need to call this method.
- Deprecated:
- Since 5.49. This was for XDGShellV5, this is now deprecated
Definition at line 324 of file xdgshell.cpp.
◆ setup() [2/3]
void KWayland::Client::XdgShellPopup::setup | ( | xdg_surface * | xdgsurface, |
xdg_popup * | xdgpopup | ||
) |
Setup this XdgShellPopup to manage the xdgpopupv
on associated xdgsurface
When using XdgShell::createXdgShellPopup there is no need to call this method.
- Since
- 5.XDGSTABLE
Definition at line 334 of file xdgshell.cpp.
◆ setup() [3/3]
void KWayland::Client::XdgShellPopup::setup | ( | zxdg_surface_v6 * | xdgsurfacev6, |
zxdg_popup_v6 * | xdgpopup6 | ||
) |
Setup this XdgShellPopup to manage the xdgpopupv6
on associated xdgsurfacev6
When using XdgShell::createXdgShellPopup there is no need to call this method.
- Since
- 5.39
Definition at line 329 of file xdgshell.cpp.
◆ setWindowGeometry()
void KWayland::Client::XdgShellPopup::setWindowGeometry | ( | const QRect & | windowGeometry | ) |
Sets the position of the window contents within the buffer.
- Since
- 5.59
Definition at line 369 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.