summaryrefslogtreecommitdiff
path: root/svl/inc/svl/undo.hxx
blob: 6dc49a3aa9b35f66801dd24f3bbf5b6901b08ecc (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
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef _UNDO_HXX
#define _UNDO_HXX

#include "svl/svldllapi.h"
#include <tools/rtti.hxx>
#include <tools/string.hxx>
#include <svl/svarray.hxx>

//====================================================================

class SVL_DLLPUBLIC SfxRepeatTarget
{
public:
                        TYPEINFO();
    virtual 			~SfxRepeatTarget() = 0;
};

//====================================================================

class SVL_DLLPUBLIC SfxUndoAction
{
    BOOL bLinked;
public:
                            TYPEINFO();
                            SfxUndoAction();
    virtual 				~SfxUndoAction();

    virtual BOOL            IsLinked();
    virtual void            SetLinked( BOOL bIsLinked = TRUE );
    virtual void			Undo();
    virtual void			Redo();
    virtual void			Repeat(SfxRepeatTarget&);
    virtual BOOL			CanRepeat(SfxRepeatTarget&) const;

    virtual BOOL			Merge( SfxUndoAction *pNextAction );

    virtual UniString			GetComment() const;
    virtual UniString			GetRepeatComment(SfxRepeatTarget&) const;
    virtual USHORT			GetId() const;

private:
    SfxUndoAction&			operator=( const SfxUndoAction& );	  // n.i.!!
};

//========================================================================

SV_DECL_PTRARR( SfxUndoActions, SfxUndoAction*, 20, 8 )

//====================================================================

/** do not make use of this implementation details, unless you
    really really have to! */
struct SVL_DLLPUBLIC SfxUndoArray
{
    SfxUndoActions          aUndoActions;
    USHORT					nMaxUndoActions;
    USHORT					nCurUndoAction;
    SfxUndoArray 			*pFatherUndoArray;
                            SfxUndoArray(USHORT nMax=0):
                                nMaxUndoActions(nMax), nCurUndoAction(0),
                                pFatherUndoArray(0) {}
                           ~SfxUndoArray();
};

//=========================================================================

/** do not make use of this implementation details, unless you
    really really have to! */
class SVL_DLLPUBLIC SfxListUndoAction : public SfxUndoAction, public SfxUndoArray

/*	[Beschreibung]

    UndoAction zur Klammerung mehrerer Undos in einer UndoAction.
    Diese Actions werden vom SfxUndoManager verwendet. Dort
    wird mit < SfxUndoManager::EnterListAction > eine Klammerebene
    geoeffnet und mit <SfxUndoManager::LeaveListAction > wieder
    geschlossen. Redo und Undo auf SfxListUndoActions wirken
    Elementweise.

*/
{
    public:
                            TYPEINFO();

                            SfxListUndoAction( const UniString &rComment,
                                const UniString rRepeatComment, USHORT Id, SfxUndoArray *pFather);
    virtual void			Undo();
    virtual void			Redo();
    virtual void			Repeat(SfxRepeatTarget&);
    virtual BOOL			CanRepeat(SfxRepeatTarget&) const;

    virtual BOOL			Merge( SfxUndoAction *pNextAction );

    virtual UniString			GetComment() const;
    virtual UniString			GetRepeatComment(SfxRepeatTarget&) const;
    virtual USHORT			GetId() const;

    void SetComment( const UniString& rComment );

    private:

    USHORT					nId;
    UniString					aComment, aRepeatComment;

};

//=========================================================================

class SVL_DLLPUBLIC SfxUndoManager
{
    friend class SfxLinkUndoAction;

    SfxUndoArray 			*pUndoArray;
    SfxUndoArray			*pActUndoArray;
    SfxUndoArray			*pFatherUndoArray;

    bool					mbUndoEnabled;
public:
                            SfxUndoManager( USHORT nMaxUndoActionCount = 20 );
    virtual 				~SfxUndoManager();

    virtual void			SetMaxUndoActionCount( USHORT nMaxUndoActionCount );
    virtual USHORT			GetMaxUndoActionCount() const;
    virtual void			Clear();

    virtual void			AddUndoAction( SfxUndoAction *pAction, BOOL bTryMerg=FALSE );

    virtual USHORT			GetUndoActionCount() const;
    virtual USHORT			GetUndoActionId(USHORT nNo=0) const;
    virtual UniString		GetUndoActionComment( USHORT nNo=0 ) const;
    /** returns the nNo'th undo action from the top */
    SfxUndoAction*			GetUndoAction( USHORT nNo=0 ) const;

    virtual BOOL			Undo( USHORT nCount=1 );
    virtual void			Undo( SfxUndoAction &rAction );

    virtual USHORT			GetRedoActionCount() const;
    virtual USHORT			GetRedoActionId(USHORT nNo=0) const;
    virtual UniString			GetRedoActionComment( USHORT nNo=0 ) const;

    virtual BOOL			Redo( USHORT nCount=1 );
    virtual void			Redo( SfxUndoAction &rAction );
    virtual	void			ClearRedo();

    virtual USHORT			GetRepeatActionCount() const;
    virtual UniString			GetRepeatActionComment( SfxRepeatTarget &rTarget, USHORT nNo = 0) const;
    virtual BOOL			Repeat( SfxRepeatTarget &rTarget, USHORT nFrom=0, USHORT nCount=1 );
    virtual void			Repeat( SfxRepeatTarget &rTarget, SfxUndoAction &rAction );
    virtual BOOL			CanRepeat( SfxRepeatTarget &rTarget, USHORT nNo = 0 ) const;
    virtual BOOL			CanRepeat( SfxRepeatTarget &rTarget, SfxUndoAction &rAction ) const;

    virtual void            EnterListAction(const UniString &rComment, const UniString& rRepeatComment, USHORT nId=0);
    virtual void 			LeaveListAction();

    /** clears the redo stack and removes the top undo action */
    void					RemoveLastUndoAction();

    // enables (true) or disables (false) recording of undo actions
    // If undo actions are added while undo is disabled, they are deleted.
    // Disabling undo does not clear the current undo buffer!
    void					EnableUndo( bool bEnable );

    // returns true if undo is currently enabled
    // This returns false if undo was disabled using EnableUndo( false ) and
    // also during the runtime of the Undo() and Redo() methods.
    bool					IsUndoEnabled() const { return mbUndoEnabled; }
};

//=========================================================================

class SVL_DLLPUBLIC SfxLinkUndoAction : public SfxUndoAction

/*	[Beschreibung]

    Die SfxLinkUndoAction dient zur Verbindung zweier SfxUndoManager. Die
    im ersten SfxUndoManager eingefuegten SfxUndoAction leiten ihr Undo und Redo
    an den zweiten weiter, so dass ein Undo und Redo am ersten
    SfxUndoManager wie eine am zweiten wirkt.

    Die SfxLinkUndoAction ist nach dem Einfuegen der SfxUndoAction am
    zweiten SfxUndoManager einzufuegen. Waehrend der zweite SfxUndoManager
    vom ersten ferngesteuert wird, duerfen an ihm weder Actions eingefuegt werden,
    noch darf Undo/Redo aufgerufen werden.

*/

{
public:
                            TYPEINFO();
                            SfxLinkUndoAction(SfxUndoManager *pManager);
                            ~SfxLinkUndoAction();

    virtual void			Undo();
    virtual void			Redo();
    virtual BOOL			CanRepeat(SfxRepeatTarget& r) const;

    virtual void			Repeat(SfxRepeatTarget&r);

    virtual UniString			GetComment() const;
    virtual UniString			GetRepeatComment(SfxRepeatTarget&r) const;
    virtual USHORT			GetId() const;

    SfxUndoAction*			GetAction() const { return pAction; }

protected:
    SfxUndoManager			*pUndoManager;
    SfxUndoAction			*pAction;

};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */