source: trunk/src/gui/util/qundogroup.cpp@ 466

Last change on this file since 466 was 2, checked in by Dmitry A. Kuminov, 17 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 15.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include "qundogroup.h"
43#include "qundostack.h"
44#include "qundostack_p.h"
45
46#ifndef QT_NO_UNDOGROUP
47
48QT_BEGIN_NAMESPACE
49
50class QUndoGroupPrivate : public QObjectPrivate
51{
52 Q_DECLARE_PUBLIC(QUndoGroup)
53public:
54 QUndoGroupPrivate() : active(0) {}
55
56 QUndoStack *active;
57 QList<QUndoStack*> stack_list;
58};
59
60/*!
61 \class QUndoGroup
62 \brief The QUndoGroup class is a group of QUndoStack objects.
63 \since 4.2
64 \ingroup misc
65
66 For an overview of the Qt's undo framework, see the
67 \link qundo.html overview\endlink.
68
69 An application often has multiple undo stacks, one for each opened document. At the
70 same time, an application usually has one undo action and one redo action, which
71 triggers undo or redo in the active document.
72
73 QUndoGroup is a group of QUndoStack objects, one of which may be active. It has
74 an undo() and redo() slot, which calls QUndoStack::undo() and QUndoStack::redo()
75 for the active stack. It also has the functions createUndoAction() and createRedoAction().
76 The actions returned by these functions behave in the same way as those returned by
77 QUndoStack::createUndoAction() and QUndoStack::createRedoAction() of the active
78 stack.
79
80 Stacks are added to a group with addStack() and removed with removeStack(). A stack
81 is implicitly added to a group when it is created with the group as its parent
82 QObject.
83
84 It is the programmer's responsibility to specify which stack is active by
85 calling QUndoStack::setActive(), usually when the associated document window receives focus.
86 The active stack may also be set with setActiveStack(), and is returned by activeStack().
87
88 When a stack is added to a group using addStack(), the group does not take ownership
89 of the stack. This means the stack has to be deleted separately from the group. When
90 a stack is deleted, it is automatically removed from a group. A stack may belong to