ILayerShellTransport.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorLayer/Role.h>
#include <PhosphorLayer/phosphorlayer_export.h>
 
#include <QMargins>
#include <QObject>
#include <QSize>
#include <QString>
#include <QtGlobal>
 
#include <functional>
#include <memory>
 
QT_BEGIN_NAMESPACE
class QQuickWindow;
class QScreen;
QT_END_NAMESPACE
 
namespace PhosphorLayer {
 
struct TransportAttachArgs
{
    QScreen* screen = nullptr;
    Layer layer = Layer::Overlay;
    Anchors anchors = AnchorNone;
    int exclusiveZone = -1;
    KeyboardInteractivity keyboard = KeyboardInteractivity::None;
    QMargins margins;
    QString scope; 
};
 
class PHOSPHORLAYER_EXPORT ITransportHandle
{
public:
    ITransportHandle() = default;
    virtual ~ITransportHandle() = default;
    Q_DISABLE_COPY_MOVE(ITransportHandle)
 
    
    virtual QQuickWindow* window() const = 0;
 
    virtual bool isConfigured() const = 0;
 
    virtual void setMargins(QMargins m) = 0;
    virtual void setLayer(Layer l) = 0;
    virtual void setExclusiveZone(int z) = 0;
    virtual void setKeyboardInteractivity(KeyboardInteractivity k) = 0;
    virtual void setAnchors(Anchors a) = 0;
 
    virtual void setDesiredSize(QSize size) = 0;
 
    virtual QSize configuredSize() const = 0;
};
 
class PHOSPHORLAYER_EXPORT ILayerShellTransport
{
public:
    ILayerShellTransport() = default;
    virtual ~ILayerShellTransport() = default;
    Q_DISABLE_COPY_MOVE(ILayerShellTransport)
 
    
    virtual bool isSupported() const = 0;
 
    virtual std::unique_ptr<ITransportHandle> attach(QQuickWindow* win, const TransportAttachArgs& args) = 0;
 
    using CompositorLostCallback = std::function<void()>;
    using CompositorLostCookie = quint64;
    [[nodiscard]] virtual CompositorLostCookie addCompositorLostCallback(CompositorLostCallback cb) = 0;
    virtual void removeCompositorLostCallback(CompositorLostCookie cookie) = 0;
};
 
} // namespace PhosphorLayer