summaryrefslogtreecommitdiffstats
path: root/src/utils/uiundostack.h
blob: f74ae38fb81840570f2f5ee174a72c0e04ea21c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the UiHelpers playground module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef UIHELPERS_UIUNDOSTACK_H
#define UIHELPERS_UIUNDOSTACK_H

#include "uihelpersglobal.h"
#include <QtCore/qobject.h>
#include <QtCore/qstring.h>
#include <QStringList>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE_UIHELPERS


class UiAction;
class UiUndoCommandPrivate;
class UiUndoStackPrivate;

#ifndef QT_NO_UNDOCOMMAND

class UIHELPERS_EXPORT UiUndoCommand
{
    UiUndoCommandPrivate *d;
public:
    explicit UiUndoCommand(UiUndoCommand *parent = 0);
    explicit UiUndoCommand(const QString &text, UiUndoCommand *parent = 0);
    virtual ~UiUndoCommand();

    virtual void undo();
    virtual void redo();

    Q_INVOKABLE QString text() const;
    QString actionText() const;
    void setText(const QString &text);

    virtual int id() const;
    virtual bool mergeWith(const UiUndoCommand *other);

    int childCount() const;
    const UiUndoCommand *child(int index) const;

private:
    Q_DISABLE_COPY(UiUndoCommand)
    friend class UiUndoStack;
};

#endif // QT_NO_UNDOCOMMAND

#ifndef QT_NO_UNDOSTACK

class UIHELPERS_EXPORT UiUndoStack : public QObject
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(UiUndoStack)
    Q_PROPERTY(bool active READ isActive WRITE setActive)
    Q_PROPERTY(int undoLimit READ undoLimit WRITE setUndoLimit)
    Q_PROPERTY(QStringList stack READ stack NOTIFY stackChanged)

public:
    explicit UiUndoStack(QObject *parent = 0);
    ~UiUndoStack();
    void clear();

    void push(UiUndoCommand *cmd);

    QStringList stack() const;

    bool canUndo() const;
    bool canRedo() const;
    QString undoText() const;
    QString redoText() const;

    int count() const;
    int index() const;
    QString text(int idx) const;

#ifndef QT_NO_ACTION
    UiAction *createUndoAction(QObject *parent,
                                const QString &prefix = QString()) const;
    UiAction *createRedoAction(QObject *parent,
                                const QString &prefix = QString()) const;
#endif // QT_NO_ACTION

    bool isActive() const;
    bool isClean() const;
    int cleanIndex() const;

    void beginMacro(const QString &text);
    void endMacro();

    void setUndoLimit(int limit);
    int undoLimit() const;

    const UiUndoCommand *command(int index) const;

public Q_SLOTS:
    void setClean();
    void setIndex(int idx);
    void undo();
    void redo();
    void setActive(bool active = true);

Q_SIGNALS:
    void indexChanged(int idx);
    void cleanChanged(bool clean);
    void canUndoChanged(bool canUndo);
    void canRedoChanged(bool canRedo);
    void undoTextChanged(const QString &undoText);
    void redoTextChanged(const QString &redoText);
    void stackChanged();

private:
    Q_DISABLE_COPY(UiUndoStack)
    friend class UiUndoGroup;
};

#endif // QT_NO_UNDOSTACK

QT_END_NAMESPACE_UIHELPERS

QT_END_HEADER

#endif // UIHELPERS_UIUNDOSTACK_H