1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/textformatting/inc/EditorUndo.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,167 @@
1.4 +/*
1.5 +* Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#ifndef EDITORUNDO_H_
1.23 +#define EDITORUNDO_H_
1.24 +
1.25 +#include "unified_editor.h"
1.26 +
1.27 +namespace UndoSystem
1.28 +/**
1.29 +@internalTechnology
1.30 +*/
1.31 +{
1.32 +class CCommandManager;
1.33 +class MNotUndoableGatekeeper;
1.34 +}
1.35 +
1.36 +class CEditorCommandFactory;
1.37 +
1.38 +/**
1.39 +MUnifiedEditor decorator that adds undo functionality.
1.40 +It passes commands transparently to the editor it is constructed upon, while
1.41 +storing the operations so that they can be undone and redone. Calling a
1.42 +non-const method of MUnifiedEditor wipes all 'Redo' operations.
1.43 +The undo and redo operations are only guaranteed to be accurate if the
1.44 +underlying editor satisfies certain conditions.
1.45 +
1.46 +@since App-frameworks6.1
1.47 +@internalAll
1.48 +*/
1.49 +class CEditorWithUndo : public CBase,
1.50 + public MUnifiedEditor,
1.51 + private MUnifiedEditor::MStyleSupport,
1.52 + private MUnifiedEditor::MPictureSupport,
1.53 + private MUnifiedEditor::MClipboardSupport
1.54 +
1.55 + {
1.56 +public:
1.57 + ~CEditorWithUndo();
1.58 +
1.59 + /**
1.60 + * Creates a CEditorWithUndo. It does not own the aEditor.
1.61 + */
1.62 + IMPORT_C static CEditorWithUndo* NewL(MUnifiedEditor& aEditor);
1.63 + /**
1.64 + * Creates a CEditorWithUndo, using the aSharedUndoSystem. This allows
1.65 + * many objects to stay in synchronization when each is accessed
1.66 + * seperately.
1.67 + * The aEditor is not owned.
1.68 + */
1.69 + IMPORT_C static CEditorWithUndo* NewL(MUnifiedEditor& aEditor,
1.70 + UndoSystem::CCommandManager* aSharedUndoSystem);
1.71 + /**
1.72 + * Undoes one operation or batch of operations. If one operation in the
1.73 + * middle of a batch leaves, this function will leave, but the underlying
1.74 + * editor will not necessarily be in the same state as it was in before
1.75 + * the call. However, all operations will still be stored, and so the
1.76 + * previous state is still recoverable with a call to RedoL() or a
1.77 + * further call to UndoL will complete the operation (resource acquisition
1.78 + * permitting).
1.79 + */
1.80 + IMPORT_C void UndoL();
1.81 + /**
1.82 + * Redoes one operation or batch of operations. If one operation in the
1.83 + * middle of a batch leaves, this function will leave, but the underlying
1.84 + * editor will not necessarily be in the same state as it was in before
1.85 + * the call. However, all operations will still be stored, and so the
1.86 + * previous state is still recoverable with a call to UndoL() or a
1.87 + * further call to RedoL will complete the operation (resource acquisition
1.88 + * permitting).
1.89 + */
1.90 + IMPORT_C void RedoL();
1.91 + /**
1.92 + * Returns ETrue iff UndoL() would have an effect
1.93 + */
1.94 + IMPORT_C TBool CanUndo() const;
1.95 + /**
1.96 + * Returns ETrue iff RedoL() would have an effect
1.97 + */
1.98 + IMPORT_C TBool CanRedo() const;
1.99 + /**
1.100 + * Wipes all undo and redo operations
1.101 + */
1.102 + IMPORT_C void ResetUndo();
1.103 + /**
1.104 + * Sets limits on the 'undo depth'. This is the numbet of times that
1.105 + * successive calls to UndoL() have an effect. When a depth of
1.106 + * aMaxItems is reached, the undo depth is reset to aMinItems.
1.107 + */
1.108 + IMPORT_C void SetMaxItems(TInt aMaxItems);
1.109 + /**
1.110 + * Sets a gatekeper for the undo system. This will be called whenever an
1.111 + * operation is attempted that cannot be undone for any reason.
1.112 + * The gatekeeper therefore has an oportunity to suppress execution and
1.113 + * keep the current undo operations stored.
1.114 + * NULL may be passed to restore default behaviour.
1.115 + * Returns the old gatekeeper.
1.116 + */
1.117 + IMPORT_C UndoSystem::MNotUndoableGatekeeper*
1.118 + SetGatekeeper(UndoSystem::MNotUndoableGatekeeper*);
1.119 +
1.120 + // From MUnifiedEditor
1.121 + MTmOptionalInterface* Interface(TUint aId);
1.122 + void InsertTextL(TInt aPos, const TDesC& aText, const TDesC* aStyle,
1.123 + const TTmCharFormatLayer*, const RTmParFormatLayer*);
1.124 + void DeleteTextL(TInt aPos,TInt aLength);
1.125 + void SetBaseFormatL(const TTmCharFormat&, const RTmParFormat&);
1.126 + void SetCharFormatL(TInt aPos, TInt aLength, const TTmCharFormatLayer&);
1.127 + void SetParFormatL(TInt aPos, TInt aLength, const RTmParFormatLayer&);
1.128 + void DeleteCharFormatL(TInt aPos, TInt aLength);
1.129 + void DeleteParFormatL(TInt aPos, TInt aLength);
1.130 + TInt DocumentLength() const;
1.131 + void GetText(TInt aPos, TPtrC& aText) const;
1.132 + void GetBaseFormatL(TTmCharFormat&, RTmParFormat&) const;
1.133 + void GetCharFormat(TInt aPos, TFormatLevel aLevel,
1.134 + TTmCharFormatLayer& aFormat,TInt& aRunLength) const;
1.135 + void GetParFormatL(TInt aPos, TFormatLevel aLevel,
1.136 + RTmParFormatLayer& aFormat, TInt& aRunLength) const;
1.137 +
1.138 +private:
1.139 + // from MStyleSupport
1.140 + TInt CreateStyleL(const RTmStyle&);
1.141 + TInt ChangeStyleL(const RTmStyle&);
1.142 + TInt SetStyleL(TInt aPos, TInt aLength, const TDesC&);
1.143 + TInt RenameStyleL(const TDesC& aOldName, const TDesC& aNewName);
1.144 + TInt DeleteStyleL(const TDesC& aName);
1.145 + TInt StyleCount() const;
1.146 + void GetStyle(TInt aPos, TPtrC& aName, TInt& aRunLength) const;
1.147 + TInt GetStyleByNameL(const TDesC& aName, RTmStyle&) const;
1.148 + TInt GetStyleByIndexL(TInt aIndex, RTmStyle&) const;
1.149 +
1.150 + // from MPictureSupport
1.151 + void InsertPictureL(TInt aPos, const TPictureHeader&);
1.152 + void DropPictureL(TInt aPos);
1.153 + void Picture(TInt aPos, TPictureHeader&) const;
1.154 +
1.155 + // from MClipboardSupport
1.156 + void CopyToStoreL(CStreamStore& aStore, CStreamDictionary& aDictionary,
1.157 + TInt aPos, TInt aLength) const;
1.158 + void PasteFromStoreL(const CStreamStore& aStore,
1.159 + const CStreamDictionary& aDictionary, TInt aPos);
1.160 +
1.161 + CEditorWithUndo();
1.162 + void ConstructL(MUnifiedEditor& aEditorBasedOn,
1.163 + UndoSystem::CCommandManager* aSharedUndoSystem);
1.164 +
1.165 + CEditorCommandFactory* iFactory;
1.166 + MUnifiedEditor* iBaseEditor;
1.167 + UndoSystem::CCommandManager* iCommandManager;
1.168 + };
1.169 +
1.170 +#endif // EDITORUNDO_H_