Qt 4.8
qundostack.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
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 
49 
51 
52 QT_MODULE(Gui)
53 
54 class QAction;
56 class QUndoStackPrivate;
57 
58 #ifndef QT_NO_UNDOCOMMAND
59 
61 {
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  QString actionText() const;
74  void setText(const QString &text);
75 
76  virtual int id() const;
77  virtual bool mergeWith(const QUndoCommand *other);
78 
79  int childCount() const;
80  const QUndoCommand *child(int index) const;
81 
82 private:
84  friend class QUndoStack;
85 };
86 
87 #endif // QT_NO_UNDOCOMMAND
88 
89 #ifndef QT_NO_UNDOSTACK
90 
91 class Q_GUI_EXPORT QUndoStack : public QObject
92 {
93  Q_OBJECT
94  Q_DECLARE_PRIVATE(QUndoStack)
95  bool active;
96  int undoLimit;
97 
98 public:
99  explicit QUndoStack(QObject *parent = 0);
100  ~QUndoStack();
101  void clear();
102 
103  void push(QUndoCommand *cmd);
104 
105  bool canUndo() const;
106  bool canRedo() const;
107  QString undoText() const;
108  QString redoText() const;
109 
110  int count() const;
111  int index() const;
112  QString text(int idx) const;
113 
114 #ifndef QT_NO_ACTION
115  QAction *createUndoAction(QObject *parent,
116  const QString &prefix = QString()) const;
117  QAction *createRedoAction(QObject *parent,
118  const QString &prefix = QString()) const;
119 #endif // QT_NO_ACTION
120 
121  bool isActive() const;
122  bool isClean() const;
123  int cleanIndex() const;
124 
125  void beginMacro(const QString &text);
126  void endMacro();
127 
128  void setUndoLimit(int limit);
129  int undoLimit() const;
130 
131  const QUndoCommand *command(int index) const;
132 
133 public Q_SLOTS:
134  void setClean();
135  void setIndex(int idx);
136  void undo();
137  void redo();
138  void setActive(bool active = true);
139 
140 Q_SIGNALS:
141  void indexChanged(int idx);
142  void cleanChanged(bool clean);
143  void canUndoChanged(bool canUndo);
144  void canRedoChanged(bool canRedo);
145  void undoTextChanged(const QString &undoText);
146  void redoTextChanged(const QString &redoText);
147 
148 private:
149  Q_DISABLE_COPY(QUndoStack)
151 };
152 
153 #endif // QT_NO_UNDOSTACK
154 
156 
158 
159 #endif // QUNDOSTACK_H
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
static void clear(QVariant::Private *d)
Definition: qvariant.cpp:197
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
#define Q_SLOTS
Definition: qobjectdefs.h:71
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
#define Q_SIGNALS
Definition: qobjectdefs.h:72
The QUndoGroup class is a group of QUndoStack objects.
Definition: qundogroup.h:60
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
The QUndoStack class is a stack of QUndoCommand objects.
Definition: qundostack.h:91
#define Q_OBJECT
Definition: qobjectdefs.h:157
QUndoCommandPrivate * d
Definition: qundostack.h:62
static void setIndex(int *index, int candidate, int min, int max, bool isIncreasing)
Definition: qmdiarea.cpp:226
quint16 index
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
#define class
#define QT_END_HEADER
Definition: qglobal.h:137
The QUndoCommand class is the base class of all commands stored on a QUndoStack.
Definition: qundostack.h:60
The QAction class provides an abstract user interface action that can be inserted into widgets...
Definition: qaction.h:64
#define text
Definition: qobjectdefs.h:80