QWaylandQuickItem Class

The QWaylandQuickItem class provides a Qt Quick item representing a QWaylandView. More...

Header:	#include <QWaylandQuickItem>
CMake:	find_package(Qt6 COMPONENTS Waylandcompositor REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Waylandcompositor)
qmake:	QT += waylandcompositor
Since:	Qt 5.8
Inherits:	QQuickItem
Inherited By:	QWaylandQuickShellSurfaceItem

• List of all members, including inherited members

Properties

allowDiscardFrontBuffer : bool bufferLocked : bool compositor : QWaylandCompositor* const focusOnClick : bool origin : const QWaylandSurface::Origin

output : QWaylandOutput* paintEnabled : bool surface : QWaylandSurface* touchEventsEnabled : bool

Public Functions

	QWaylandQuickItem(QQuickItem *parent = nullptr)
virtual	~QWaylandQuickItem() override
bool	allowDiscardFrontBuffer() const
QWaylandCompositor *	compositor() const
bool	focusOnClick() const
bool	inputEventsEnabled() const
bool	inputRegionContains(const QPointF &localPosition) const
bool	isBufferLocked() const
bool	isPaintEnabled() const
QPointF	mapFromSurface(const QPointF &point) const
QPointF	mapToSurface(const QPointF &point) const
QWaylandSurface::Origin	origin() const
QWaylandOutput *	output() const
void	setAllowDiscardFrontBuffer(bool discard)
void	setBufferLocked(bool locked)
void	setFocusOnClick(bool focus)
void	setInputEventsEnabled(bool enabled)
void	setOutput(QWaylandOutput *output)
void	setPrimary()
void	setSubsurfaceHandler(QObject *)
void	setSurface(QWaylandSurface *surface)
void	setTouchEventsEnabled(bool enabled)
QObject *	subsurfaceHandler() const
QWaylandSurface *	surface() const
bool	touchEventsEnabled() const
QWaylandView *	view() const

Reimplemented Public Functions

virtual QSGTextureProvider *

textureProvider() const override

Public Slots

void	setPaintEnabled(bool paintEnabled)
virtual void	takeFocus(QWaylandSeat *device = nullptr)

Signals

void	allowDiscardFrontBufferChanged()
void	bufferLockedChanged()
void	compositorChanged()
void	focusOnClickChanged()
void	inputEventsEnabledChanged()
void	originChanged()
void	outputChanged()
void	paintEnabledChanged()
void	subsurfaceHandlerChanged()
void	surfaceChanged()
void	surfaceDestroyed()
void	touchEventsEnabledChanged()

Detailed Description

When writing a QWaylandCompositor in Qt Quick, this class can be used to display a client's contents on an output device and will pass user input to the client.

Member Function Documentation

QWaylandQuickItem::QWaylandQuickItem(QQuickItem *parent = nullptr)

Constructs a QWaylandQuickItem with the given parent.

[signal] void QWaylandQuickItem::surfaceDestroyed()

This signal is emitted when the client has destroyed the wl_surface associated with the QWaylandQuickItem. The handler for this signal is expected to either destroy the QWaylandQuickItem immediately or start a close animation and then destroy the Item.

If an animation is started, bufferLocked should be set to ensure the item keeps its content until the animation finishes

See also QWaylandQuickItem::bufferLocked.

[virtual slot] void QWaylandQuickItem::takeFocus(QWaylandSeat *device = nullptr)

Calling this function causes the item to take the focus of the input device.

[override virtual] QWaylandQuickItem::~QWaylandQuickItem()

Destroy the QWaylandQuickItem.

bool QWaylandQuickItem::inputRegionContains(const QPointF &localPosition) const

Returns true if the input region of this item's surface contains the position given by localPosition.

[since 5.13] QPointF QWaylandQuickItem::mapFromSurface(const QPointF &point) const

Maps the given point in the Wayland surfaces's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

This function was introduced in Qt 5.13.

QPointF QWaylandQuickItem::mapToSurface(const QPointF &point) const

Maps the given point in this item's coordinate system to the equivalent point within the Wayland surface's coordinate system, and returns the mapped coordinate.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

void QWaylandQuickItem::setPrimary()

Makes this QWaylandQuickItem's view the primary view for the surface.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

See also QWaylandSurface::primaryView.

[override virtual] QSGTextureProvider *QWaylandQuickItem::textureProvider() const

Reimplements: QQuickItem::textureProvider() const.

Returns the texture provider of this QWaylandQuickItem.

QWaylandView *QWaylandQuickItem::view() const

Returns the view rendered by this QWaylandQuickItem.