ITrackChangeUtils Class Reference

#include <ITrackChangeUtils.h>

Inheritance diagram for ITrackChangeUtils:

Public Types
enum	{ kDefaultIID = IID_ITRACKCHANGEUTILS }

Public Member Functions
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
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

ITrackChangeUtils is an aggregrate of many different utility functions centered around track changes feature.

Member Function Documentation

virtual bool16 ITrackChangeUtils::ActiveStoryHasChanges ( )

pure virtual

Checks to see if the active story has any changes. Changes in hidden conditional text are ignored.

Returns

kTrue if story has changes

virtual bool16 ITrackChangeUtils::ActiveStoryHasChangesHidden ( )

pure virtual

Checks to see if the active story has any changes that are hidden according to track change app settings. Changes in hidden conditional text are ignored.

Returns

kTrue if story has changes that are hidden

See Also

ITrackChangeAppSettings

virtual TextIndex ITrackChangeUtils::DeletedTextToPrimaryIndex ( ITextModel *  textModel, TextIndex  withinDeletedTextIndex, TextIndex *  threadStart = nil, int32 *  threadSpan = nil  )

pure virtual

Converts an index within deleted text to primary index (aka anchor position)

Parameters

IN	textModel specifies the text model containing the table
IN	withinDeletedTextIndex text index to interrogate (will verify it is in deleted text)
OUT	threadStart of the deleted text story thread
OUT	threadSpan of the deleted text story thread

Returns

primary story thread index (aka anchor position) of the deleted text

virtual UIDRef ITrackChangeUtils::GetActiveStoryRef ( )

pure virtual

Returns active story UIDRef, calls GalleyUtils::GetCurrentTextSelection

Returns

UIDRef of the active story

virtual UIDRef ITrackChangeUtils::GetDeletedText ( ITextModel *  textModel, TextIndex  anchorPosition, WideString &  newString  )

pure virtual

Returns deleted text in the form of a widestring

Parameters

textModel
anchorPosition
newString

Returns

UIDRef of the deleted text story thread

virtual UIDRef ITrackChangeUtils::GetDeletedText ( ITextModel *  textModel, TextIndex  anchorPosition, PMString &  newString  )

pure virtual

Returns deleted text in the form of a widestring

Parameters

textModel
anchorPosition
newString

Returns

UIDRef of the deleted text story thread

virtual RealAGMColor ITrackChangeUtils::GetTrackedChangeBGColor ( IDataBase *  db, RedlineIterator *  iterator  )

pure virtual

Returns the background color for the change.

Parameters

db	database of the story
iterator	redline iterator at the change to interrogate

Returns

background color

virtual int32 ITrackChangeUtils::GetTrackedChangeMarking ( IDataBase *  db, RedlineIterator *  iterator  )

pure virtual

Returns the marking for the change.

Parameters

db	database of the story
iterator	redline iterator at the change to interrogate

Returns

marking

virtual RealAGMColor ITrackChangeUtils::GetTrackedChangeTextColor ( IDataBase *  db, RedlineIterator *  iterator  )

pure virtual

Returns the text color for the change.

Parameters

db	database of the story
iterator	redline iterator at the change to interrogate

Returns

text color

virtual bool16 ITrackChangeUtils::MarkAnyChanges ( )

pure virtual

Checks application preference for show/hide track changes.

Returns

kTrue if showing changes

virtual bool16 ITrackChangeUtils::MarkDeleteChanges ( )

pure virtual

Checks application preferences for show/hide track changes and show/hide deleted text.

Returns

kTrue if showing changes and deleted text

virtual bool16 ITrackChangeUtils::MarkInsertChanges ( )

pure virtual

Checks application preferences for show/hide track changes and show/hide added text.

Returns

kTrue if showing changes and added text

virtual bool16 ITrackChangeUtils::MarkMoveChanges ( )

pure virtual

Checks application preferences for show/hide track changes and show/hide moved text.

Returns

kTrue if showing changes and moved text

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

pure virtual

Checks for a deleted text owned item at the specified primary index (aka anchor position).

Parameters

IN	textModel specifies the text model
IN	withinPrimaryIndex text index to interrogate
OUT	threadStart of the deleted text story thread (if found at primary index)
OUT	threadSpan of the deleted text story thread (if found at primary index)

Returns

whether or not deletion found at primary index (aka anchor position)

virtual bool16 ITrackChangeUtils::RangeHasChanges ( UIDRef  storyRef, TextIndex  startIndex, TextIndex  endIndex, bool16  convertedRange  )

pure virtual

Checks to see if the specified text range has any changes.

Parameters

storyRef	UIDRef of the story to evaluate
startIndex	start index of the range
endIndex	end index of the range
convertedRange	kTrue if the range is in deleted text

Returns

kTrue if text range has changes

virtual bool16 ITrackChangeUtils::ShowChangeBars ( )

pure virtual

Checks application preferences for show/hide track changes and show/hide change bars.

Returns

kTrue if showing changes and change bars

virtual bool16 ITrackChangeUtils::StoryHasChanges ( UIDRef  storyRef )

pure virtual

Checks to see if the specified story has any changes. Changes in hidden conditional text are ignored.

Parameters

storyRef

UIDRef of the story to evaluate

Returns

kTrue if story has changes

virtual bool16 ITrackChangeUtils::StoryHasChangesHidden ( UIDRef  storyRef )

pure virtual

Checks to see if the specified story has any changes that are hidden according to track change app settings. Changes in hidden conditional text are ignored.

Parameters

storyRef

UIDRef of the story to evaluate

Returns

kTrue if story has changes that are hidden

See Also

ITrackChangeAppSettings