INoteEditorBackend.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/enml/Fwd.h>
#include <quentier/local_storage/Fwd.h>
#include <quentier/utility/Linkage.h>

#include <QPalette>
#include <QPrinter>
#include <QStringList>
#include <QThread>
#include <QWidget>

class QTextStream;
class QUndoStack;

namespace quentier {

class Account;
class ErrorString;
class NoteEditor;
class SpellChecker;

class QUENTIER_EXPORT INoteEditorBackend
{
public:
    virtual ~INoteEditorBackend() noexcept;

    virtual void initialize(
        local_storage::ILocalStoragePtr localStorage,
        SpellChecker & spellChecker, const Account & account,
        QThread * backgroundJobsThread,
        enml::IDecryptedTextCachePtr decryptedTextCache) = 0;

    [[nodiscard]] virtual QObject * object() = 0; // provide QObject interface
    [[nodiscard]] virtual QWidget * widget() = 0; // provide QWidget interface

    virtual void setAccount(const Account & account) = 0;
    virtual void setUndoStack(QUndoStack * pUndoStack) = 0;

    virtual void setInitialPageHtml(const QString & html) = 0;
    virtual void setNoteNotFoundPageHtml(const QString & html) = 0;
    virtual void setNoteDeletedPageHtml(const QString & html) = 0;
    virtual void setNoteLoadingPageHtml(const QString & html) = 0;

    [[nodiscard]] virtual bool isNoteLoaded() const = 0;
    [[nodiscard]] virtual qint64 idleTime() const = 0;

    virtual void convertToNote() = 0;
    virtual void saveNoteToLocalStorage() = 0;
    virtual void setNoteTitle(const QString & noteTitle) = 0;

    virtual void setTagIds(
        const QStringList & tagLocalUids, const QStringList & tagGuids) = 0;

    virtual void undo() = 0;
    virtual void redo() = 0;
    virtual void cut() = 0;
    virtual void copy() = 0;
    virtual void paste() = 0;
    virtual void pasteUnformatted() = 0;
    virtual void selectAll() = 0;

    virtual void formatSelectionAsSourceCode() = 0;

    virtual void fontMenu() = 0;
    virtual void textBold() = 0;
    virtual void textItalic() = 0;
    virtual void textUnderline() = 0;
    virtual void textStrikethrough() = 0;
    virtual void textHighlight() = 0;

    virtual void alignLeft() = 0;
    virtual void alignCenter() = 0;
    virtual void alignRight() = 0;
    virtual void alignFull() = 0;

    [[nodiscard]] virtual QString selectedText() const = 0;
    [[nodiscard]] virtual bool hasSelection() const = 0;

    virtual void findNext(const QString & text, bool matchCase) const = 0;

    virtual void findPrevious(const QString & text, bool matchCase) const = 0;

    virtual void replace(
        const QString & textToReplace, const QString & replacementText,
        bool matchCase) = 0;

    virtual void replaceAll(
        const QString & textToReplace, const QString & replacementText,
        bool matchCase) = 0;

    virtual void insertToDoCheckbox() = 0;

    virtual void insertInAppNoteLink(
        const QString & userId, const QString & shardId,
        const QString & noteGuid, const QString & linkText) = 0;

    virtual void setSpellcheck(bool enabled) = 0;
    [[nodiscard]] virtual bool spellCheckEnabled() const = 0;

    virtual void setFont(const QFont & font) = 0;
    virtual void setFontHeight(int height) = 0;
    virtual void setFontColor(const QColor & color) = 0;
    virtual void setBackgroundColor(const QColor & color) = 0;

    [[nodiscard]] virtual QPalette defaultPalette() const = 0;
    virtual void setDefaultPalette(const QPalette & pal) = 0;

    [[nodiscard]] virtual const QFont * defaultFont() const = 0;
    virtual void setDefaultFont(const QFont & font) = 0;

    virtual void insertHorizontalLine() = 0;

    virtual void increaseFontSize() = 0;
    virtual void decreaseFontSize() = 0;

    virtual void increaseIndentation() = 0;
    virtual void decreaseIndentation() = 0;

    virtual void insertBulletedList() = 0;
    virtual void insertNumberedList() = 0;

    virtual void insertTableDialog() = 0;

    virtual void insertFixedWidthTable(
        int rows, int columns, int widthInPixels) = 0;

    virtual void insertRelativeWidthTable(
        int rows, int columns, double relativeWidth) = 0;

    virtual void insertTableRow() = 0;
    virtual void insertTableColumn() = 0;
    virtual void removeTableRow() = 0;
    virtual void removeTableColumn() = 0;

    virtual void addAttachmentDialog() = 0;
    virtual void saveAttachmentDialog(const QByteArray & resourceHash) = 0;
    virtual void saveAttachmentUnderCursor() = 0;
    virtual void openAttachment(const QByteArray & resourceHash) = 0;
    virtual void openAttachmentUnderCursor() = 0;
    virtual void copyAttachment(const QByteArray & resourceHash) = 0;
    virtual void copyAttachmentUnderCursor() = 0;
    virtual void removeAttachment(const QByteArray & resourceHash) = 0;
    virtual void removeAttachmentUnderCursor() = 0;
    virtual void renameAttachment(const QByteArray & resourceHash) = 0;
    virtual void renameAttachmentUnderCursor() = 0;

    enum class Rotation
    {
        Clockwise,
        Counterclockwise
    };

    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, Rotation rotation);

    friend QUENTIER_EXPORT QDebug & operator<<(QDebug & dbg, Rotation rotation);

    virtual void rotateImageAttachment(
        const QByteArray & resourceHash, Rotation rotationDirection) = 0;

    virtual void rotateImageAttachmentUnderCursor(
        Rotation rotationDirection) = 0;

    virtual void encryptSelectedText() = 0;

    virtual void decryptEncryptedTextUnderCursor() = 0;

    virtual void decryptEncryptedText(
        QString encryptedText, QString cipher, QString hint,
        QString enCryptIndex) = 0;

    virtual void hideDecryptedTextUnderCursor() = 0;

    virtual void hideDecryptedText(
        QString encryptedText, QString decryptedText, QString cipher,
        QString hint, QString enDecryptedIndex) = 0;

    virtual void editHyperlinkDialog() = 0;
    virtual void copyHyperlink() = 0;
    virtual void removeHyperlink() = 0;

    virtual void onNoteLoadCancelled() = 0;

    [[nodiscard]] virtual bool print(
        QPrinter & printer, ErrorString & errorDescription) = 0;

    [[nodiscard]] virtual bool exportToPdf(
        const QString & absoluteFilePath, ErrorString & errorDescription) = 0;

    [[nodiscard]] virtual bool exportToEnex(
        const QStringList & tagNames, QString & enex,
        ErrorString & errorDescription) = 0;

    [[nodiscard]] virtual QString currentNoteLocalId() const = 0;
    virtual void setCurrentNoteLocalId(const QString & noteLocalUid) = 0;

    virtual void clear() = 0;

    [[nodiscard]] virtual bool isModified() const = 0;
    [[nodiscard]] virtual bool isEditorPageModified() const = 0;

    virtual void setFocusToEditor() = 0;

protected:
    INoteEditorBackend(NoteEditor * parent);
    NoteEditor * m_pNoteEditor;
};

} // namespace quentier