qwaylandcompositor.h

qt/qtwayland/src/compositor/compositor_api/qwaylandcompositor.h (file symbol)

Enable keyboard shortcuts

Source code

Go to source file

Revision control

Copy as Markdown

// Copyright (C) 2020 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

// Qt-Security score:significant reason:default

#ifndef QWAYLANDCOMPOSITOR_H

#define QWAYLANDCOMPOSITOR_H

#include <QtWaylandCompositor/qtwaylandcompositorglobal.h>

#include <QtWaylandCompositor/qtwaylandqmlinclude.h>

#include <QtWaylandCompositor/qwaylandcompositorextension.h>

#include <QtWaylandCompositor/QWaylandOutput>

#include <QtCore/QObject>

#include <QtGui/QImage>

#include <QtCore/QRect>

#include <QtCore/QLoggingCategory>

struct wl_display;

QT_BEGIN_NAMESPACE

class QInputEvent;

class QMimeData;

class QUrl;

class QOpenGLContext;

class QWaylandCompositorPrivate;

class QWaylandClient;

class QWaylandSurface;

class QWaylandSeat;

class QWaylandView;

class QWaylandPointer;

class QWaylandKeyboard;

class QWaylandTouch;

class QWaylandSurfaceGrabber;

class QWaylandBufferRef;

Q_WAYLANDCOMPOSITOR_EXPORT const QLoggingCategory &qLcWaylandCompositor();

Q_WAYLANDCOMPOSITOR_EXPORT const QLoggingCategory &qLcWaylandCompositorHardwareIntegration();

const QLoggingCategory &qLcWaylandCompositorInputMethods();

const QLoggingCategory &qLcWaylandCompositorTextInput();

class Q_WAYLANDCOMPOSITOR_EXPORT QWaylandCompositor : public QWaylandObject

    Q_OBJECT

    Q_DECLARE_PRIVATE(QWaylandCompositor)

    Q_PROPERTY(QByteArray socketName READ socketName WRITE setSocketName NOTIFY socketNameChanged)

    Q_PROPERTY(bool created READ isCreated NOTIFY createdChanged)

    Q_PROPERTY(bool retainedSelection READ retainedSelectionEnabled WRITE setRetainedSelectionEnabled NOTIFY retainedSelectionChanged)

    Q_PROPERTY(QWaylandOutput *defaultOutput READ defaultOutput WRITE setDefaultOutput NOTIFY defaultOutputChanged)

    Q_PROPERTY(bool useHardwareIntegrationExtension READ useHardwareIntegrationExtension WRITE setUseHardwareIntegrationExtension NOTIFY useHardwareIntegrationExtensionChanged)

    Q_PROPERTY(QWaylandSeat *defaultSeat READ defaultSeat NOTIFY defaultSeatChanged)

    Q_PROPERTY(QVector<ShmFormat> additionalShmFormats READ additionalShmFormats WRITE setAdditionalShmFormats NOTIFY additionalShmFormatsChanged REVISION(6, 0))

    Q_MOC_INCLUDE("qwaylandseat.h")

    QML_NAMED_ELEMENT(WaylandCompositorBase)

    QML_UNCREATABLE("Cannot create instance of WaylandCompositorBase, use WaylandCompositor instead")

    QML_ADDED_IN_VERSION(1, 0)

public:

    // Duplicates subset of supported values wl_shm_format enum

    enum ShmFormat {

        ShmFormat_ARGB8888 = 0,

        ShmFormat_XRGB8888 = 1,

        ShmFormat_C8 = 0x20203843,

        ShmFormat_XRGB4444 = 0x32315258,

        ShmFormat_ARGB4444 = 0x32315241,

        ShmFormat_XRGB1555 = 0x35315258,

        ShmFormat_RGB565 = 0x36314752,

        ShmFormat_RGB888 = 0x34324752,

        ShmFormat_XBGR8888 = 0x34324258,

        ShmFormat_ABGR8888 = 0x34324241,

        ShmFormat_BGR888 = 0x34324742,

        ShmFormat_XRGB2101010 = 0x30335258,

        ShmFormat_XBGR2101010 = 0x30334258,

        ShmFormat_ARGB2101010 = 0x30335241,

        ShmFormat_ABGR2101010 = 0x30334241

};

    Q_ENUM(ShmFormat)

    QWaylandCompositor(QObject *parent = nullptr);

    ~QWaylandCompositor() override;

    virtual void create();

    bool isCreated() const;

    void setSocketName(const QByteArray &name);

    QByteArray socketName() const;

    Q_INVOKABLE void addSocketDescriptor(int fd);

    ::wl_display *display() const;

    uint32_t nextSerial();

    QList<QWaylandClient *>clients() const;

    Q_INVOKABLE void destroyClientForSurface(QWaylandSurface *surface);

    Q_INVOKABLE void destroyClient(QWaylandClient *client);

    QList<QWaylandSurface *> surfaces() const;

    QList<QWaylandSurface *> surfacesForClient(QWaylandClient* client) const;

    Q_INVOKABLE QWaylandOutput *outputFor(QWindow *window) const;

    QWaylandOutput *defaultOutput() const;

    void setDefaultOutput(QWaylandOutput *output);

    QList<QWaylandOutput *> outputs() const;

    uint currentTimeMsecs() const;

    void setRetainedSelectionEnabled(bool enabled);

    bool retainedSelectionEnabled() const;

    void overrideSelection(const QMimeData *data);

    QWaylandSeat *defaultSeat() const;

    QWaylandSeat *seatFor(QInputEvent *inputEvent);

    bool useHardwareIntegrationExtension() const;

    void setUseHardwareIntegrationExtension(bool use);

    QVector<ShmFormat> additionalShmFormats() const;

    void setAdditionalShmFormats(const QVector<ShmFormat> &additionalShmFormats);

    virtual void grabSurface(QWaylandSurfaceGrabber *grabber, const QWaylandBufferRef &buffer);

public Q_SLOTS:

    void processWaylandEvents();

private Q_SLOTS:

    void applicationStateChanged(Qt::ApplicationState state);

Q_SIGNALS:

    void createdChanged();

    void socketNameChanged(const QByteArray &socketName);

    void retainedSelectionChanged(bool retainedSelection);

    void surfaceRequested(QWaylandClient *client, uint id, int version);

    void surfaceCreated(QWaylandSurface *surface);

    void surfaceAboutToBeDestroyed(QWaylandSurface *surface);

    void subsurfaceChanged(QWaylandSurface *child, QWaylandSurface *parent);

    void defaultOutputChanged();

    void defaultSeatChanged(QWaylandSeat *newDevice, QWaylandSeat *oldDevice);

    void useHardwareIntegrationExtensionChanged();

    void outputAdded(QWaylandOutput *output);

    void outputRemoved(QWaylandOutput *output);

    void additionalShmFormatsChanged();

protected:

    virtual void retainedSelectionReceived(QMimeData *mimeData);

    virtual QWaylandSeat *createSeat();

    virtual QWaylandPointer *createPointerDevice(QWaylandSeat *seat);

    virtual QWaylandKeyboard *createKeyboardDevice(QWaylandSeat *seat);

    virtual QWaylandTouch *createTouchDevice(QWaylandSeat *seat);

    QWaylandCompositor(QWaylandCompositorPrivate &dptr, QObject *parent = nullptr);

};

QT_END_NAMESPACE

#endif // QWAYLANDCOMPOSITOR_H