\qmltype XdgPopup \nativetype QWaylandXdgPopup \inqmlmodule QtWayland.Compositor.XdgShell More...

#include <qwaylandxdgshell.h>

Inheritance diagram for QWaylandXdgPopup:

Collaboration diagram for QWaylandXdgPopup:

Signals
void	configuredGeometryChanged ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
QWaylandXdgSurface *	xdgSurface () const

QWaylandXdgSurface *	parentXdgSurface () const

QRect	configuredGeometry () const

QRect	anchorRect () const

Qt::Edges	anchorEdges () const

Qt::Edges	gravityEdges () const

Qt::Orientations	slideConstraints () const

Qt::Orientations	flipConstraints () const

Qt::Orientations	resizeConstraints () const

QPoint	offset () const

QSize	positionerSize () const

QPoint	unconstrainedPosition () const

Q_INVOKABLE uint	sendConfigure (const QRect &geometry)
	\qmlmethod int XdgPopup::sendConfigure(rect geometry)

	Q_REVISION (1, 14) Q_INVOKABLE void sendPopupDone()

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static QWaylandSurfaceRole *	role ()
	Returns the surface role for the QWaylandPopup.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Properties
QWaylandXdgSurface *	xdgSurface
	\qmlproperty XdgSurface XdgPopup::xdgSurface

QWaylandXdgSurface *	parentXdgSurface
	\qmlproperty XdgSurface XdgPopup::parentXdgSurface

QRect	configuredGeometry
	\qmlproperty rect XdgPopup::configuredGeometry

QRect	anchorRect
	\qmlproperty rect XdgPopup::anchorRect

Qt::Edges	anchorEdges
	\qmlproperty enumeration XdgPopup::anchorEdges

Qt::Edges	gravityEdges
	\qmlproperty rect XdgPopup::gravityEdges

Qt::Orientations	slideConstraints
	\qmlproperty enumeration XdgPopup::slideConstraints

Qt::Orientations	flipConstraints
	\qmlproperty enumeration XdgPopup::flipConstraints

Qt::Orientations	resizeConstraints
	\qmlproperty enumeration XdgPopup::resizeConstraints

QPoint	offset
	\qmlproperty point XdgPopup::offset

QSize	positionerSize
	\qmlproperty size XdgPopup::positionerSize

QPoint	unconstrainedPosition
	\qmlproperty point XdgPopup::unconstrainedPosition

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QWaylandXdgSurfacePrivate

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\qmltype XdgPopup \nativetype QWaylandXdgPopup \inqmlmodule QtWayland.Compositor.XdgShell

Since: 5.12

XdgPopup represents the popup specific parts of and xdg surface.

This type is part of the \l{XdgShell} extension and provides a way to extend extend the functionality of an \l{XdgSurface} with features specific to desktop-style menus for an xdg surface.

It corresponds to the Wayland interface xdg_popup.

\inmodule QtWaylandCompositor

Since: 5.12

The QWaylandXdgPopup class represents the popup specific parts of an xdg surface.

This class is part of the QWaylandXdgShell extension and provides a way to extend the functionality of a QWaylandXdgSurface with features specific to desktop-style menus for an xdg surface.

It corresponds to the Wayland interface xdg_popup.

Definition at line 209 of file qwaylandxdgshell.h.

Member Function Documentation

◆ anchorEdges()

Qt::Edges QWaylandXdgPopup::anchorEdges ( ) const

Definition at line 1677 of file qwaylandxdgshell.cpp.

◆ anchorRect()

QRect QWaylandXdgPopup::anchorRect ( ) const

Definition at line 1650 of file qwaylandxdgshell.cpp.

◆ configuredGeometry()

QRect QWaylandXdgPopup::configuredGeometry ( ) const

Definition at line 1631 of file qwaylandxdgshell.cpp.

◆ configuredGeometryChanged

void QWaylandXdgPopup::configuredGeometryChanged ( )

signal

◆ flipConstraints()

Qt::Orientations QWaylandXdgPopup::flipConstraints ( ) const

Definition at line 1753 of file qwaylandxdgshell.cpp.

◆ gravityEdges()

Qt::Edges QWaylandXdgPopup::gravityEdges ( ) const

Definition at line 1702 of file qwaylandxdgshell.cpp.

◆ offset()

QPoint QWaylandXdgPopup::offset ( ) const

Definition at line 1811 of file qwaylandxdgshell.cpp.

Referenced by testing.tools.fixup_pdf_template.TemplateProcessor::insert_xref_entry(), and testing.tools.fixup_pdf_template.TemplateProcessor::process_line().

Here is the caller graph for this function:

◆ parentXdgSurface()

QWaylandXdgSurface * QWaylandXdgPopup::parentXdgSurface ( ) const

Definition at line 1612 of file qwaylandxdgshell.cpp.

◆ positionerSize()

QSize QWaylandXdgPopup::positionerSize ( ) const

Definition at line 1828 of file qwaylandxdgshell.cpp.

◆ Q_REVISION()

QWaylandXdgPopup::Q_REVISION	(	1	,
		14	)

◆ resizeConstraints()

Qt::Orientations QWaylandXdgPopup::resizeConstraints ( ) const

Definition at line 1783 of file qwaylandxdgshell.cpp.

◆ role()

QWaylandSurfaceRole * QWaylandXdgPopup::role ( )

static

Returns the surface role for the QWaylandPopup.

Definition at line 1898 of file qwaylandxdgshell.cpp.

◆ sendConfigure()

uint QWaylandXdgPopup::sendConfigure ( const QRect & geometry )

\qmlmethod int XdgPopup::sendConfigure(rect geometry)

Sends a configure event to the client. geometry contains the window geometry relative to the upper left corner of the window geometry of the parent surface.

This implicitly sends a configure event to the corresponding XdgSurface as well.

Sends a configure event to the client. geometry contains the window geometry relative to the upper left corner of the window geometry of the parent surface.

This implicitly sends a configure event to the corresponding QWaylandXdgSurface as well.

Definition at line 1869 of file qwaylandxdgshell.cpp.

◆ slideConstraints()

Qt::Orientations QWaylandXdgPopup::slideConstraints ( ) const

Definition at line 1723 of file qwaylandxdgshell.cpp.

◆ unconstrainedPosition()

QPoint QWaylandXdgPopup::unconstrainedPosition ( ) const

Definition at line 1847 of file qwaylandxdgshell.cpp.

◆ xdgSurface()

QWaylandXdgSurface * QWaylandXdgPopup::xdgSurface ( ) const

Definition at line 1594 of file qwaylandxdgshell.cpp.

Friends And Related Symbol Documentation

◆ QWaylandXdgSurfacePrivate

friend class QWaylandXdgSurfacePrivate

friend

Definition at line 254 of file qwaylandxdgshell.h.

Property Documentation

◆ anchorEdges

Qt::Edges QWaylandXdgPopup::anchorEdges

read

\qmlproperty enumeration XdgPopup::anchorEdges

This property holds the set of edges on the anchor rect that the child surface should be placed relative to. If no edges are specified in a direction, the anchor point should be centered between the edges.

The possible values are: \value Qt.TopEdge The top edge of the rectangle. \value Qt.LeftEdge The left edge of the rectangle. \value Qt.RightEdge The right edge of the rectangle. \value Qt.BottomEdge The bottom edge of the rectangle.

Returns the set of edges on the anchor rect that the child surface should be placed relative to. If no edges are specified in a direction, the anchor point should be centered between the edges.

Definition at line 219 of file qwaylandxdgshell.h.

◆ anchorRect

QRect QWaylandXdgPopup::anchorRect

read

\qmlproperty rect XdgPopup::anchorRect

The anchor rectangle relative to the parent window geometry that the child surface should be placed relative to.

Returns the anchor rectangle relative to the parent window geometry that the child surface should be placed relative to.

Definition at line 218 of file qwaylandxdgshell.h.

◆ configuredGeometry

QRect QWaylandXdgPopup::configuredGeometry

read

\qmlproperty rect XdgPopup::configuredGeometry

The window geometry the popup received in the configure event. Relative to the upper left corner of the parent surface.

Definition at line 215 of file qwaylandxdgshell.h.

◆ flipConstraints

Qt::Orientations QWaylandXdgPopup::flipConstraints

read

\qmlproperty enumeration XdgPopup::flipConstraints

This property holds the orientations in which the child should flip to fit within the screen.

Possible values: \value Qt.Horizontal Horizontal \value Qt.Vertical Vertical

This property holds the orientations in which the child should flip to fit within the screen.

Definition at line 222 of file qwaylandxdgshell.h.

◆ gravityEdges

Qt::Edges QWaylandXdgPopup::gravityEdges

read

\qmlproperty rect XdgPopup::gravityEdges

Specifies in what direction the surface should be positioned, relative to the anchor point.

The possible values are: \value Qt.TopEdge The surface should slide towards the top of the screen. \value Qt.LeftEdge The surface should slide towards the left of the screen. \value Qt.RightEdge The surface should slide towards the right of the screen. \value Qt.BottomEdge The surface should slide towards the bottom of the screen.

Specifies in what direction the surface should be positioned, relative to the anchor point.

Definition at line 220 of file qwaylandxdgshell.h.

◆ offset

QPoint QWaylandXdgPopup::offset

read

\qmlproperty point XdgPopup::offset

The position relative to the position of the anchor on the anchor rectangle and the anchor on the surface.

Returns the surface position relative to the position of the anchor on the anchor rectangle and the anchor on the surface.

Definition at line 224 of file qwaylandxdgshell.h.

Referenced by testing.tools.fixup_pdf_template.TemplateProcessor::insert_xref_entry(), and testing.tools.fixup_pdf_template.TemplateProcessor::process_line().

◆ parentXdgSurface

QWaylandXdgSurface * QWaylandXdgPopup::parentXdgSurface

read

\qmlproperty XdgSurface XdgPopup::parentXdgSurface

This property holds the XdgSurface associated with the parent of this XdgPopup.

This property holds the QWaylandXdgSurface associated with the parent of this QWaylandXdgPopup.

Definition at line 214 of file qwaylandxdgshell.h.

◆ positionerSize

QSize QWaylandXdgPopup::positionerSize

read

\qmlproperty size XdgPopup::positionerSize

The size requested for the window geometry by the positioner object.

Returns the size requested for the window geometry by the positioner object.

Definition at line 225 of file qwaylandxdgshell.h.

◆ resizeConstraints

Qt::Orientations QWaylandXdgPopup::resizeConstraints

read

\qmlproperty enumeration XdgPopup::resizeConstraints

This property holds the orientations in which the child should resize to fit within the screen.

Possible values: \value Qt.Horizontal Horizontal \value Qt.Vertical Vertical

This property holds the orientations in which the child should resize to fit within the screen.

Definition at line 223 of file qwaylandxdgshell.h.

◆ slideConstraints

Qt::Orientations QWaylandXdgPopup::slideConstraints

read

\qmlproperty enumeration XdgPopup::slideConstraints

This property holds the orientations in which the child should slide to fit within the screen.

Possible values: \value Qt.Horizontal Horizontal \value Qt.Vertical Vertical

This property holds the orientations in which the child should slide to fit within the screen.

Definition at line 221 of file qwaylandxdgshell.h.

◆ unconstrainedPosition

QPoint QWaylandXdgPopup::unconstrainedPosition

read

\qmlproperty point XdgPopup::unconstrainedPosition

The position of the surface relative to the parent window geometry if the surface is not constrained. I.e. when not moved to fit inside the screen or similar.

Definition at line 226 of file qwaylandxdgshell.h.

◆ xdgSurface

QWaylandXdgSurface * QWaylandXdgPopup::xdgSurface

read

\qmlproperty XdgSurface XdgPopup::xdgSurface

This property holds the XdgSurface associated with this XdgPopup.

This property holds the QWaylandXdgSurface associated with this QWaylandXdgPopup.

Definition at line 213 of file qwaylandxdgshell.h.

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

qtwayland/src/compositor/extensions/qwaylandxdgshell.h (02b6ca807135c3c31dc70e18957a96af2208a214)
qtwayland/src/compositor/extensions/qwaylandxdgshell.cpp (e389b1e38e94182d4e568a59ede51089bc31bc81)

Signals

Public Member Functions

Static Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ anchorEdges()

◆ anchorRect()

◆ configuredGeometry()

◆ configuredGeometryChanged

◆ flipConstraints()

◆ gravityEdges()

◆ offset()

◆ parentXdgSurface()

◆ positionerSize()

◆ Q_REVISION()

◆ resizeConstraints()

◆ role()

◆ sendConfigure()

◆ slideConstraints()

◆ unconstrainedPosition()

◆ xdgSurface()

Friends And Related Symbol Documentation

◆ QWaylandXdgSurfacePrivate

Property Documentation

◆ anchorEdges

◆ anchorRect

◆ configuredGeometry

◆ flipConstraints

◆ gravityEdges

◆ offset

◆ parentXdgSurface

◆ positionerSize

◆ resizeConstraints

◆ slideConstraints

◆ unconstrainedPosition

◆ xdgSurface