Helper class for those implemenations that only have a single range. More...

Inheritance diagram for ITextObjectParent::SingleRangeIter:

Public Member Functions
	SingleRangeIter (const UIDRef &textModelRef, const ITextStoryThread *thread, TextIndex threadStart, int32 threadSpan, TextIndex rangeStart, int32 rangeSpan)

	SingleRangeIter (const UIDRef &textModelRef, const ITextStoryThread *thread, TextIndex threadStart, int32 threadSpan, TextIndex adjThreadStart, int32 adjThreadSpan, TextIndex rangeStart, int32 rangeSpan)

bool16	GetFirstRange (UIDRef &textModelRef, InterfacePtr< const ITextStoryThread > &thread, TextIndex &threadStart, int32 &threadSpan, TextIndex &adjThreadStart, int32 &adjThreadSpan, TextIndex &rangeStart, int32 &rangeSpan)

bool16	GetNextRange (InterfacePtr< const ITextStoryThread > &thread, TextIndex &threadStart, int32 &threadSpan, TextIndex &adjThreadStart, int32 &adjThreadSpan, TextIndex &rangeStart, int32 &rangeSpan)

Additional Inherited Members
Protected Member Functions inherited from ITextObjectParent::RangeIter
	RangeIter (const RangeIter &other)

Detailed Description

Helper class for those implemenations that only have a single range.

Member Function Documentation

bool16 ITextObjectParent::SingleRangeIter::GetFirstRange	(	UIDRef &	textModelRef,
		InterfacePtr< const ITextStoryThread > &	thread,
		TextIndex &	threadStart,
		int32 &	threadSpan,
		TextIndex &	adjThreadStart,
		int32 &	adjThreadSpan,
		TextIndex &	rangeStart,
		int32 &	rangeSpan
	)

inlinevirtual

Returns the first range (if any) managed by the parent. The range may include the final CR of the TextStoryThread not

Parameters

textModelUID
threadStart	The TextIndex of the start of the Thread
threadSpan	The number of characters in the Thread
adjThreadStart	The adjusted TextIndex of the start of the Thread. For more applications this will be the same as threadStart. However, some implementations such as the backing store wish to prevent access to some number of chracters at the start and end of the story thread without disguising the true thread boundries. All extending adjustments that take for things like Words, Lines, TextStyleRanges, etc will be clipped to the adjThreadStart and adjThreadSpan.
adjThreadSpan	The adjusted number of characters in the Thread
rangeStart	The TextIndex of the start of the range within which text objects will be found
rangeSpan	The number of characters in the range within which text objects will be found - may be zero.

bool16 ITextObjectParent::SingleRangeIter::GetNextRange	(	InterfacePtr< const ITextStoryThread > &	thread,
		TextIndex &	threadStart,
		int32 &	threadSpan,
		TextIndex &	adjThreadStart,
		int32 &	adjThreadSpan,
		TextIndex &	rangeStart,
		int32 &	rangeSpan
	)

inlinevirtual

Returns a subsequent range (if any) managed by the parent. The range may include the final CR of the TextStoryThread not

Parameters

threadStart	The TextIndex of the start of the Thread
threadSpan	The number of characters in the Thread
adjThreadStart	The adjusted TextIndex of the start of the Thread. For more applications this will be the same as threadStart. However, some implementations such as the backing store wish to prevent access to some number of chracters at the start and end of the story thread without disguising the true thread boundries. All extending adjustments that take for things like Words, Lines, TextStyleRanges, etc will be clipped to the adjThreadStart and adjThreadSpan.
adjThreadSpan	The adjusted number of characters in the Thread
rangeStart	The TextIndex of the start of the range within which text objects will be found
rangeSpan	The number of characters in the range within which text objects will be found - may be zero.