内容

• 特性
• 公共函数
• 重实现公共函数
• 公共槽
• 信号
• 详细描述

QWaylandQuickItem Class

The QWaylandQuickItem class provides a Qt Quick item representing a QWaylandView . 更多...

头：	#include <QWaylandQuickItem>
qmake:	QT += waylandcompositor
Since:	Qt 5.8
继承：	QQuickItem
继承者：	QWaylandQuickShellSurfaceItem

该类在 Qt 5.8 引入。

• 所有成员列表，包括继承成员

特性

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

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

公共函数

	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	inputRegionContains (const QPointF & localPosition )
bool	isBufferLocked () const
QPointF	mapFromSurface (const QPointF & point ) const
QPointF	mapToSurface (const QPointF & point ) const
QWaylandSurface::Origin	origin () const
QWaylandOutput *	output () const
bool	paintEnabled () const
void	setAllowDiscardFrontBuffer (bool discard )
void	setBufferLocked (bool locked )
void	setFocusOnClick (bool focus )
void	setInputEventsEnabled (bool enabled )
void	setOutput (QWaylandOutput * output )
void	setPrimary ()
void	setSizeFollowsSurface (bool sizeFollowsSurface )
void	setSubsurfaceHandler ( QObject * )
void	setSurface (QWaylandSurface * surface )
void	setTouchEventsEnabled (bool enabled )
bool	sizeFollowsSurface () const
QObject *	subsurfaceHandler () const
QWaylandSurface *	surface () const
bool	touchEventsEnabled () const
QWaylandView *	view () const

重实现公共函数

virtual QSGTextureProvider *

textureProvider () const override

公共槽

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

信号

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

详细描述

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.

特性文档编制

allowDiscardFrontBuffer : bool

By default, the item locks the current buffer until a new buffer is available and updatePaintNode () is called. Set this property to true to allow Qt to release the buffer immediately when the throttling view is no longer using it. This is useful for items that have slow update intervals.

访问函数：

bool	allowDiscardFrontBuffer () const
void	setAllowDiscardFrontBuffer (bool discard )

通知程序信号：

void	allowDiscardFrontBufferChanged ()

bufferLocked : bool

This property holds whether the item's buffer is currently locked. As long as the buffer is locked, it will not be released and returned to the client.

默认为 false。

访问函数：

bool	isBufferLocked () const
void	setBufferLocked (bool locked )

通知程序信号：

void	bufferLockedChanged ()

compositor : QWaylandCompositor * const

This property holds the compositor for the surface rendered by this QWaylandQuickItem .

访问函数：

QWaylandCompositor *

compositor () const

通知程序信号：

void	compositorChanged ()

focusOnClick : bool

This property specifies whether the QWaylandQuickItem should take focus when it is clicked or touched.

默认为 true .

访问函数：

bool	focusOnClick () const
void	setFocusOnClick (bool focus )

通知程序信号：

void	focusOnClickChanged ()

origin : const QWaylandSurface::Origin

This property holds the origin of the QWaylandQuickItem .

访问函数：

QWaylandSurface::Origin

origin () const

通知程序信号：

void	originChanged ()

output : QWaylandOutput *

This property holds the output on which this item is displayed.

访问函数：

QWaylandOutput *	output () const
void	setOutput (QWaylandOutput * output )

通知程序信号：

void	outputChanged ()

paintEnabled : bool

保持 true if the item is hidden, though the texture is still updated. As opposed to hiding the item by setting visible to false , setting this property to false will not prevent mouse or keyboard input from reaching item.

访问函数：

bool	paintEnabled () const
void	setPaintEnabled (bool paintEnabled )

通知程序信号：

void	paintEnabledChanged ()

sizeFollowsSurface : bool

This property specifies whether the size of the item should always match the size of its surface.

默认为 true .

访问函数：

bool	sizeFollowsSurface () const
void	setSizeFollowsSurface (bool sizeFollowsSurface )

通知程序信号：

void	sizeFollowsSurfaceChanged ()

surface : QWaylandSurface *

This property holds the surface rendered by this QWaylandQuickItem .

访问函数：

QWaylandSurface *	surface () const
void	setSurface (QWaylandSurface * surface )

通知程序信号：

void	surfaceChanged ()

touchEventsEnabled : bool

This property holds true if touch events are forwarded to the client surface, false 否则。

访问函数：

bool	touchEventsEnabled () const
void	setTouchEventsEnabled (bool enabled )

通知程序信号：

void	touchEventsEnabledChanged ()

成员函数文档编制

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

另请参阅 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

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

bool QWaylandQuickItem:: inputRegionContains (const QPointF & localPosition )

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

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.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

该函数在 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.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

void QWaylandQuickItem:: setPrimary ()

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

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

另请参阅 QWaylandSurface::primaryView .

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

重实现： QQuickItem::textureProvider () const.

Returns the texture provider of this QWaylandQuickItem .

QWaylandView *QWaylandQuickItem:: view () const

Returns the view rendered by this QWaylandQuickItem .