QWaylandSurface Class

Member Function Documentation

QWaylandSurface::QWaylandSurface()

Constructs a an uninitialized QWaylandSurface.

QWaylandSurface::QWaylandSurface(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version)

Constructs and initializes a QWaylandSurface for the given compositor and client, and with the given id and version.

[override virtual noexcept] QWaylandSurface::~QWaylandSurface()

Destroys the QWaylandSurface.

[signal] void QWaylandSurface::childAdded(QWaylandSurface *child)

This signal is emitted when a wl_subsurface, child, has been added to the surface.

QWaylandCompositor *QWaylandSurface::compositor() const

Returns the compositor for this QWaylandSurface.

[invokable] void QWaylandSurface::destroy()

Destroys the QWaylandSurface.

[signal] void QWaylandSurface::dragStarted(QWaylandDrag *drag)

This signal is emitted when a drag has started from this surface.

[invokable] void QWaylandSurface::frameStarted()

Prepares all frame callbacks for sending.

[static] QWaylandSurface *QWaylandSurface::fromResource(wl_resource *resource)

Returns the QWaylandSurface corresponding to the Wayland resource resource.

[invokable] void QWaylandSurface::initialize(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version)

Initializes the QWaylandSurface with the given compositor and client, and with the given id and version.

bool QWaylandSurface::inputRegionContains(const QPoint &p) const

Returns true if the QWaylandSurface's input region contains the point p. Otherwise returns false.

bool QWaylandSurface::inputRegionContains(const QPointF &position) const

Returns true if the QWaylandSurface's input region contains the point position. Otherwise returns false.

[invokable] bool QWaylandSurface::isDestroyed() const

Returns true if the QWaylandSurface has been destroyed. Otherwise returns false.

bool QWaylandSurface::isInitialized() const

Returns true if the QWaylandSurface has been initialized.

QWaylandView *QWaylandSurface::primaryView() const

Returns this QWaylandSurface's primary view.

See also QWaylandView::advance() and QWaylandSurface::setPrimaryView().

struct wl_resource *QWaylandSurface::resource() const

Returns the Wayland resource corresponding to this QWaylandSurface.

[invokable] void QWaylandSurface::sendFrameCallbacks()

Sends pending frame callbacks.

void QWaylandSurface::setPrimaryView(QWaylandView *view)

Sets this QWaylandSurface's primary view to view, in case there are multiple views of this surface. The primary view is the view that governs the client's refresh rate. It takes care of discarding buffer references when QWaylandView::advance() is called. See the documentation for QWaylandView::advance() for more details.

In shell surface integrations, such as QWaylandWlShellIntegration and QWaylandXdgShellV5Integration, maximize and fullscreen requests from the client will only have an effect if the integration has the primary view of the surface.

See also primaryView() and QWaylandView::advance().

bool QWaylandSurface::setRole(QWaylandSurfaceRole *role, wl_resource *errorResource, uint32_t errorCode)

Sets a role on the surface. A role defines how a surface will be mapped on screen; without a role a surface is supposed to be hidden. Once a role is assigned to a surface, this becomes its permanent role. Any subsequent call to setRole() with a different role will trigger a protocol error to the errorResource and send an errorCode to the client. Enforcing this requirement is the main purpose of the surface role.

The role is compared by pointer value. Any two objects of QWaylandSurfaceRole will be considered different roles, regardless of their names.

The surface role is set internally by protocol implementations when a surface is adopted for a specific purpose, for example in a shell extension. Unless you are developing extensions which use surfaces in this way, you should not call this function.

Returns true if a role can be assigned; false otherwise.

[signal] void QWaylandSurface::surfaceDestroyed()

This signal is emitted when the corresponing wl_surface is destroyed.

[slot] void QWaylandSurface::updateSelection()

Updates the surface with the compositor's retained clipboard selection. Although this is done automatically when the surface receives keyboard focus, this function is useful for updating clients which do not have keyboard focus.

QList<QWaylandView *> QWaylandSurface::views() const

Returns the views for this QWaylandSurface.

wl_client *QWaylandSurface::waylandClient() const

Holds the wl_client using this QWaylandSurface.