undocommand.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_EDITOR_UNDOCOMMAND_H
#define LIBREPCB_EDITOR_UNDOCOMMAND_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
namespace editor {
 
/*******************************************************************************
 *  Class UndoCommand
 ******************************************************************************/
 
class UndoCommand {
  Q_DECLARE_TR_FUNCTIONS(UndoCommand)
 
public:
  // Constructors / Destructor
  UndoCommand() = delete;
  UndoCommand(const UndoCommand& other) = delete;
  explicit UndoCommand(const QString& text) noexcept;
  virtual ~UndoCommand() noexcept;
 
  // Getters
  const QString& getText() const noexcept { return mText; }
 
  bool wasEverExecuted() const noexcept { return (mRedoCount > 0); }
 
  bool wasEverReverted() const noexcept { return (mUndoCount > 0); }
 
  bool isCurrentlyExecuted() const noexcept { return mRedoCount > mUndoCount; }
 
  // General Methods
 
  virtual bool execute() final;
 
  virtual void undo() final;
 
  virtual void redo() final;
 
  // Operator Overloadings
  UndoCommand& operator=(const UndoCommand& rhs) = delete;
 
protected:
  virtual bool performExecute() = 0;
 
  virtual void performUndo() = 0;
 
  virtual void performRedo() = 0;
 
private:
  QString mText;
  bool mIsExecuted;  
  int mRedoCount;  
  int mUndoCount;  
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif