layershell_v1.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2020 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
 
#pragma once
 
#include "display.h"
 
#include <QMargins>
 
namespace KWin
{
class LayerShellV1InterfacePrivate;
class LayerSurfaceV1Interface;
class LayerSurfaceV1InterfacePrivate;
class OutputInterface;
class SurfaceInterface;
class SurfaceRole;
 
class KWIN_EXPORT LayerShellV1Interface : public QObject
{
    Q_OBJECT
 
public:
    explicit LayerShellV1Interface(Display *display, QObject *parent = nullptr);
    ~LayerShellV1Interface() override;
 
    Display *display() const;
 
Q_SIGNALS:
    void surfaceCreated(LayerSurfaceV1Interface *surface);
 
private:
    std::unique_ptr<LayerShellV1InterfacePrivate> d;
};
 
class KWIN_EXPORT LayerSurfaceV1Interface : public QObject
{
    Q_OBJECT
 
public:
    enum Layer {
        BackgroundLayer,
        BottomLayer,
        TopLayer,
        OverlayLayer,
    };
 
    LayerSurfaceV1Interface(LayerShellV1Interface *shell,
                            SurfaceInterface *surface,
                            OutputInterface *output,
                            Layer layer,
                            const QString &scope,
                            wl_resource *resource);
    ~LayerSurfaceV1Interface() override;
 
    static SurfaceRole *role();
 
    bool isCommitted() const;
 
    SurfaceInterface *surface() const;
 
    Qt::Edges anchor() const;
 
    QSize desiredSize() const;
 
    Layer layer() const;
 
    bool acceptsFocus() const;
 
    QMargins margins() const;
 
    int leftMargin() const;
 
    int rightMargin() const;
 
    int topMargin() const;
 
    int bottomMargin() const;
 
    int exclusiveZone() const;
 
    Qt::Edge exclusiveEdge() const;
 
    OutputInterface *output() const;
 
    QString scope() const;
 
    quint32 sendConfigure(const QSize &size);
 
    void sendClosed();
 
Q_SIGNALS:
    void aboutToBeDestroyed();
    void configureAcknowledged(quint32 serial);
    void acceptsFocusChanged();
    void layerChanged();
    void anchorChanged();
    void desiredSizeChanged();
    void exclusiveZoneChanged();
    void marginsChanged();
 
private:
    std::unique_ptr<LayerSurfaceV1InterfacePrivate> d;
};
 
} // namespace KWin