Qt Documentation

Contents

QWaylandQuickShellSurfaceItem Class

The QWaylandQuickShellSurfaceItem class provides a Qt Quick item that represents a QWaylandShellSurface. More...

Header: #include <QWaylandQuickShellSurfaceItem>
qmake: QT += waylandcompositor
Since: Qt 5.8
Inherits: QWaylandQuickItem

This class was introduced in Qt 5.8.

Properties

Public Functions

QWaylandQuickShellSurfaceItem(QQuickItem *parent = nullptr)
bool autoCreatePopupItems()
QQuickItem *moveItem() const
void setAutoCreatePopupItems(bool enabled)
void setMoveItem(QQuickItem *moveItem)
void setShellSurface(QWaylandShellSurface *shellSurface)
QWaylandShellSurface *shellSurface() const

Signals

void autoCreatePopupItemsChanged()
void moveItemChanged()
void shellSurfaceChanged()

Detailed Description

This class is used to render wl_shell, xdg_shell or ivi_application surfaces as part of a Qt Quick scene. It handles moving and resizing triggered by clicking on the window decorations.

See also QWaylandQuickItem, QWaylandWlShellSurface, QWaylandXdgSurfaceV5, and QWaylandIviSurface.

Property Documentation

autoCreatePopupItems : bool

This property holds whether QWaylandQuickShellSurfaceItems for popups parented to the shell surface managed by this item should automatically be created.

Access functions:

bool autoCreatePopupItems()
void setAutoCreatePopupItems(bool enabled)

Notifier signal:

void autoCreatePopupItemsChanged()

moveItem : QQuickItem*

This property holds the move item for this QWaylandQuickShellSurfaceItem. This is the item that will be moved when the clients request the QWaylandShellSurface to be moved, maximized, resized etc. This property is useful when implementing server-side decorations.

Access functions:

QQuickItem *moveItem() const
void setMoveItem(QQuickItem *moveItem)

Notifier signal:

void moveItemChanged()

shellSurface : QWaylandShellSurface*

This property holds the QWaylandShellSurface rendered by this QWaylandQuickShellSurfaceItem. It may either be a QWaylandXdgSurfaceV5, QWaylandWlShellSurface or QWaylandIviSurface depending on which shell protocol is in use.

Access functions:

QWaylandShellSurface *shellSurface() const
void setShellSurface(QWaylandShellSurface *shellSurface)

Notifier signal:

void shellSurfaceChanged()

Member Function Documentation

QWaylandQuickShellSurfaceItem::QWaylandQuickShellSurfaceItem(QQuickItem *parent = nullptr)

Constructs a QWaylandQuickWlShellSurfaceItem with the given parent.

© 2020 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.