QuentierUndoCommand.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/ErrorString.h>

#include <QObject>
#include <QUndoCommand>

namespace quentier::utility {

class QuentierUndoCommand : public QObject, public QUndoCommand
{
    Q_OBJECT
public:
    QuentierUndoCommand(QUndoCommand * parent = nullptr);
    QuentierUndoCommand(const QString & text, QUndoCommand * parent = nullptr);
    ~QuentierUndoCommand() noexcept override;

    void undo() final;
    void redo() final;

    [[nodiscard]] bool onceUndoExecuted() const noexcept
    {
        return m_onceUndoExecuted;
    }

Q_SIGNALS:
    void notifyError(ErrorString error);

protected:
    virtual void undoImpl() = 0;
    virtual void redoImpl() = 0;

private:
    bool m_onceUndoExecuted = false;
};

} // namespace quentier::utility