QWaylandQuickItem Class

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

头文件: #include <QWaylandQuickItem>
qmake: QT += waylandcompositor
开始支持版本: Qt 5.8
基类: QQuickItem
派生类:

QWaylandQuickShellSurfaceItem

属性

公有函数

QWaylandQuickItem(QQuickItem *parent = nullptr)
~QWaylandQuickItem()
bool allowDiscardFrontBuffer() const
QWaylandCompositor *compositor() const
bool focusOnClick() const
bool inputEventsEnabled() const
QVariant inputMethodQuery(Qt::InputMethodQuery query, QVariant argument) const
bool inputRegionContains(const QPointF &localPosition)
bool isBufferLocked() 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 QVariant inputMethodQuery(Qt::InputMethodQuery query) const override
virtual bool isTextureProvider() const override
virtual QSGTextureProvider *textureProvider() const override

公有槽函数

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

信号

重新实现的受保护函数

virtual void touchUngrabEvent() override
virtual QSGNode *updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *) override

详细描述

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

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

访问函数:

bool allowDiscardFrontBuffer() const
void setAllowDiscardFrontBuffer(bool discard)

Notifier signal:

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.

The default is false.

访问函数:

bool isBufferLocked() const
void setBufferLocked(bool locked)

Notifier signal:

void bufferLockedChanged()

compositor : QWaylandCompositor * const

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

访问函数:

QWaylandCompositor *compositor() const

focusOnClick : bool

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

The default is true.

访问函数:

bool focusOnClick() const
void setFocusOnClick(bool focus)

Notifier signal:

void focusOnClickChanged()

inputEventsEnabled : bool

访问函数:

bool inputEventsEnabled() const
void setInputEventsEnabled(bool enabled)

Notifier signal:

void inputEventsEnabledChanged()

origin : const QWaylandSurface::Origin

This property holds the origin of the QWaylandQuickItem.

访问函数:

QWaylandSurface::Origin origin() const

Notifier signal:

void originChanged()

output : QWaylandOutput *

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

访问函数:

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

Notifier signal:

void outputChanged()

paintEnabled : bool

访问函数:

bool paintEnabled() const
void setPaintEnabled(bool paintEnabled)

sizeFollowsSurface : bool

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

The default is true.

访问函数:

bool sizeFollowsSurface() const
void setSizeFollowsSurface(bool sizeFollowsSurface)

Notifier signal:

void sizeFollowsSurfaceChanged()

subsurfaceHandler : QObject *

访问函数:

QObject *subsurfaceHandler() const
void setSubsurfaceHandler(QObject *)

Notifier signal:

void subsurfaceHandlerChanged()

surface : QWaylandSurface *

This property holds the surface rendered by this QWaylandQuickItem.

访问函数:

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

Notifier signal:

void surfaceChanged()

touchEventsEnabled : bool

访问函数:

bool touchEventsEnabled() const
void setTouchEventsEnabled(bool enabled)

Notifier signal:

void touchEventsEnabledChanged()

成员函数

QWaylandQuickItem::QWaylandQuickItem(QQuickItem *parent = nullptr)

Constructs a QWaylandQuickItem with the given parent.

QWaylandQuickItem::~QWaylandQuickItem()

Destroy the QWaylandQuickItem.

[override virtual] QVariant QWaylandQuickItem::inputMethodQuery(Qt::InputMethodQuery query) const

QVariant QWaylandQuickItem::inputMethodQuery(Qt::InputMethodQuery query, QVariant argument) const

bool QWaylandQuickItem::inputRegionContains(const QPointF &localPosition)

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

[override virtual] bool QWaylandQuickItem::isTextureProvider() const

[slot] void QWaylandQuickItem::lower()

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.

[signal] void QWaylandQuickItem::mouseMove(const QPointF &windowPosition)

[signal] void QWaylandQuickItem::mouseRelease()

bool QWaylandQuickItem::paintEnabled() const

Returns 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 true will not prevent mouse or keyboard input from reaching item.

Note: Getter function for property paintEnabled.

参见 setPaintEnabled().

[slot] void QWaylandQuickItem::raise()

void QWaylandQuickItem::setPrimary()

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

参见 QWaylandSurface::primaryView.

[signal] void QWaylandQuickItem::surfaceDestroyed()

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

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

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

重新实现 QQuickItem::textureProvider().

Returns the texture provider of this QWaylandQuickItem.

[override virtual protected] void QWaylandQuickItem::touchUngrabEvent()

[override virtual protected] QSGNode *QWaylandQuickItem::updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *)

QWaylandView *QWaylandQuickItem::view() const