QWaylandCompositor Class
The QWaylandCompositor class manages the Wayland display server. More...
| Header: | #include <QWaylandCompositor> |
| qmake: | QT += waylandcompositor |
| Since: | Qt 5.8 |
| Instantiated By: | WaylandCompositor |
| Inherits: | QWaylandObject |
This class was introduced in Qt 5.8.
Properties
|
|
Public Functions
| QWaylandOutput * | defaultOutput() const |
| QWaylandSeat * | defaultSeat() const |
| bool | isCreated() const |
| bool | retainedSelectionEnabled() const |
| void | setDefaultOutput(QWaylandOutput *output) |
| void | setRetainedSelectionEnabled(bool enabled) |
| void | setSocketName(const QByteArray &name) |
| void | setUseHardwareIntegrationExtension(bool use) |
| QByteArray | socketName() const |
| bool | useHardwareIntegrationExtension() const |
Signals
| void | createdChanged() |
| void | defaultOutputChanged() |
| void | defaultSeatChanged(QWaylandSeat *newDevice, QWaylandSeat *oldDevice) |
| void | retainedSelectionChanged(bool retainedSelection) |
| void | socketNameChanged(const QByteArray &socketName) |
| void | useHardwareIntegrationExtensionChanged() |
Detailed Description
The QWaylandCompositor manages the connections to the clients, as well as the different outputs and seats.
Normally, a compositor application will have a single WaylandCompositor instance, which can have several outputs as children.
Property Documentation
created : const bool
This property is true if QWaylandCompositor has been initialized, otherwise it's false.
Access functions:
| bool | isCreated() const |
Notifier signal:
| void | createdChanged() |
defaultOutput : QWaylandOutput*
This property contains the first in the list of outputs added to the QWaylandCompositor, or null if no outputs have been added.
Setting a new default output prepends it to the output list, making it the new default, but the previous default is not removed from the list. If the new default output was already in the list of outputs, it is moved to the beginning of the list.
Access functions:
| QWaylandOutput * | defaultOutput() const |
| void | setDefaultOutput(QWaylandOutput *output) |
Notifier signal:
| void | defaultOutputChanged() |
defaultSeat : QWaylandSeat* const
This property contains the default seat for this QWaylandCompositor.
Access functions:
| QWaylandSeat * | defaultSeat() const |
Notifier signal:
| void | defaultSeatChanged(QWaylandSeat *newDevice, QWaylandSeat *oldDevice) |
retainedSelection : bool
This property holds whether retained selection is enabled.
Access functions:
| bool | retainedSelectionEnabled() const |
| void | setRetainedSelectionEnabled(bool enabled) |
Notifier signal:
| void | retainedSelectionChanged(bool retainedSelection) |
socketName : QByteArray
This property holds the socket name used by QWaylandCompositor to communicate with clients. This must be set before the QWaylandCompositor is created.
If the socketName is empty (the default), the contents of the start argument --wayland-socket-name are used instead. If the argument is not set, the compositor tries to find a socket name, which is wayland-0 by default.
Access functions:
| QByteArray | socketName() const |
| void | setSocketName(const QByteArray &name) |
Notifier signal:
| void | socketNameChanged(const QByteArray &socketName) |
useHardwareIntegrationExtension : bool
This property holds whether the hardware integration extension should be enabled for this QWaylandCompositor.
This property must be set before the compositor is created.
Access functions:
| bool | useHardwareIntegrationExtension() const |
| void | setUseHardwareIntegrationExtension(bool use) |
Notifier signal:
| void | useHardwareIntegrationExtensionChanged() |