kcommand.h

/* This file is part of the KDE project
   Copyright (C) 2000 Werner Trobin <trobin@kde.org>
   Copyright (C) 2000 David Faure <faure@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef kcommand_h
#define kcommand_h

#include <tqptrlist.h>
#include <tqstring.h>
#include <tqobject.h>
#include <tdelibs_export.h>

class TDEAction;
class TDEActionCollection;
class TQPopupMenu;

class TDEUI_EXPORT KCommand
{
protected:
    KCommand() {}

public:
    virtual ~KCommand();

    virtual void execute() = 0;
    virtual void unexecute() = 0;

    virtual TQString name() const = 0;
protected:
    virtual void virtual_hook( int id, void* data );
};

class TDEUI_EXPORT KNamedCommand : public KCommand
{
protected:
    KNamedCommand(const TQString &name) : KCommand(), m_name(name) {}

public:
    virtual TQString name() const { return m_name; }
    void setName(const TQString &name) { m_name=name; }

private:
    TQString m_name;
protected:
    virtual void virtual_hook( int id, void* data );
};

class TDEUI_EXPORT KMacroCommand : public KNamedCommand
{
public:
    KMacroCommand( const TQString & name );
    virtual ~KMacroCommand() {}

    void addCommand(KCommand *command);

    virtual void execute();
    virtual void unexecute();

protected:
    TQPtrList<KCommand> m_commands;
protected:
    virtual void virtual_hook( int id, void* data );
};


class TDEUI_EXPORT KCommandHistory : public TQObject {
    TQ_OBJECT
public:
    KCommandHistory();

    KCommandHistory(TDEActionCollection *actionCollection, bool withMenus = true);

    virtual ~KCommandHistory();

    void clear();

    void addCommand(KCommand *command, bool execute=true);

    int undoLimit() const { return m_undoLimit; }
    void setUndoLimit(int limit);
    int redoLimit() const { return m_redoLimit; }
    void setRedoLimit(int limit);

    void updateActions();

public slots:
    virtual void undo();
    virtual void redo();
    virtual void documentSaved();

protected slots:
    void slotUndoAboutToShow();
    void slotUndoActivated( int );
    void slotRedoAboutToShow();
    void slotRedoActivated( int );

signals:
    void commandExecuted();

    void commandExecuted(KCommand *command);

    void documentRestored();

private:
    void clipCommands();  // ensures that the limits are kept

    TQPtrList<KCommand> m_commands;
    TDEAction *m_undo, *m_redo;
    TQPopupMenu *m_undoPopup, *m_redoPopup;
    int m_undoLimit, m_redoLimit;
    bool m_first;  // attention: it's the first command in the list!
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KCommandHistoryPrivate;
    KCommandHistoryPrivate *d;
};

#endif