undogui.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                                      *
 *   tsoots@gmail.com                                                      *
 *                                                                         *
 *   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 UNDOGUI_H
#define UNDOGUI_H

#include <QListWidgetItem>
#include <QPushButton>

#include "scribusapi.h"
#include "undoobject.h"
#include "undostate.h"
#include "ui/scdockpalette.h"

class QEvent;
class QMenu;
class QListWidget;
class QCheckBox;


class SCRIBUS_API UndoGui : public ScDockPalette
{
    Q_OBJECT

public:
    UndoGui(QWidget* parent = 0, const char* name = "UndoGui", Qt::WindowFlags f = 0);

    virtual ~UndoGui() {};

    virtual void clear() = 0;

    virtual void languageChange();
    
public slots:
    virtual void insertUndoItem(UndoObject* target, UndoState* state) = 0;

    virtual void insertRedoItem(UndoObject* target, UndoState* state) = 0;

    virtual void updateUndo(int steps) = 0;

    virtual void updateRedo(int steps) = 0;
    
    virtual void updateUndoActions() = 0;
    
    virtual void clearRedo() = 0;

    virtual void popBack() = 0;
/* signals: do not implement these but emit when action happens
    virtual void undo(int steps) = 0;
    virtual void redo(int steps) = 0;
*/
};

/*** UndoGui implementations **************************************************/
/*** UndoWidget ***************************************************************/

class SCRIBUS_API UndoWidget : public UndoGui
{
    Q_OBJECT

private:
    static const uint MENU_HEIGHT = 5;
    std::vector<QString> undoItems;
    std::vector<QString> redoItems;
    /* BnF buttons
    QToolButton* undoButton;
    QToolButton* redoButton;
    */
    QMenu* undoMenu;
    QMenu* redoMenu;
    void updateUndoMenu();
    void updateRedoMenu();
public:
    UndoWidget(QWidget* parent = 0, const char* name = 0);

    virtual ~UndoWidget();

    void clear();
    virtual void updateUndoActions();
        
private slots:
    void undoClicked();
    void redoClicked();
    void undoMenuClicked(QAction *id);
    void redoMenuClicked(QAction *id);
public slots:
    void insertUndoItem(UndoObject* target, UndoState* state);

    void insertRedoItem(UndoObject* target, UndoState* state);

    void updateUndo(int steps);

    void updateRedo(int steps);
    
    void clearRedo();
    
    void popBack();
signals:
    void undo(int steps);

    void redo(int steps);
};

/*** UndoPalette **************************************************************/

class SCRIBUS_API UndoPalette : public UndoGui
{
    Q_OBJECT

private:
    QWidget* container;
    int currentSelection;
    int redoItems;
    QListWidget* undoList;
    QCheckBox* objectBox;
    QPushButton* undoButton;
    QPushButton* redoButton;
    QKeySequence initialUndoKS;
    QKeySequence initialRedoKS;
    void updateList();
    void removeRedoItems();
    
/*** UndoPalette::UndoItem ****************************************************/
    
    class UndoItem : public QListWidgetItem
    {
    private:
        QPixmap *targetpixmap;
        QPixmap *actionpixmap;
        QString target;
        QString action;
        QString description;
        bool isUndoAction_;
    public:
        UndoItem();
        UndoItem(const UndoItem &another);
        UndoItem(const QString &targetName,
                 const QString &actionName,
                 const QString &actionDescription,
                 QPixmap *targetPixmap,
                 QPixmap *actionPixmap,
                 bool isUndoAction,
                 QListWidget * parent = 0);
        ~UndoItem();
        /*void paint(QPainter *painter);
        int height(const QListWidget*) const;
        int width(const QListWidget*) const;*/
        QString getDescription();
        bool isUndoAction();
        void setUndoAction(bool isUndo);
    };
    
/******************************************************************************/

private slots:
    void undoClicked();
    void redoClicked();
    void undoListClicked(int i);
    void showToolTip(QListWidgetItem *i);
    void removeToolTip();
    void objectCheckBoxClicked(bool on);

public:
    UndoPalette(QWidget* parent = 0, const char* name = 0);

    ~UndoPalette();
    
    virtual void changeEvent(QEvent *e);

    void clear();
    virtual void updateUndoActions();
    
public slots:
    void languageChange();
    
    void insertUndoItem(UndoObject* target, UndoState* state);

    void insertRedoItem(UndoObject* target, UndoState* state);

    void updateUndo(int steps);

    void updateRedo(int steps);

    void clearRedo();
    
    void popBack();

    void updateFromPrefs();

signals:

    void objectMode(bool isEnabled);
    void undo(int steps);

    void redo(int steps);

};

#endif // UNDOGUI_H