NoteEditor.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/types/ErrorString.h>
#include <quentier/utility/Linkage.h>
 
#include <qevercloud/types/Note.h>
#include <qevercloud/types/Notebook.h>
 
#include <QPrinter>
#include <QStringList>
#include <QThread>
#include <QWidget>
 
class QUndoStack;
 
namespace quentier {
 
class Account;
class INoteEditorBackend;
class SpellChecker;

class QUENTIER_EXPORT NoteEditor : public QWidget
{
    Q_OBJECT
public:
    explicit NoteEditor(
        QWidget * parent = nullptr,
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
        Qt::WindowFlags flags = {});
#else
        Qt::WindowFlags flags = 0); // NOLINT
#endif
 
    ~NoteEditor() noexcept override;

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

    [[nodiscard]] INoteEditorBackend * backend() noexcept;

    void setBackend(INoteEditorBackend * backend);

    void setAccount(const Account & account);

    [[nodiscard]] const QUndoStack * undoStack() const noexcept;

    void setUndoStack(QUndoStack * pUndoStack);

    void setInitialPageHtml(const QString & html);

    void setNoteNotFoundPageHtml(const QString & html);

    void setNoteDeletedPageHtml(const QString & html);

    void setNoteLoadingPageHtml(const QString & html);

    [[nodiscard]] QString currentNoteLocalId() const;

    void setCurrentNoteLocalId(const QString & noteLocalId);

    void clear();

    [[nodiscard]] bool isModified() const noexcept;

    [[nodiscard]] bool isEditorPageModified() const noexcept;

    [[nodiscard]] bool isNoteLoaded() const noexcept;

    [[nodiscard]] qint64 idleTime() const noexcept;

    void setFocus();
 
    [[nodiscard]] QString selectedText() const noexcept;
    [[nodiscard]] bool hasSelection() const noexcept;
 
    [[nodiscard]] bool spellCheckEnabled() const noexcept;
 
    [[nodiscard]] bool print(
        QPrinter & printer, ErrorString & errorDescription);
 
    [[nodiscard]] bool exportToPdf(
        const QString & absoluteFilePath, ErrorString & errorDescription);
 
    [[nodiscard]] bool exportToEnex(
        const QStringList & tagNames, QString & enex,
        ErrorString & errorDescription);

    [[nodiscard]] QPalette defaultPalette() const;

    [[nodiscard]] const QFont * defaultFont() const;
 
Q_SIGNALS:
    void contentChanged();

    void noteAndNotebookFoundInLocalStorage(
        qevercloud::Note note, qevercloud::Notebook notebook);

    void noteNotFound(QString noteLocalId);

    void noteDeleted(QString noteLocalId);

    void noteModified();

    void notifyError(ErrorString error);

    void inAppNoteLinkClicked(
        QString userId, QString shardId, QString noteGuid);

    void inAppNoteLinkPasteRequested(
        QString url, QString userId, QString shardId, QString noteGuid);
 
    void convertedToNote(qevercloud::Note note);
    void cantConvertToNote(ErrorString error);
 
    void noteEditorHtmlUpdated(QString html);
 
    void currentNoteChanged(qevercloud::Note note);
 
    void spellCheckerNotReady();
    void spellCheckerReady();
 
    void noteLoaded();

    void noteSavedToLocalStorage(QString noteLocalId);

    void failedToSaveNoteToLocalStorage(
        ErrorString errorDescription, QString noteLocalId);
 
    // Signals to notify anyone interested of the formatting at the current
    // cursor position
    void textBoldState(bool state);
    void textItalicState(bool state);
    void textUnderlineState(bool state);
    void textStrikethroughState(bool state);
    void textAlignLeftState(bool state);
    void textAlignCenterState(bool state);
    void textAlignRightState(bool state);
    void textAlignFullState(bool state);
    void textInsideOrderedListState(bool state);
    void textInsideUnorderedListState(bool state);
    void textInsideTableState(bool state);
 
    void textFontFamilyChanged(QString fontFamily);
    void textFontSizeChanged(int fontSize);
 
    void insertTableDialogRequested();
 
public Q_SLOTS:
    void convertToNote();

    void saveNoteToLocalStorage();

    void setNoteTitle(const QString & noteTitle);

    void setTagIds(
        const QStringList & tagLocalIds, const QStringList & tagGuids);
 
    void undo();
    void redo();
    void cut();
    void copy();
    void paste();
    void pasteUnformatted();
    void selectAll();
 
    void formatSelectionAsSourceCode();
 
    void fontMenu();
    void textBold();
    void textItalic();
    void textUnderline();
    void textStrikethrough();
    void textHighlight();
 
    void alignLeft();
    void alignCenter();
    void alignRight();
    void alignFull();
 
    void findNext(const QString & text, bool matchCase) const;
    void findPrevious(const QString & text, bool matchCase) const;
 
    void replace(
        const QString & textToReplace, const QString & replacementText,
        bool matchCase);
 
    void replaceAll(
        const QString & textToReplace, const QString & replacementText,
        bool matchCase);
 
    void insertToDoCheckbox();
 
    void insertInAppNoteLink(
        const QString & userId, const QString & shardId,
        const QString & noteGuid, const QString & linkText);
 
    void setSpellcheck(bool enabled);
 
    void setFont(const QFont & font);
    void setFontHeight(int height);
    void setFontColor(const QColor & color);
    void setBackgroundColor(const QColor & color);

    void setDefaultPalette(const QPalette & pal);

    void setDefaultFont(const QFont & font);
 
    void insertHorizontalLine();
 
    void increaseFontSize();
    void decreaseFontSize();
 
    void increaseIndentation();
    void decreaseIndentation();
 
    void insertBulletedList();
    void insertNumberedList();
 
    void insertTableDialog();
 
    void insertFixedWidthTable(int rows, int columns, int widthInPixels);
 
    void insertRelativeWidthTable(int rows, int columns, double relativeWidth);
 
    void insertTableRow();
    void insertTableColumn();
    void removeTableRow();
    void removeTableColumn();
 
    void addAttachmentDialog();
    void saveAttachmentDialog(const QByteArray & resourceHash);
    void saveAttachmentUnderCursor();
    void openAttachment(const QByteArray & resourceHash);
    void openAttachmentUnderCursor();
    void copyAttachment(const QByteArray & resourceHash);
    void copyAttachmentUnderCursor();
 
    void encryptSelectedText();
    void decryptEncryptedTextUnderCursor();
 
    void editHyperlinkDialog();
    void copyHyperlink();
    void removeHyperlink();
 
    void onNoteLoadCancelled();
 
protected:
    void dragMoveEvent(QDragMoveEvent * pEvent) override;
    void dropEvent(QDropEvent * pEvent) override;
 
private:
    INoteEditorBackend * m_backend;
};
 
} // namespace quentier