ICompositorBridge.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <phosphorcompositor_export.h>
 
#include <QIcon>
#include <QRectF>
#include <QSizeF>
#include <QString>
#include <QVector>
 
// QObject is only named as a pointer return type (asQObject) — forward
// declare per the project's header rule rather than pulling in <QObject>.
class QObject;
 
namespace PhosphorCompositor {
 
using WindowHandle = void*;
 
struct WindowInfo
{
    WindowHandle handle = nullptr;
    QString windowId;
    QString appId;
    QString windowClass; 
    QString screenId;
    QString caption;
    QIcon icon;
    QRectF frameGeometry;
    QSizeF minSize;
    bool isMinimized = false;
    bool isFullScreen = false;
    bool isOnCurrentDesktop = true;
    bool isOnCurrentActivity = true;
    bool hasDecoration = false;
    bool isNormalWindow = true;
    bool keepAbove = false;
    qint64 pid = 0;
};
 
class PHOSPHORCOMPOSITOR_EXPORT ICompositorBridge
{
public:
    ICompositorBridge() = default;
    virtual ~ICompositorBridge() = default;
 
    ICompositorBridge(const ICompositorBridge&) = delete;
    ICompositorBridge& operator=(const ICompositorBridge&) = delete;
    ICompositorBridge(ICompositorBridge&&) = delete;
    ICompositorBridge& operator=(ICompositorBridge&&) = delete;
 
    // ═══════════════════════════════════════════════════════════════════
    // Window Lookup
    // ═══════════════════════════════════════════════════════════════════
 
    virtual WindowHandle findWindowById(const QString& windowId) const = 0;
 
    virtual QVector<WindowHandle> findAllWindowsById(const QString& windowId) const = 0;
 
    virtual QVector<WindowHandle> stackingOrder() const = 0;
 
    // ═══════════════════════════════════════════════════════════════════
    // Window Identity
    // ═══════════════════════════════════════════════════════════════════
 
    virtual QString windowId(WindowHandle w) const = 0;
 
    virtual QString windowScreenId(WindowHandle w) const = 0;
 
    // ═══════════════════════════════════════════════════════════════════
    // Window Properties
    // ═══════════════════════════════════════════════════════════════════
 
    virtual QRectF frameGeometry(WindowHandle w) const = 0;
    virtual QSizeF minSize(WindowHandle w) const = 0;
    virtual bool isMinimized(WindowHandle w) const = 0;
    virtual bool isOnCurrentDesktop(WindowHandle w) const = 0;
    virtual bool isOnCurrentActivity(WindowHandle w) const = 0;
    virtual bool hasDecoration(WindowHandle w) const = 0;
 
    virtual bool userCanSetNoBorder(WindowHandle w) const = 0;
 
    virtual bool isNoBorder(WindowHandle w) const = 0;
 
    virtual QRectF moveResizeGeometry(WindowHandle w) const = 0;
 
    virtual WindowInfo windowInfo(WindowHandle w) const = 0;
 
    // ═══════════════════════════════════════════════════════════════════
    // Window Filtering
    // ═══════════════════════════════════════════════════════════════════
 
    virtual bool shouldHandleWindow(WindowHandle w) const = 0;
 
    virtual bool isTileableWindow(WindowHandle w) const = 0;
 
    // ═══════════════════════════════════════════════════════════════════
    // Window Actions
    // ═══════════════════════════════════════════════════════════════════
 
    virtual void moveResize(WindowHandle w, const QRectF& geometry) = 0;
 
    virtual void setNoBorder(WindowHandle w, bool noBorder) = 0;
 
    virtual void setMaximized(WindowHandle w, bool maximized) = 0;
 
    virtual void activateWindow(WindowHandle w) = 0;
 
    virtual void raiseWindow(WindowHandle w) = 0;
 
    virtual void applyWindowGeometry(WindowHandle w, const QRectF& geometry, bool skipAnimation) = 0;
 
    // ═══════════════════════════════════════════════════════════════════
    // D-Bus Integration (convenience wrappers using compositor as parent)
    // ═══════════════════════════════════════════════════════════════════
 
    virtual QObject* asQObject() = 0;
 
    virtual bool isDaemonReady() const = 0;
 
    // ═══════════════════════════════════════════════════════════════════
    // Screen Management
    // ═══════════════════════════════════════════════════════════════════
 
    virtual void invalidateScreenIdCache() = 0;
};
 
} // namespace PhosphorCompositor