undoobject.h

/*
For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/
/***************************************************************************
 *   Copyright (C) 2005 by Riku Leino                                      *
 *   riku@scribus.info                                                     *
 *                                                                         *
 *   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 2 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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.             *
 ***************************************************************************/

#ifndef UNDOOBJECT_H
#define UNDOOBJECT_H

#include <QPixmap>
#include <QString>

#include "scribusapi.h"
#include "scguardedptr.h"

class UndoState;

class SCRIBUS_API UndoObject
{
public:
    UndoObject();

    UndoObject(const UndoObject& other);

    UndoObject(const QString &objectName, QPixmap *objectIcon = 0);

    virtual ~UndoObject();

    virtual QString getUName();

    virtual void setUName(QString newUName);

    virtual QPixmap* getUPixmap();

    virtual void setUPixmap(QPixmap *newUPixmap);

    ulong getUId() const;

    const ScGuardedPtr<UndoObject>& undoObjectPtr();

    virtual void restore(UndoState* state, bool isUndo) = 0;
private:
    static ulong m_nextId;
    
    ulong m_id;
    
    QString m_uname;
    
    QPixmap *m_upixmap;

    ScGuardedObject<UndoObject> m_objectPtr;
};
typedef ScGuardedPtr<UndoObject> UndoObjectPtr;

class SCRIBUS_API DummyUndoObject : public UndoObject
{
public:
    DummyUndoObject() {};
    virtual ~DummyUndoObject() {};
    void restore(UndoState*, bool) {};
};

#endif