IBackend.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <QKeySequence>
#include <QObject>
#include <QString>
#include <QStringList>
 
#include <optional>
 
#include "phosphorshortcuts_export.h"
 
namespace PhosphorShortcuts {
 
class PHOSPHORSHORTCUTS_EXPORT IBackend : public QObject
{
    Q_OBJECT
public:
    explicit IBackend(QObject* parent = nullptr)
        : QObject(parent)
    {
    }
    ~IBackend() override = default;
 
    virtual void registerShortcut(const QString& id, const QKeySequence& defaultSeq, const QKeySequence& currentSeq,
                                  const QString& description, bool persistent = true) = 0;
 
    virtual void updateShortcut(const QString& id, const QKeySequence& defaultSeq, const QKeySequence& newTrigger) = 0;
 
    virtual void unregisterShortcut(const QString& id) = 0;
 
    virtual void flush() = 0;
 
    virtual std::optional<QStringList> currentTriggers(const QString& id) const
    {
        Q_UNUSED(id);
        return std::nullopt;
    }
 
Q_SIGNALS:
    void activated(QString id);
 
    void ready();
 
    void triggersChanged(QString id);
};
 
} // namespace PhosphorShortcuts