sl@0: /*
sl@0: * Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description: 
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef EDITORPLAINTEXTUNDO_H_
sl@0: #define EDITORPLAINTEXTUNDO_H_
sl@0: 
sl@0: #include "unified_editor.h"
sl@0: 
sl@0: namespace UndoSystem
sl@0: {
sl@0: class CCommandManager;
sl@0: class MNotUndoableGatekeeper;
sl@0: }
sl@0: 
sl@0: class CEditorPlainTextCommandFactory;
sl@0: 
sl@0: /**
sl@0: MUnifiedEditor decorator that adds undo functionality to plain text editors.
sl@0: It passes commands transparently to the editor it is constructed upon, while
sl@0: storing the operations so that they can be undone and redone. Calling a
sl@0: non-const method of MUnifiedEditor wipes all 'Redo' operations.
sl@0: The undo and redo operations are only guaranteed to be accurate if the
sl@0: underlying editor satisfies certain conditions.
sl@0: 
sl@0: @since App-frameworks6.1
sl@0: @internalComponent
sl@0: */
sl@0: class CEditorPlainTextWithUndo : public CBase, public MUnifiedEditor,
sl@0: 	private MUnifiedEditor::MClipboardSupport
sl@0: 	{
sl@0: public:
sl@0: 	~CEditorPlainTextWithUndo();
sl@0: 
sl@0: 	/**
sl@0: 	 * Creates a CEditorPlainTextWithUndo, using the aSharedUndoSystem.
sl@0: 	 * This allows many objects to stay in synchronization when each is
sl@0: 	 * accessed seperately.
sl@0: 	 * The aEditor is not owned.
sl@0: 	 * Undo functionality is accessed only via the aSharedUndoSystem
sl@0: 	 * object.
sl@0: 	 */
sl@0: 	IMPORT_C static CEditorPlainTextWithUndo* NewL(MUnifiedEditor& aEditor,
sl@0: 		UndoSystem::CCommandManager* aSharedUndoSystem);
sl@0: 
sl@0: 	// From MUnifiedEditor
sl@0: 	void InsertTextL(TInt aPos, const TDesC& aText, const TDesC* aStyle,
sl@0: 		const TTmCharFormatLayer*, const RTmParFormatLayer*);
sl@0: 	void DeleteTextL(TInt aPos,TInt aLength);
sl@0: 	MTmOptionalInterface* Interface(TUint aId);
sl@0: 
sl@0: 	// The following methods are forwarded to the base editor
sl@0: 	TInt DocumentLength() const;
sl@0: 	void GetText(TInt aPos, TPtrC& aText) const;
sl@0: 	void GetBaseFormatL(TTmCharFormat&, RTmParFormat&) const;
sl@0: 	void GetCharFormat(TInt aPos, TFormatLevel aLevel,
sl@0: 		TTmCharFormatLayer& aFormat,TInt& aRunLength) const;
sl@0: 	void GetParFormatL(TInt aPos, TFormatLevel aLevel,
sl@0: 		RTmParFormatLayer& aFormat, TInt& aRunLength) const;
sl@0: 	void SetBaseFormatL(const TTmCharFormat&, const RTmParFormat&);
sl@0: 	void SetCharFormatL(TInt aPos, TInt aLength, const TTmCharFormatLayer&);
sl@0: 	void SetParFormatL(TInt aPos, TInt aLength, const RTmParFormatLayer&);
sl@0: 	void DeleteCharFormatL(TInt aPos, TInt aLength);
sl@0: 	void DeleteParFormatL(TInt aPos, TInt aLength);
sl@0: 
sl@0: private:
sl@0: 	CEditorPlainTextWithUndo();
sl@0: 	void ConstructL(MUnifiedEditor& aEditorBasedOn,
sl@0: 		UndoSystem::CCommandManager& aSharedUndoSystem);
sl@0: 
sl@0: 	// from MUnifiedEditor::MClipboardSupport
sl@0: 	void CopyToStoreL(CStreamStore&, CStreamDictionary&, TInt, TInt) const;
sl@0: 	void PasteFromStoreL(const CStreamStore&, const CStreamDictionary&, TInt);
sl@0: 
sl@0: 	CEditorPlainTextCommandFactory*	iFactory;
sl@0: 	MUnifiedEditor*						iBaseEditor;
sl@0: 	UndoSystem::CCommandManager*	iCommandManager;
sl@0: 	};
sl@0: 
sl@0: #endif	// EDITORPLAINTEXTUNDO_H_
sl@0: