forked from openkylin/kolourpaint
147 lines
4.2 KiB
C++
147 lines
4.2 KiB
C++
|
|
/*
|
|
Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
1. Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
2. Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
|
|
#ifndef kpCommandHistoryBase_H
|
|
#define kpCommandHistoryBase_H
|
|
|
|
|
|
#include <QObject>
|
|
#include <QString>
|
|
#include <QList>
|
|
|
|
|
|
#include "commands/kpCommandSize.h"
|
|
|
|
class QAction;
|
|
|
|
class KActionCollection;
|
|
class KToolBarPopupAction;
|
|
|
|
class kpCommand;
|
|
|
|
|
|
// Clone of KCommandHistory with features required by KolourPaint but which
|
|
// could also be useful for other apps:
|
|
// - nextUndoCommand()/nextRedoCommand()
|
|
// - undo/redo history limited by both number and size
|
|
//
|
|
// Features not required by KolourPaint (e.g. commandExecuted()) are not
|
|
// implemented and undo limit == redo limit. So compared to
|
|
// KCommandHistory, this is only "almost source compatible".
|
|
class kpCommandHistoryBase : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
kpCommandHistoryBase (bool doReadConfig, KActionCollection *ac);
|
|
~kpCommandHistoryBase () override;
|
|
|
|
public:
|
|
// (provided for compatibility with KCommandHistory)
|
|
int undoLimit () const;
|
|
void setUndoLimit (int limit);
|
|
|
|
|
|
int undoMinLimit () const;
|
|
void setUndoMinLimit (int limit);
|
|
|
|
int undoMaxLimit () const;
|
|
void setUndoMaxLimit (int limit);
|
|
|
|
kpCommandSize::SizeType undoMaxLimitSizeLimit () const;
|
|
void setUndoMaxLimitSizeLimit (kpCommandSize::SizeType sizeLimit);
|
|
|
|
public:
|
|
// Read and write above config
|
|
void readConfig ();
|
|
void writeConfig ();
|
|
|
|
public:
|
|
void addCommand (kpCommand *command, bool execute = true);
|
|
void clear ();
|
|
|
|
protected slots:
|
|
// (same as undo() & redo() except they don't call
|
|
// trimCommandListsUpdateActions())
|
|
void undoInternal ();
|
|
void redoInternal ();
|
|
|
|
public slots:
|
|
virtual void undo ();
|
|
virtual void redo ();
|
|
|
|
virtual void undoUpToNumber (QAction *which);
|
|
virtual void redoUpToNumber (QAction *which);
|
|
|
|
protected:
|
|
QString undoActionText () const;
|
|
QString redoActionText () const;
|
|
|
|
QString undoActionToolTip () const;
|
|
QString redoActionToolTip () const;
|
|
|
|
void trimCommandListsUpdateActions ();
|
|
void trimCommandList(QList<kpCommand *> &commandList);
|
|
void trimCommandLists ();
|
|
void updateActions ();
|
|
|
|
public:
|
|
kpCommand *nextUndoCommand () const;
|
|
kpCommand *nextRedoCommand () const;
|
|
|
|
void setNextUndoCommand (kpCommand *command);
|
|
|
|
public slots:
|
|
virtual void documentSaved ();
|
|
|
|
signals:
|
|
void documentRestored ();
|
|
|
|
protected:
|
|
KToolBarPopupAction *m_actionUndo, *m_actionRedo;
|
|
|
|
// (Front element is the next one)
|
|
QList <kpCommand *> m_undoCommandList;
|
|
QList <kpCommand *> m_redoCommandList;
|
|
|
|
int m_undoMinLimit, m_undoMaxLimit;
|
|
kpCommandSize::SizeType m_undoMaxLimitSizeLimit;
|
|
|
|
// What you have to do to get back to the document's unmodified state:
|
|
// * -x: must Undo x times
|
|
// * 0: unmodified
|
|
// * +x: must Redo x times
|
|
// * INT_MAX: can never become unmodified again
|
|
//
|
|
// ASSUMPTION: will never have INT_MAX commands in any list.
|
|
int m_documentRestoredPosition;
|
|
};
|
|
|
|
|
|
#endif // kpCommandHistoryBase_H
|