ShortcutManager.h

/*
 * Copyright 2016-2025 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <quentier/types/Account.h>
#include <quentier/utility/Linkage.h>

#include <QKeySequence>
#include <QObject>

namespace quentier::utility {

class QUENTIER_EXPORT ShortcutManager : public QObject
{
    Q_OBJECT
public:
    explicit ShortcutManager(QObject * parent = nullptr);

    enum QuentierShortcutKey
    {
        NewNote = 5000,
        NewTag,
        NewNotebook,
        NewSavedSearch,
        AddAttachment,
        SaveAttachment,
        OpenAttachment,
        CopyAttachment,
        CutAttachment,
        RemoveAttachment,
        RenameAttachment,
        AddAccount,
        ExitAccount,
        SwitchAccount,
        AccountInfo,
        NoteSearch,
        NewNoteSearch,
        ShowNotes,
        ShowNotebooks,
        ShowTags,
        ShowSavedSearches,
        ShowDeletedNotes,
        ShowStatusBar,
        ShowToolBar,
        PasteUnformatted,
        Font,
        UpperIndex,
        LowerIndex,
        AlignLeft,
        AlignCenter,
        AlignRight,
        AlignFull,
        IncreaseIndentation,
        DecreaseIndentation,
        IncreaseFontSize,
        DecreaseFontSize,
        InsertNumberedList,
        InsertBulletedList,
        Strikethrough,
        Highlight,
        InsertTable,
        InsertRow,
        InsertColumn,
        RemoveRow,
        RemoveColumn,
        InsertHorizontalLine,
        InsertToDoTag,
        EditHyperlink,
        CopyHyperlink,
        RemoveHyperlink,
        Encrypt,
        Decrypt,
        DecryptPermanently,
        BackupLocalStorage,
        RestoreLocalStorage,
        UpgradeLocalStorage,
        LocalStorageStatus,
        SpellCheck,
        SpellCheckIgnoreWord,
        SpellCheckAddWordToUserDictionary,
        SaveImage,
        AnnotateImage,
        ImageRotateClockwise,
        ImageRotateCounterClockwise,
        Synchronize,
        FullSync,
        ImportFolders,
        Preferences,
        ReleaseNotes,
        ViewLogs,
        About,
        UnknownKey = 100000
    };

    [[nodiscard]] QKeySequence shortcut(
        int key, const Account & account, const QString & context = {}) const;

    [[nodiscard]] QKeySequence shortcut(
        const QString & nonStandardKey, const Account & account,
        const QString & context = {}) const;

    [[nodiscard]] QKeySequence defaultShortcut(
        int key, const Account & account, const QString & context = {}) const;

    [[nodiscard]] QKeySequence defaultShortcut(
        const QString & nonStandardKey, const Account & account,
        const QString & context = {}) const;

    [[nodiscard]] QKeySequence userShortcut(
        int key, const Account & account, const QString & context = {}) const;

    [[nodiscard]] QKeySequence userShortcut(
        const QString & nonStandardKey, const Account & account,
        const QString & context = {}) const;

Q_SIGNALS:
    void shortcutChanged(
        int key, QKeySequence shortcut, const Account & account,
        QString context);

    void nonStandardShortcutChanged(
        QString nonStandardKey, QKeySequence shortcut, const Account & account,
        QString context);

public Q_SLOTS:
    void setUserShortcut(
        int key, const QKeySequence & shortcut, const Account & account,
        QString context = {});

    void setNonStandardUserShortcut(
        QString nonStandardKey, const QKeySequence & shortcut,
        const Account & account, QString context = {});

    void setDefaultShortcut(
        int key, const QKeySequence & shortcut, const Account & account,
        QString context = {});

    void setNonStandardDefaultShortcut(
        QString nonStandardKey, const QKeySequence & shortcut,
        const Account & account, QString context = {});

private:
    class ShortcutManagerPrivate;

    ShortcutManagerPrivate * const d_ptr;
    Q_DECLARE_PRIVATE(ShortcutManager)
};

} // namespace quentier::utility