redlineiterator.h

//========================================================================================
// 
// $File$
// 
// Owner: Eric Menninga
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef __RedlineIterator__
#define __RedlineIterator__

#include "IPMFont.h"

class VOSRedlineChange;
class VOS_RedlineObject;
class RangeData;

class RedlineIterator
{
 public:
 virtual ~RedlineIterator();
 
 virtual void MoveToBeginning();
 virtual bool16 MoveToPosition(TextIndex t, int32 c = -1) = 0;
 virtual TextIndex GetCurrentPosition(int32 *changePos = nil, int32 *numChanges = nil) = 0;
 virtual int32 GetCurrentLength() = 0;

 virtual bool16 ProcessAccept(const RangeData* range = nil, bool16 doingAcceptAll = kFalse, bool16 restoreSelection = kFalse);
 virtual bool16 ProcessReject(const RangeData* range = nil, bool16 doingRejectAll = kFalse, bool16 restoreSelection = kFalse);

 virtual bool16 ProcessAcceptIncrement(const RangeData* range = nil, bool16 doingAcceptAll = kFalse, bool16 restoreSelection = kFalse);
 virtual bool16 ProcessRejectIncrement(const RangeData* range = nil, bool16 doingRejectAll = kFalse, bool16 restoreSelection = kFalse);
 virtual bool16 ProcessRejectDecrement(const RangeData* range = nil, bool16 doingRejectAll = kFalse, bool16 restoreSelection = kFalse);
 virtual bool16 Increment(bool16 skipUnchanged) = 0;
 virtual bool16 Decrement(bool16 skipUnchanged) = 0;
 
 virtual const VOSRedlineChange* GetCurrentChangeRecord(TextIndex *pPosition = nil, int32 *pLength = nil);
 virtual const VOS_RedlineObject* QueryCurrentObject();

 virtual void DescribeUser(PMString& user);
 virtual void DescribeType(PMString& type);
 virtual void DescribeTimeStamp(PMString& time);
 virtual UIDRef DescribeChangeContent(PMString& detail, int32 maxLength = 32);
};

#endif // __RedlineIterator__