DBusMenuModel.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorServices/phosphorservices_export.h>
 
#include <QAbstractListModel>
#include <QPointer>
#include <QQmlEngine>
#include <QString>
 
#include <memory>
 
namespace PhosphorServices {
 
class PHOSPHORSERVICES_EXPORT DBusMenuModel : public QAbstractListModel
{
    Q_OBJECT
    Q_DISABLE_COPY_MOVE(DBusMenuModel)
    QML_ELEMENT
    Q_PROPERTY(QString service READ service WRITE setService NOTIFY sourceChanged)
    Q_PROPERTY(QString path READ path WRITE setPath NOTIFY sourceChanged)
    Q_PROPERTY(int rootId READ rootId WRITE setRootId NOTIFY rootIdChanged)
    Q_PROPERTY(bool valid READ valid NOTIFY validChanged)
    // Mirror of rowCount() — QAbstractListModel doesn't expose count
    // as a property, so QML's `model.count` evaluates to undefined
    // without this. Worth keeping the API symmetric with
    // StatusNotifierItemModel.
    Q_PROPERTY(int count READ rowCount NOTIFY countChanged)
 
public:
    enum Roles {
        IdRole = Qt::UserRole + 1,
        TypeRole, 
        LabelRole, 
        EnabledRole,
        VisibleRole,
        IconUrlRole, 
        IconImageRole, 
        ToggleTypeRole, 
        ToggleStateRole, 
        ChildrenDisplayRole, 
        ShortcutRole,
    };
    Q_ENUM(Roles)
 
    explicit DBusMenuModel(QObject* parent = nullptr);
    ~DBusMenuModel() override;
 
    [[nodiscard]] QString service() const;
    void setService(const QString& service);
 
    [[nodiscard]] QString path() const;
    void setPath(const QString& path);
 
    [[nodiscard]] int rootId() const;
    void setRootId(int id);
 
    [[nodiscard]] bool valid() const;
 
    [[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;
 
    Q_INVOKABLE void triggerItem(int row);
    Q_INVOKABLE int aboutToShowSubmenu(int row);
    Q_INVOKABLE void aboutToShow();
    Q_INVOKABLE void aboutToHide();
    Q_INVOKABLE void refresh();
 
Q_SIGNALS:
    void sourceChanged();
    void rootIdChanged();
    void validChanged();
    void countChanged();
    void loaded();
    void loadFailed(const QString& message);
 
private:
    class Private;
    std::unique_ptr<Private> d;
};
 
} // namespace PhosphorServices