ITrackChangeUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Michele Goodwin
// 
// $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.
// 
//========================================================================================

#ifndef __ITRACKCHANGEUTILS__
#define __ITRACKCHANGEUTILS__

// ----- Interfaces -----
#include "IInterfaceColors.h"

// ----- Includes -----
#include "redlineiterator.h"

// ----- Utility files -----
#include "WideString.h"

// ----- ID.h files -----
#include "InCopySharedID.h"


class ITextModel;

class ITrackChangeUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITRACKCHANGEUTILS };

 virtual bool16 MarkAnyChanges() = 0;

 virtual bool16 MarkDeleteChanges() = 0;

 virtual bool16 MarkInsertChanges() = 0;

 virtual bool16 MarkMoveChanges() = 0;

 virtual bool16 ShowChangeBars() = 0;

 virtual RealAGMColor GetTrackedChangeTextColor(IDataBase *db, RedlineIterator *iterator) = 0;

 virtual RealAGMColor GetTrackedChangeBGColor(IDataBase *db, RedlineIterator *iterator) = 0;

 virtual int32 GetTrackedChangeMarking(IDataBase *db, RedlineIterator *iterator) = 0;

 virtual UIDRef GetDeletedText(ITextModel* textModel, TextIndex anchorPosition, WideString& newString) = 0;

 virtual UIDRef GetDeletedText(ITextModel* textModel, TextIndex anchorPosition, PMString& newString) = 0;

 virtual UIDRef GetActiveStoryRef() = 0;

 virtual bool16 ActiveStoryHasChanges() = 0;

 virtual bool16 ActiveStoryHasChangesHidden() = 0;

 virtual bool16 StoryHasChanges(UIDRef storyRef) = 0;

 virtual bool16 StoryHasChangesHidden(UIDRef storyRef) = 0;

 virtual bool16 RangeHasChanges(UIDRef storyRef, TextIndex startIndex, TextIndex endIndex, bool16 convertedRange) = 0;
 
 virtual TextIndex DeletedTextToPrimaryIndex(ITextModel* textModel, TextIndex withinDeletedTextIndex, TextIndex* threadStart = nil, int32* threadSpan = nil) = 0;

 virtual bool16 PrimaryIndexToDeletedText(ITextModel* textModel, TextIndex withinPrimaryIndex, TextIndex* threadStart = nil, int32* threadSpan = nil) = 0;

#ifdef DEBUG

 virtual bool16 ToggleTrackChangeDisplay() = 0;
#endif
};

#endif // __ITRACKCHANGEUTILS__