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 EDITORUNDO_H_
sl@0: #define EDITORUNDO_H_
sl@0: 
sl@0: #include "unified_editor.h"
sl@0: 
sl@0: namespace UndoSystem
sl@0: /**
sl@0: @internalTechnology
sl@0: */
sl@0: {
sl@0: class CCommandManager;
sl@0: class MNotUndoableGatekeeper;
sl@0: }
sl@0: 
sl@0: class CEditorCommandFactory;
sl@0: 
sl@0: /**
sl@0: MUnifiedEditor decorator that adds undo functionality.
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: @internalAll
sl@0: */
sl@0: class CEditorWithUndo : public CBase,
sl@0: 	public MUnifiedEditor,
sl@0: 	private MUnifiedEditor::MStyleSupport,
sl@0: 	private MUnifiedEditor::MPictureSupport,
sl@0: 	private MUnifiedEditor::MClipboardSupport
sl@0: 
sl@0: 	{
sl@0: public:
sl@0: 	~CEditorWithUndo();
sl@0: 
sl@0: 	/**
sl@0: 	 * Creates a CEditorWithUndo. It does not own the aEditor.
sl@0: 	 */
sl@0: 	IMPORT_C static CEditorWithUndo* NewL(MUnifiedEditor& aEditor);
sl@0: 	/**
sl@0: 	 * Creates a CEditorWithUndo, using the aSharedUndoSystem. This allows
sl@0: 	 * many objects to stay in synchronization when each is accessed
sl@0: 	 * seperately.
sl@0: 	 * The aEditor is not owned.
sl@0: 	 */
sl@0: 	IMPORT_C static CEditorWithUndo* NewL(MUnifiedEditor& aEditor,
sl@0: 		UndoSystem::CCommandManager* aSharedUndoSystem);
sl@0: 	/**
sl@0: 	 * Undoes one operation or batch of operations. If one operation in the
sl@0: 	 * middle of a batch leaves, this function will leave, but the underlying
sl@0: 	 * editor will not necessarily be in the same state as it was in before
sl@0: 	 * the call. However, all operations will still be stored, and so the
sl@0: 	 * previous state is still recoverable with a call to RedoL() or a
sl@0: 	 * further call to UndoL will complete the operation (resource acquisition
sl@0: 	 * permitting).
sl@0: 	 */
sl@0: 	IMPORT_C void UndoL();
sl@0: 	/**
sl@0: 	 * Redoes one operation or batch of operations. If one operation in the
sl@0: 	 * middle of a batch leaves, this function will leave, but the underlying
sl@0: 	 * editor will not necessarily be in the same state as it was in before
sl@0: 	 * the call. However, all operations will still be stored, and so the
sl@0: 	 * previous state is still recoverable with a call to UndoL() or a
sl@0: 	 * further call to RedoL will complete the operation (resource acquisition
sl@0: 	 * permitting).
sl@0: 	 */
sl@0: 	IMPORT_C void RedoL();
sl@0: 	/**
sl@0: 	 * Returns ETrue iff UndoL() would have an effect
sl@0: 	 */
sl@0: 	IMPORT_C TBool CanUndo() const;
sl@0: 	/**
sl@0: 	 * Returns ETrue iff RedoL() would have an effect
sl@0: 	 */
sl@0: 	IMPORT_C TBool CanRedo() const;
sl@0: 	/**
sl@0: 	 * Wipes all undo and redo operations
sl@0: 	 */
sl@0: 	IMPORT_C void ResetUndo();
sl@0: 	/**
sl@0: 	 * Sets limits on the 'undo depth'. This is the numbet of times that
sl@0: 	 * successive calls to UndoL() have an effect. When a depth of
sl@0: 	 * aMaxItems is reached, the undo depth is reset to aMinItems.
sl@0: 	 */
sl@0: 	IMPORT_C void SetMaxItems(TInt aMaxItems);
sl@0: 	/**
sl@0: 	 * Sets a gatekeper for the undo system. This will be called whenever an
sl@0: 	 * operation is attempted that cannot be undone for any reason.
sl@0: 	 * The gatekeeper therefore has an oportunity to suppress execution and
sl@0: 	 * keep the current undo operations stored.
sl@0: 	 * NULL may be passed to restore default behaviour.
sl@0: 	 * Returns the old gatekeeper.
sl@0: 	 */
sl@0: 	IMPORT_C UndoSystem::MNotUndoableGatekeeper*
sl@0: 		SetGatekeeper(UndoSystem::MNotUndoableGatekeeper*);
sl@0: 
sl@0: 	// From MUnifiedEditor
sl@0: 	MTmOptionalInterface* Interface(TUint aId);
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: 	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: 	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: 
sl@0: private:
sl@0: 	// from MStyleSupport
sl@0: 	TInt CreateStyleL(const RTmStyle&);
sl@0: 	TInt ChangeStyleL(const RTmStyle&);
sl@0: 	TInt SetStyleL(TInt aPos, TInt aLength, const TDesC&);
sl@0: 	TInt RenameStyleL(const TDesC& aOldName, const TDesC& aNewName);
sl@0: 	TInt DeleteStyleL(const TDesC& aName);
sl@0: 	TInt StyleCount() const;
sl@0: 	void GetStyle(TInt aPos, TPtrC& aName, TInt& aRunLength) const;
sl@0: 	TInt GetStyleByNameL(const TDesC& aName, RTmStyle&) const;
sl@0: 	TInt GetStyleByIndexL(TInt aIndex, RTmStyle&) const;
sl@0: 
sl@0: 	// from MPictureSupport
sl@0: 	void InsertPictureL(TInt aPos, const TPictureHeader&);
sl@0: 	void DropPictureL(TInt aPos);
sl@0: 	void Picture(TInt aPos, TPictureHeader&) const;
sl@0: 
sl@0: 	// from MClipboardSupport
sl@0: 	void CopyToStoreL(CStreamStore& aStore, CStreamDictionary& aDictionary,
sl@0: 		TInt aPos, TInt aLength) const;
sl@0: 	void PasteFromStoreL(const CStreamStore& aStore,
sl@0: 		const CStreamDictionary& aDictionary, TInt aPos);
sl@0: 
sl@0: 	CEditorWithUndo();
sl@0: 	void ConstructL(MUnifiedEditor& aEditorBasedOn,
sl@0: 		UndoSystem::CCommandManager* aSharedUndoSystem);
sl@0: 
sl@0: 	CEditorCommandFactory*			iFactory;
sl@0: 	MUnifiedEditor*						iBaseEditor;
sl@0: 	UndoSystem::CCommandManager*	iCommandManager;
sl@0: 	};
sl@0: 
sl@0: #endif	// EDITORUNDO_H_