- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Directories
- Examples

- File List
- File Members

# qundostack.h

Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
    00004 ** All rights reserved.
    00005 ** Contact: Nokia Corporation (qt-info@nokia.com)
    00006 **
    00007 ** This file is part of the QtGui module of the Qt Toolkit.
    00008 **
    00009 ** $QT_BEGIN_LICENSE:LGPL$
    00010 ** Commercial Usage
    00011 ** Licensees holding valid Qt Commercial licenses may use this file in
    00012 ** accordance with the Qt Commercial License Agreement provided with the
    00013 ** Software or, alternatively, in accordance with the terms contained in
    00014 ** a written agreement between you and Nokia.
    00015 **
    00016 ** GNU Lesser General Public License Usage
    00017 ** Alternatively, this file may be used under the terms of the GNU Lesser
    00018 ** General Public License version 2.1 as published by the Free Software
    00019 ** Foundation and appearing in the file LICENSE.LGPL included in the
    00020 ** packaging of this file.  Please review the following information to
    00021 ** ensure the GNU Lesser General Public License version 2.1 requirements
    00022 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    00023 **
    00024 ** In addition, as a special exception, Nokia gives you certain additional
    00025 ** rights.  These rights are described in the Nokia Qt LGPL Exception
    00026 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this module.
    00027 **
    00028 ** GNU General Public License Usage
    00029 ** Alternatively, this file may be used under the terms of the GNU
    00030 ** General Public License version 3.0 as published by the Free Software
    00031 ** Foundation and appearing in the file LICENSE.GPL included in the
    00032 ** packaging of this file.  Please review the following information to
    00033 ** ensure the GNU General Public License version 3.0 requirements will be
    00034 ** met: http://www.gnu.org/copyleft/gpl.html.
    00035 **
    00036 ** If you have questions regarding the use of this file, please contact
    00037 ** Nokia at qt-info@nokia.com.
    00038 ** $QT_END_LICENSE$
    00039 **
    00040 ****************************************************************************/
    00041
    00042 #ifndef QUNDOSTACK_H
    00043 #define QUNDOSTACK_H
    00044
    00045 #include <QtCore/qobject.h>
    00046 #include <QtCore/qstring.h>
    00047
    00048 QT_BEGIN_HEADER
    00049
    00050 QT_BEGIN_NAMESPACE
    00051
    00052 QT_MODULE(Gui)
    00053
    00054 class QAction;
    00055 class QUndoCommandPrivate;
    00056 class QUndoStackPrivate;
    00057
    00058 #ifndef QT_NO_UNDOCOMMAND
    00059
    00060 class Q_GUI_EXPORT QUndoCommand
    00061 {
    00062     QUndoCommandPrivate *d;
    00063
    00064 public:
    00065     explicit QUndoCommand(QUndoCommand *parent = 0);
    00066     explicit QUndoCommand(const QString &text, QUndoCommand *parent = 0);
    00067     virtual ~QUndoCommand();
    00068
    00069     virtual void undo();
    00070     virtual void redo();
    00071
    00072     QString text() const;
    00073     void setText(const QString &text);
    00074
    00075     virtual int id() const;
    00076     virtual bool mergeWith(const QUndoCommand *other);
    00077
    00078     int childCount() const;
    00079     const QUndoCommand *child(int index) const;
    00080
    00081 private:
    00082     Q_DISABLE_COPY(QUndoCommand)
    00083     friend class QUndoStack;
    00084 };
    00085
    00086 #endif // QT_NO_UNDOCOMMAND
    00087
    00088 #ifndef QT_NO_UNDOSTACK
    00089
    00090 class Q_GUI_EXPORT QUndoStack : public QObject
    00091 {
    00092     Q_OBJECT
    00093     Q_DECLARE_PRIVATE(QUndoStack)
    00094     Q_PROPERTY(bool active READ isActive WRITE setActive)
    00095     Q_PROPERTY(int undoLimit READ undoLimit WRITE setUndoLimit)
    00096
    00097 public:
    00098     explicit QUndoStack(QObject *parent = 0);
    00099     ~QUndoStack();
    00100     void clear();
    00101
    00102     void push(QUndoCommand *cmd);
    00103
    00104     bool canUndo() const;
    00105     bool canRedo() const;
    00106     QString undoText() const;
    00107     QString redoText() const;
    00108
    00109     int count() const;
    00110     int index() const;
    00111     QString text(int idx) const;
    00112
    00113 #ifndef QT_NO_ACTION
    00114     QAction *createUndoAction(QObject *parent,
    00115                                 const QString &prefix = QString()) const;
    00116     QAction *createRedoAction(QObject *parent,
    00117                                 const QString &prefix = QString()) const;
    00118 #endif // QT_NO_ACTION
    00119
    00120     bool isActive() const;
    00121     bool isClean() const;
    00122     int cleanIndex() const;
    00123
    00124     void beginMacro(const QString &text);
    00125     void endMacro();
    00126
    00127     void setUndoLimit(int limit);
    00128     int undoLimit() const;
    00129
    00130     const QUndoCommand *command(int index) const;
    00131
    00132 public Q_SLOTS:
    00133     void setClean();
    00134     void setIndex(int idx);
    00135     void undo();
    00136     void redo();
    00137     void setActive(bool active = true);
    00138
    00139 Q_SIGNALS:
    00140     void indexChanged(int idx);
    00141     void cleanChanged(bool clean);
    00142     void canUndoChanged(bool canUndo);
    00143     void canRedoChanged(bool canRedo);
    00144     void undoTextChanged(const QString &undoText);
    00145     void redoTextChanged(const QString &redoText);
    00146
    00147 private:
    00148     Q_DISABLE_COPY(QUndoStack)
    00149     friend class QUndoGroup;
    00150 };
    00151
    00152 #endif // QT_NO_UNDOSTACK
    00153
    00154 QT_END_NAMESPACE
    00155
    00156 QT_END_HEADER
    00157
    00158 #endif // QUNDOSTACK_H