1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtGui module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QUNDOSTACK_H

    43 #define QUNDOSTACK_H

    44 

    45 #include <QtCore/qobject.h>

    46 #include <QtCore/qstring.h>

    47 

    48 QT_BEGIN_HEADER

    49 

    50 QT_BEGIN_NAMESPACE

    51 

    52 QT_MODULE(Gui)

    53 

    54 class QAction;

    55 class QUndoCommandPrivate;

    56 class QUndoStackPrivate;

    57 

    58 #ifndef QT_NO_UNDOCOMMAND

    59 

    60 class Q_GUI_EXPORT QUndoCommand

    61 {

    62     QUndoCommandPrivate *d;

    63 

    64 public:

    65     explicit QUndoCommand(QUndoCommand *parent = 0);

    66     explicit QUndoCommand(const QString &text, QUndoCommand *parent = 0);

    67     virtual ~QUndoCommand();

    68 

    69     virtual void undo();

    70     virtual void redo();

    71 

    72     QString text() const;

    73     void setText(const QString &text);

    74 

    75     virtual int id() const;

    76     virtual bool mergeWith(const QUndoCommand *other);

    77 

    78     int childCount() const;

    79     const QUndoCommand *child(int index) const;

    80 

    81 private:

    82     Q_DISABLE_COPY(QUndoCommand)

    83     friend class QUndoStack;

    84 };

    85 

    86 #endif // QT_NO_UNDOCOMMAND

    87 

    88 #ifndef QT_NO_UNDOSTACK

    89 

    90 class Q_GUI_EXPORT QUndoStack : public QObject

    91 {

    92     Q_OBJECT

    93     Q_DECLARE_PRIVATE(QUndoStack)

    94     Q_PROPERTY(bool active READ isActive WRITE setActive)

    95     Q_PROPERTY(int undoLimit READ undoLimit WRITE setUndoLimit)

    96 

    97 public:

    98     explicit QUndoStack(QObject *parent = 0);

    99     ~QUndoStack();

   100     void clear();

   101 

   102     void push(QUndoCommand *cmd);

   103 

   104     bool canUndo() const;

   105     bool canRedo() const;

   106     QString undoText() const;

   107     QString redoText() const;

   108 

   109     int count() const;

   110     int index() const;

   111     QString text(int idx) const;

   112 

   113 #ifndef QT_NO_ACTION

   114     QAction *createUndoAction(QObject *parent,

   115                                 const QString &prefix = QString()) const;

   116     QAction *createRedoAction(QObject *parent,

   117                                 const QString &prefix = QString()) const;

   118 #endif // QT_NO_ACTION

   119 

   120     bool isActive() const;

   121     bool isClean() const;

   122     int cleanIndex() const;

   123 

   124     void beginMacro(const QString &text);

   125     void endMacro();

   126 

   127     void setUndoLimit(int limit);

   128     int undoLimit() const;

   129 

   130     const QUndoCommand *command(int index) const;

   131 

   132 public Q_SLOTS:

   133     void setClean();

   134     void setIndex(int idx);

   135     void undo();

   136     void redo();

   137     void setActive(bool active = true);

   138 

   139 Q_SIGNALS:

   140     void indexChanged(int idx);

   141     void cleanChanged(bool clean);

   142     void canUndoChanged(bool canUndo);

   143     void canRedoChanged(bool canRedo);

   144     void undoTextChanged(const QString &undoText);

   145     void redoTextChanged(const QString &redoText);

   146 

   147 private:

   148     Q_DISABLE_COPY(QUndoStack)

   149     friend class QUndoGroup;

   150 };

   151 

   152 #endif // QT_NO_UNDOSTACK

   153 

   154 QT_END_NAMESPACE

   155 

   156 QT_END_HEADER

   157 

   158 #endif // QUNDOSTACK_H