QtShellSurface QML Type
Provides a simple way to identify and resize a surface. More...
|Import Statement:||import QtWayland.Compositor.QtShell|
- active : bool
- capabilities : enum
- frameMarginBottom : int
- frameMarginLeft : int
- frameMarginRight : int
- frameMarginTop : int
- maximumSize : size
- minimumSize : size
- surface : WaylandSurface
- windowFlags : int
- windowGeometry : rect
- windowPosition : point
- windowState : int
- windowTitle : string
- void initialize(QtShell qtShell, WaylandSurface surface, WaylandResource resource)
- void requestWindowGeometry(int windowState, rect windowGeometry)
- void sendClose()
The QtShellSurface type holds the core functionality needed to create a compositor that supports the QtShell extension. It can be used directly, or via the QtShellChrome type, depending on what the needs of the compositor are. The QtShellChrome type has default behaviors and convenience APIs for working with QtShellSurface objects.
active : bool
This property holds whether the surface is currently considered active.
capabilities : enum
This property holds the capabilities of the compositor. By default, no special capabilities are enabled.
- QtShellSurface.InteractiveMove The client can trigger a server-side interactive move operation using QWindow::startSystemMove(). The compositor will be notified of this through the startMove() signal.
- QtShellSurface.InteractiveResize The client can trigger a server-side interactive resize operation using QWindow::startSystemResize(). The compositor will be notified of this through the startResize() signal.
frameMarginBottom : int
This holds the window frame margin below the surface.
frameMarginLeft : int
This holds the window frame margin to the left of the surface.
frameMarginRight : int
This holds the window frame margin to the right of the surface.
frameMarginTop : int
This holds the window frame margin above the surface.
[read-only] maximumSize : size
The maximum size of the window if the client has specified one. Otherwise an invalid size.
[read-only] minimumSize : size
The minimum size of the window if the client has specified one. Otherwise an invalid size.
[read-only] surface : WaylandSurface
This property holds the surface associated with this QtShellSurface.
[read-only] windowGeometry : rect
This property holds the window geometry of the shell surface.
windowPosition : point
This property holds the position of the shell surface relative to its output.
[read-only] windowState : int
void startResize(enum edges)
The client has requested an interactive resize operation in the compositor by calling QWindow::startSystemResize().
The edges provides information about which edge of the window should be moved during the resize. It is a mask of the following values:
Note: The corresponding handler is
See also capabilities.
Initializes the QtShellSurface, associating it with the given qtShell, surface, and resource.
Requests a new windowState and windowGeometry for the QtShellSurface. The state and geometry is updated when the client has acknowledged the request (at which point it is safe to assume that the surface's buffer has been resized if necessary).
Requests that the client application closes itself.
© 2023 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.