QWaylandXdgSurface Class
The QWaylandXdgSurface class provides desktop functionality. More...
| Header: | #include <QWaylandXdgSurface> |
| qmake: | QT += waylandcompositor |
| Inherits: | QWaylandShellSurfaceTemplate<QWaylandXdgSurface> |
This class is under development and is subject to change.
Public Types
| enum | ResizeEdge { NoneEdge, TopEdge, BottomEdge, LeftEdge, ..., BottomRightEdge } |
| enum | State { MaximizedState, FullscreenState, ResizingState, ActivatedState } |
Properties
|
|
Public Functions
| QWaylandXdgSurface() | |
| QWaylandXdgSurface(QWaylandXdgShell *xdgShell, QWaylandSurface *surface, const QWaylandResource &res) | |
| bool | activated() const |
| QString | appId() const |
| bool | fullscreen() const |
| void | initialize(QWaylandXdgShell *xdgShell, QWaylandSurface *surface, const QWaylandResource &resource) |
| bool | maximized() const |
| QWaylandXdgSurface * | parentSurface() const |
| uint | requestFullscreen(const QSize &size) |
| uint | requestMaximized(const QSize &size) |
| uint | requestResizing(const QSize &maxSize) |
| uint | requestUnMaximized(const QSize &size = QSize( 0, 0 )) |
| bool | resizing() const |
| void | sendClose() |
| uint | sendConfigure(const QSize &size, const QVector<uint> &states) |
| uint | sendConfigure(const QSize &size, const QVector<State> &states) |
| QSize | sizeForResize(const QSizeF &size, const QPointF &delta, ResizeEdge edge) |
| QVector<uint> | states() const |
| QWaylandSurface * | surface() const |
| QString | title() const |
| QRect | windowGeometry() const |
Reimplemented Public Functions
| virtual QWaylandQuickShellIntegration * | createIntegration(QWaylandQuickShellSurfaceItem *item) |
- 1 public function inherited from QWaylandShellSurface
- 4 public functions inherited from QWaylandCompositorExtension
- 5 public functions inherited from QWaylandObject
Signals
| void | ackConfigure(uint serial) |
| void | activatedChanged() |
| void | appIdChanged() |
| void | fullscreenChanged() |
| void | maximizedChanged() |
| void | parentSurfaceChanged() |
| void | resizingChanged() |
| void | setFullscreen(QWaylandOutput *output) |
| void | setMaximized() |
| void | setMinimized() |
| void | showWindowMenu(QWaylandInputDevice *inputDevice, const QPoint &localSurfacePosition) |
| void | startMove(QWaylandInputDevice *inputDevice) |
| void | startResize(QWaylandInputDevice *inputDevice, ResizeEdge edges) |
| void | statesChanged() |
| void | surfaceChanged() |
| void | titleChanged() |
| void | unsetFullscreen() |
| void | unsetMaximized() |
| void | windowGeometryChanged() |
Static Public Members
| QByteArray | interfaceName() |
| QWaylandSurfaceRole * | role() |
Additional Inherited Members
- 1 protected function inherited from QWaylandCompositorExtension
Detailed Description
The QWaylandXdgSurface class provides desktop functionality.
The QWaylandXdgSurface class is part of the QWaylandXdgShell extension and provides a way to extend the functionality of an existing QWaylandSurface with features specific to desktop-style compositors, such as resizing and moving the surface.
It corresponds to the Wayland interface xdg_surface.
Property Documentation
activated : const bool
Access functions:
| bool | activated() const |
Notifier signal:
| void | activatedChanged() |
appId : const QString
This property holds the app id of the QWaylandXdgSurface.
Access functions:
| QString | appId() const |
Notifier signal:
| void | appIdChanged() |
fullscreen : const bool
Access functions:
| bool | fullscreen() const |
Notifier signal:
| void | fullscreenChanged() |
maximized : const bool
Access functions:
| bool | maximized() const |
Notifier signal:
| void | maximizedChanged() |
parentSurface : QWaylandXdgSurface * const
This property holds the parent of this XdgSurface.
Access functions:
| QWaylandXdgSurface * | parentSurface() const |
Notifier signal:
| void | parentSurfaceChanged() |
resizing : const bool
Access functions:
| bool | resizing() const |
Notifier signal:
| void | resizingChanged() |
states : const QList<int>
This property holds the last states the client acknowledged for this QWaylandXdgSurface.
Notifier signal:
| void | statesChanged() |
surface : QWaylandSurface * const
This property holds the surface associated with this QWaylandXdgSurface.
Access functions:
| QWaylandSurface * | surface() const |
Notifier signal:
| void | surfaceChanged() |
title : const QString
This property holds the title of the QWaylandXdgSurface.
Access functions:
| QString | title() const |
Notifier signal:
| void | titleChanged() |
windowGeometry : const QRect
This property holds the window geometry of the QWaylandXdgSurface. The window geometry describes the window's visible bounds from the user's perspective. The geometry includes title bars and borders if drawn by the client, but excludes drop shadows. It is meant to be used for aligning and tiling windows.
Access functions:
| QRect | windowGeometry() const |
Notifier signal:
| void | windowGeometryChanged() |
Member Function Documentation
QWaylandXdgSurface::QWaylandXdgSurface()
Constructs a QWaylandXdgSurface.
QWaylandXdgSurface::QWaylandXdgSurface(QWaylandXdgShell *xdgShell, QWaylandSurface *surface, const QWaylandResource &res)
Constructs a QWaylandXdgSurface for surface and initializes it with the given xdgShell, surface, and resource res.
[signal] void QWaylandXdgSurface::ackConfigure(uint serial)
[virtual] QWaylandQuickShellIntegration *QWaylandXdgSurface::createIntegration(QWaylandQuickShellSurfaceItem *item)
void QWaylandXdgSurface::initialize(QWaylandXdgShell *xdgShell, QWaylandSurface *surface, const QWaylandResource &resource)
Initializes the QWaylandXdgSurface and associates it with the given xdgShell, surface, and resource.
[static] QByteArray QWaylandXdgSurface::interfaceName()
uint QWaylandXdgSurface::requestFullscreen(const QSize &size)
uint QWaylandXdgSurface::requestMaximized(const QSize &size)
uint QWaylandXdgSurface::requestResizing(const QSize &maxSize)
uint QWaylandXdgSurface::requestUnMaximized(const QSize &size = QSize( 0, 0 ))
[static] QWaylandSurfaceRole *QWaylandXdgSurface::role()
Returns the surface role for the QWaylandXdgSurface.
void QWaylandXdgSurface::sendClose()
Sends a close event to the client.
uint QWaylandXdgSurface::sendConfigure(const QSize &size, const QVector<uint> &states)
Sends a configure event to the client. Known states are enumerated in QWaylandXdgSurface::State
uint QWaylandXdgSurface::sendConfigure(const QSize &size, const QVector<State> &states)
[signal] void QWaylandXdgSurface::setFullscreen(QWaylandOutput *output)
See also fullscreen().
[signal] void QWaylandXdgSurface::setMaximized()
See also maximized().