k3command.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2000 Werner Trobin <trobin@kde.org>
   Copyright (C) 2000,2006 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 <kde3support_export.h>

#include <QtCore/QList>
#include <QtCore/QString>
#include <QtCore/QObject>

class KAction;
class KActionCollection;
class QAction;

class KDE3SUPPORT_EXPORT K3Command
{
protected:
    K3Command();

public:
    virtual ~K3Command();

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

    virtual QString name() const = 0;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class Private;
    Private* const d;
    Q_DISABLE_COPY( K3Command )
};

class KDE3SUPPORT_EXPORT K3NamedCommand : public K3Command
{
protected:
    K3NamedCommand( const QString &name );

public:
    virtual QString name() const;
    void setName( const QString &name );

    virtual ~K3NamedCommand();

protected:
    virtual void virtual_hook( int id, void* data );

private:
    class Private;
    Private* const d;
    Q_DISABLE_COPY( K3NamedCommand )
};

class KDE3SUPPORT_EXPORT K3MacroCommand : public K3NamedCommand
{
public:
    K3MacroCommand( const QString & name );
    virtual ~K3MacroCommand();

    void addCommand(K3Command *command);

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

protected:
    const QList<K3Command *> commands() const;

    virtual void virtual_hook( int id, void* data );

private:
    class Private;
    Private* const d;
    Q_DISABLE_COPY( K3MacroCommand )
};


class KDE3SUPPORT_EXPORT K3CommandHistory : public QObject {
    Q_OBJECT
public:
    K3CommandHistory();

    K3CommandHistory(KActionCollection *actionCollection, bool withMenus = true);

    virtual ~K3CommandHistory();

    void clear();

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

    int undoLimit() const;
    void setUndoLimit(int limit);
    int redoLimit() const;
    void setRedoLimit(int limit);

    void updateActions();

    K3Command * presentCommand() const;

    bool isUndoAvailable() const;

    bool isRedoAvailable() const;

    QList<K3Command *> undoCommands( int maxCommands = 0 ) const;

    QList<K3Command *> redoCommands( int maxCommands = 0 ) const;

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

Q_SIGNALS:
    void commandExecuted(K3Command *command);

    void documentRestored();

    void commandHistoryChanged();

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

private:
    class K3CommandHistoryPrivate;
    K3CommandHistoryPrivate * const d;
    Q_DISABLE_COPY( K3CommandHistory )
};

#include <ktoolbarpopupaction.h>

class K3UndoRedoAction : public KToolBarPopupAction
{
    Q_OBJECT
public:
    enum Type { Undo, Redo };
    K3UndoRedoAction( Type type, KActionCollection* actionCollection, K3CommandHistory* commandHistory );

private Q_SLOTS:
    void slotAboutToShow();
    void slotActionTriggered( QAction *action );
    void slotCommandHistoryChanged();

private:
    class Private;
    Private* const d;
    Q_DISABLE_COPY( K3UndoRedoAction )
};

#endif