Toplevels.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorShell/phosphorshell_export.h>
 
#include <PhosphorWayland/ForeignToplevel.h>
 
#include <QAbstractListModel>
#include <QList>
#include <QObject>
#include <QPointer>
#include <QtQml/qqmlregistration.h>
 
namespace PhosphorShell {
 
class PHOSPHORSHELL_EXPORT ToplevelListModel : public QAbstractListModel
{
    Q_OBJECT
 
public:
    enum Role {
        ToplevelRole = Qt::UserRole + 1
    };
    Q_ENUM(Role)
 
    explicit ToplevelListModel(PhosphorWayland::ForeignToplevelManager* manager, QObject* parent = nullptr);
    ~ToplevelListModel() override;
 
    [[nodiscard]] int rowCount(const QModelIndex& parent = {}) const override;
    [[nodiscard]] QVariant data(const QModelIndex& index, int role) const override;
    [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
 
private Q_SLOTS:
    void onToplevelAdded(PhosphorWayland::ForeignToplevel* toplevel);
    void onToplevelRemoved(PhosphorWayland::ForeignToplevel* toplevel);
 
private:
    QPointer<PhosphorWayland::ForeignToplevelManager> m_manager;
    // QPointer rows — a toplevel can be deleteLater'd between `closed`
    // and the actual delete; storing QPointer means a stale row never
    // returns a dangling pointer to a delegate's `var` property.
    QList<QPointer<PhosphorWayland::ForeignToplevel>> m_rows;
};
 
// Registered as a QML singleton imperatively in ShellEngine::load() via
// `qmlRegisterSingletonType<Toplevels>(..., &Toplevels::create)`. The
// QML_NAMED_ELEMENT / QML_SINGLETON macros would only be honoured by
// `qt_add_qml_module`, which the build doesn't use.
class PHOSPHORSHELL_EXPORT Toplevels : public QObject
{
    Q_OBJECT
 
    Q_PROPERTY(QList<PhosphorWayland::ForeignToplevel*> toplevels READ toplevels NOTIFY toplevelsChanged)
    Q_PROPERTY(QAbstractListModel* model READ model CONSTANT)
    Q_PROPERTY(bool supported READ isSupported CONSTANT)
 
public:
    explicit Toplevels(QObject* parent = nullptr);
    ~Toplevels() override;
 
    [[nodiscard]] static Toplevels* create(QQmlEngine* engine, QJSEngine* scriptEngine);
 
    [[nodiscard]] QList<PhosphorWayland::ForeignToplevel*> toplevels() const;
    [[nodiscard]] QAbstractListModel* model() const;
    [[nodiscard]] bool isSupported() const;
 
Q_SIGNALS:
    void toplevelsChanged();
 
private:
    static PhosphorWayland::ForeignToplevelManager* sharedManager();
 
    // Per-engine model owned by this Toplevels wrapper. Reads from the
    // shared manager but provides a fresh QAbstractListModel for each
    // QML engine, so engine teardown cleanly tears down its own model
    // without disturbing siblings.
    ToplevelListModel* m_model = nullptr;
};
 
} // namespace PhosphorShell