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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/***************************************************************************
* Copyright (C) 2006 by Peter Penz *
* [email protected] *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef UNDOMANAGER_H
#define UNDOMANAGER_H
#include <qobject.h>
#include <qvaluelist.h>
#include <kurl.h>
#include <kio/jobclasses.h>
class ProgressIndicator;
/**
* @short Represents a file manager command which can be undone and redone.
*
* A command is specified by a type, a list of source URLs and a
* destination URL.
*
* Due to the fixed set of commands a file manager offers this class is
* a very simplified version of the classic command pattern.
*
* @see UndoManager
* @author Peter Penz <[email protected]>
*/
class DolphinCommand
{
public:
enum Type {
Copy,
Move,
Link,
Rename,
Trash,
CreateFolder,
CreateFile
};
DolphinCommand();
DolphinCommand(Type type, const KURL::List& source, const KURL& dest);
~DolphinCommand(); // non-virtual
DolphinCommand& operator = (const DolphinCommand& command);
Type type() const { return m_type; }
void setSource(const KURL::List source) { m_source = source; }
const KURL::List& source() const { return m_source; }
const KURL& destination() const { return m_dest; }
private:
Type m_type;
int m_macroIndex;
KURL::List m_source;
KURL m_dest;
friend class UndoManager; // allow to modify m_macroIndex
};
/**
* @short Stores all file manager commands which can be undone and redone.
*
* During the undo and redo operations a progress information is
* shown in the status bar.
*
* @author Peter Penz <[email protected]>
*/
class UndoManager : public QObject
{
Q_OBJECT
public:
static UndoManager& instance();
/**
* Adds the command \a command to the undo list. The command
* can be undone by invoking UndoManager::undo().
*/
void addCommand(const DolphinCommand& command);
/**
* Allows to summarize several commands into one macro, which
* can be undo in one stop by UndoManager::undo(). Example
* \code
* UndoManager& undoMan = UndoManager.instance();
* undoMan.beginMacro();
* undoMan.addCommand(...);
* undoMan.addCommand(...);
* undoMan.addCommand(...);
* undoMan.endMacro();
* \endcode
* It is not allowed to do nested macro recordings.
*/
void beginMacro();
/**
* Marks the end of a macro command. See UndoManager::beginMacro()
* for sample code.
*/
void endMacro();
public slots:
/**
* Performs an undo operation on the last command which has
* been added by UndoManager::addCommand().
*/
void undo();
/**
* Performs a redo operation on the last command where an undo
* operation has been applied.
*/
void redo();
signals:
/**
* Is emitted if whenever the availability state
* of the current undo operation changes.
*/
void undoAvailable(bool available);
/**
* Is emitted whenever the text of the current
* undo operation changes
* (e. g. from 'Undo: Delete' to 'Undo: Copy')
*/
void undoTextChanged(const QString& text);
/**
* Is emitted if whenever the availability state
* of the current redo operation changes.
*/
void redoAvailable(bool available);
/**
* Is emitted whenever the text of the current
* redo operation changes
* (e. g. from 'Redo: Delete' to 'Redo: Copy')
*/
void redoTextChanged(const QString& text);
protected:
UndoManager();
virtual ~UndoManager();
QString commandText(const DolphinCommand& command) const;
private slots:
/**
* Slot for the percent information of the I/O slaves.
* Delegates the updating of the progress information
* to UndoManager::updateProgress().
*/
void slotPercent(KIO::Job* job, unsigned long percent);
/**
* Updates the progress information of the statusbar
* by accessing the progress indicator information.
*/
void updateProgress();
private:
bool m_recordMacro;
int m_historyIndex;
int m_macroCounter;
QValueList<DolphinCommand> m_history;
ProgressIndicator* m_progressIndicator;
/**
* Dependent from the current history index \a m_historyIndex
* the number of macro commands is written to the output
* parameter \a macroCount. The number of steps for all macro
* commands is written to the output parameter \a progressCount.
*
* Per default \a macroCount is 1 and \a progressCount represents
* the number of operations for one command.
*/
void calcStepsCount(int& macroCount,
int& progressCount);
};
#endif
|
