TextStoryThreadHelper Class Reference

#include <TextStoryThreadHelper.h>

Public Member Functions
	TextStoryThreadHelper (const ITextModel *textModel)
bool16	IsComposable (TextIndex at)
TextIndex	GetComposedEndTextIndex (const RangeData &range, UIDRef *pFrameRefToWaitOn)
bool16	IsInOverset (TextIndex at)
bool16	IsInUIViewableOverset (TextIndex at)

Detailed Description

Helper class for determining composable state of a given text index or text range, regardless of whether or not it is in the primary story thread.

See Also

ITextUtils

ITextModel

TextIndex

RangeData

Member Function Documentation

TextIndex TextStoryThreadHelper::GetComposedEndTextIndex	(	const RangeData &	range,
		UIDRef *	pFrameRefToWaitOn
	)

GetComposedEndTextIndex: Returns the first TextIndex after the last composed TextIndex in that specified Range that is fully composed.

Note Text which is in overset is considered in this case as being fully composed. If the returned value is less than range.End() and pFrameUIDToWaitOn is non-nil, then pFrameUIDToWaitOn will be set to the next TextFrame that needs composition in the primary StoryThread.

This method operates on cached information which is NOT invalidated due to external composition.

Parameters

IN	range: specified range of text
OUT	pFrameRefToWaitOn: set to the next frame that needs composition in the primary story thread

Returns

TextIndex - Returns the first TextIndex after the last composed TextIndex in that specified Range that is fully composed.

bool16 TextStoryThreadHelper::IsComposable ( TextIndex  at )

inline

IsComposable: Returns kTrue if the TextIndex is in a StoryThread that is currently composable.

Parameters

at,:	a TextIndex

Returns

bool16 - Returns kTrue if the TextIndex is in a StoryThread that is currently composable.

bool16 TextStoryThreadHelper::IsInOverset ( TextIndex  at )

inline

IsInOverset: Returns kTrue if the TextIndex is in a WaxLine that is overset in a Parcel that is overset

Parameters

at,:	a TextIndex

Returns

bool16 - Returns kTrue if the TextIndex is in a WaxLine that is overset in a Parcel that is overset.

bool16 TextStoryThreadHelper::IsInUIViewableOverset ( TextIndex  at )

inline

IsInUIViewableOverset: Returns kTrue if the TextIndex is in a WaxLine that is overset in an artificial overset container created so that the user can see it or for text statistics purposes.

Parameters

at,:	a TextIndex

Returns

bool16 - Returns kTrue if the TextIndex is in a WaxLine that is in an overset container.