1/****************************************************************************
2**
3** Copyright (C) 2020 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWidgets 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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QUNDOGROUP_H
41#define QUNDOGROUP_H
42
43#include <QtGui/qtguiglobal.h>
44#include <QtCore/qobject.h>
45#include <QtCore/qstring.h>
46
47QT_REQUIRE_CONFIG(undogroup);
48
49QT_BEGIN_NAMESPACE
50
51class QUndoGroupPrivate;
52class QUndoStack;
53class QAction;
54
55class Q_GUI_EXPORT QUndoGroup : public QObject
56{
57 Q_OBJECT
58 Q_DECLARE_PRIVATE(QUndoGroup)
59
60public:
61 explicit QUndoGroup(QObject *parent = nullptr);
62 ~QUndoGroup();
63
64 void addStack(QUndoStack *stack);
65 void removeStack(QUndoStack *stack);
66 QList<QUndoStack*> stacks() const;
67 QUndoStack *activeStack() const;
68
69#ifndef QT_NO_ACTION
70 QAction *createUndoAction(QObject *parent, const QString &prefix = QString()) const;
71 QAction *createRedoAction(QObject *parent, const QString &prefix = QString()) const;
72#endif // QT_NO_ACTION
73
74 bool canUndo() const;
75 bool canRedo() const;
76 QString undoText() const;
77 QString redoText() const;
78 bool isClean() const;
79
80public Q_SLOTS:
81 void undo();
82 void redo();
83 void setActiveStack(QUndoStack *stack);
84
85Q_SIGNALS:
86 void activeStackChanged(QUndoStack *stack);
87 void indexChanged(int idx);
88 void cleanChanged(bool clean);
89 void canUndoChanged(bool canUndo);
90 void canRedoChanged(bool canRedo);
91 void undoTextChanged(const QString &undoText);
92 void redoTextChanged(const QString &redoText);
93
94private:
95 Q_DISABLE_COPY(QUndoGroup)
96};
97
98QT_END_NAMESPACE
99
100#endif // QUNDOGROUP_H
101