KWayland::Client::XdgShellPopup Class Reference

#include <xdgshell.h>

Inheritance diagram for KWayland::Client::XdgShellPopup:

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 (zxdg_surface_v6 *xdgsurfacev6, zxdg_popup_v6 *xdgpopup6)
void	setup (xdg_surface *xdgsurface, xdg_popup *xdgpopup)
void	setWindowGeometry (const QRect &windowGeometry)
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
	XdgShellPopup (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)

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

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 522 of file xdgshell.h.

Member Function Documentation

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 368 of file xdgshell.cpp.

void KWayland::Client::XdgShellPopup::configureRequested ( const QRect &  relativePosition, quint32  serial  )

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

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:

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

See also

release

Definition at line 348 of file xdgshell.cpp.

EventQueue * KWayland::Client::XdgShellPopup::eventQueue

(

)

Returns

The event queue to use for bound proxies.

Definition at line 358 of file xdgshell.cpp.

bool KWayland::Client::XdgShellPopup::isValid

(

)

const

Returns

true if managing an xdg_popup.

Definition at line 410 of file xdgshell.cpp.

void KWayland::Client::XdgShellPopup::popupDone ( )

signal

This signal is emitted when a XdgShellPopup is dismissed by the compositor.

The user should delete this instance at this point.

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 343 of file xdgshell.cpp.

void KWayland::Client::XdgShellPopup::requestGrab	(	Seat *	seat,
		quint32	serial
	)

Requests a grab on this popup.

Since

5.39

Definition at line 363 of file xdgshell.cpp.

void KWayland::Client::XdgShellPopup::setEventQueue

(

EventQueue *

queue

)

Sets the queue to use for bound proxies.

Definition at line 353 of file xdgshell.cpp.

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.

This was for XDGShellV5, this is now deprecated

Definition at line 328 of file xdgshell.cpp.

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 333 of file xdgshell.cpp.

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 338 of file xdgshell.cpp.

void KWayland::Client::XdgShellPopup::setWindowGeometry

(

const QRect &

windowGeometry

)

Sets the position of the window contents within the buffer.

Since

5.59

Definition at line 373 of file xdgshell.cpp.

---

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

• xdgshell.h
• xdgshell.cpp