WaylandQuickItem QML Type

A Qt Quick item representing a WaylandView. More...

Import Statement: import QtWayland.Compositor 1.0

Properties

Detailed Description

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

Property Documentation

compositor : object

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


focusOnClick : bool

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

The default is true.


origin : enum

This property holds the origin of the QWaylandQuickItem.


sizeFollowsSurface : bool

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

The default is true.


subsurfaceHandler : bool

This property provides a way to override the default subsurface behavior.

By default, Qt will create a new SurfaceItem as a child of this item, and maintain the correct position.

To override the default, assign a handler object to this property. The handler should implement a handleSubsurfaceAdded(WaylandSurface) function.


  ShellSurfaceItem {
      subsurfaceHandler: QtObject {
      function handleSubsurfaceAdded(child) {
        //create custom surface item, and connect the subsurfacePositionChanged signal
      }
  }

The default value of this property is null.