Qt Documentation

Contents

QWaylandQuickItem Class

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

Header: #include <QWaylandQuickItem>
qmake: QT += waylandcompositor
Inherits: QQuickItem
Inherited By:

QWaylandQuickShellSurfaceItem

This class is under development and is subject to change.

Properties

Public Functions

QWaylandQuickItem(QQuickItem *parent = nullptr)
~QWaylandQuickItem()
QWaylandCompositor *compositor() const
bool focusOnClick() const
bool inputEventsEnabled() const
QVariant inputMethodQuery(Qt::InputMethodQuery query, QVariant argument) const
bool inputRegionContains(const QPointF &localPosition)
QWaylandSurface::Origin origin() const
bool paintEnabled() const
void setFocusOnClick(bool focus)
void setInputEventsEnabled(bool enabled)
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

Reimplemented Public Functions

virtual QVariant inputMethodQuery(Qt::InputMethodQuery query) const
virtual bool isTextureProvider() const
virtual QSGTextureProvider *textureProvider() const

Public Slots

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

Signals

void focusOnClickChanged()
void inputEventsEnabledChanged()
void mouseMove(const QPointF &windowPosition)
void mouseRelease()
void originChanged()
void sizeFollowsSurfaceChanged()
void subsurfaceHandlerChanged()
void surfaceChanged()
void surfaceDestroyed()
void touchEventsEnabledChanged()

Reimplemented Protected Functions

virtual QSGNode *updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *)
  • 33 protected functions inherited from QQuickItem
  • 9 protected functions inherited from QObject

Additional Inherited Members

  • 11 static public members inherited from QObject
  • 33 protected functions inherited from QQuickItem
  • 9 protected functions inherited from QObject

Detailed Description

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.

Property Documentation

compositor : QWaylandCompositor * const

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

Access functions:

QWaylandCompositor *compositor() const

focusOnClick : bool

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

The default is true.

Access functions:

bool focusOnClick() const
void setFocusOnClick(bool focus)

Notifier signal:

void focusOnClickChanged()

inputEventsEnabled : bool

Access functions:

bool inputEventsEnabled() const
void setInputEventsEnabled(bool enabled)

Notifier signal:

void inputEventsEnabledChanged()

origin : const QWaylandSurface::Origin

This property holds the origin of the QWaylandQuickItem.

Access functions:

QWaylandSurface::Origin origin() const

Notifier signal:

void originChanged()

paintEnabled : bool

Access functions:

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.

Access functions:

bool sizeFollowsSurface() const
void setSizeFollowsSurface(bool sizeFollowsSurface)

Notifier signal:

void sizeFollowsSurfaceChanged()

subsurfaceHandler : QObject *

Access functions:

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

Notifier signal:

void subsurfaceHandlerChanged()

surface : QWaylandSurface *

This property holds the surface rendered by this QWaylandQuickItem.

Access functions:

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

Notifier signal:

void surfaceChanged()

touchEventsEnabled : bool

Access functions:

bool touchEventsEnabled() const
void setTouchEventsEnabled(bool enabled)

Notifier signal:

void touchEventsEnabledChanged()

view : QWaylandView * const

This property holds the view rendered by this QWaylandQuickItem.

Access functions:

QWaylandView *view() const

Member Function Documentation

QWaylandQuickItem::QWaylandQuickItem(QQuickItem *parent = nullptr)

Constructs a QWaylandQuickItem with the given parent.

QWaylandQuickItem::~QWaylandQuickItem()

Destroy the QWaylandQuickItem.

[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.

[virtual] bool QWaylandQuickItem::isTextureProvider() const

[slot] void QWaylandQuickItem::lower()

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

[signal] void QWaylandQuickItem::mouseRelease()

bool QWaylandQuickItem::paintEnabled() const

If this property is true, 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.

See also setPaintEnabled().

[slot] void QWaylandQuickItem::raise()

[signal] void QWaylandQuickItem::surfaceDestroyed()

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

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

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

Reimplemented from QQuickItem::textureProvider().

Returns the texture provider of this QWaylandQuickItem.

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

© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.