StatsScope Class Reference

Public Types
enum	WhichScope {   kStoryStats, kSelectionStats, kToBeginStats, kToEndStats,   kFitStats }

Public Member Functions
	StatsScope ()

Public Attributes
WhichScope	fWhichScope
TextIndex	fBeginIndex
TextIndex	fEndIndex
UIDRef	fStoryUIDRef
int32	fLastModelLength
uint32	fLastChangedCounter
PMReal	fAssignedDepth
int32	fAssignedDepthIndex
IGalleyInfoUtils::FitType	fFitType
bool16	fIncludingFootnotes

Member Enumeration Documentation

enum StatsScope::WhichScope

Possible types of text stats. kStoryStats entire story text statistics kSelectionStats stats for currents selection kToBeginStats from start of selection to story begin kToEndStats from start of selection to story end kFitStats does story fit frame

Constructor & Destructor Documentation

StatsScope::StatsScope ( )

inline

Constructor initialize all variables to defaults

Member Data Documentation

PMReal StatsScope::fAssignedDepth

fAssignedDepth for standalone text stats -1 for normal stats if there is a goal length put it in here.

int32 StatsScope::fAssignedDepthIndex

fAssignedDepthIndex used internally to returned by stats functions if fAssigneDepth is filled out to say where to draw overset line.

TextIndex StatsScope::fBeginIndex

fBeginIndex Specify start index to calculate stats on.

TextIndex StatsScope::fEndIndex

fBeginIndex Specify end index to calculate stats on.

IGalleyInfoUtils::FitType StatsScope::fFitType

fFitType returned to indicate what type of fit is there after the stats are calculated.

bool16 StatsScope::fIncludingFootnotes

fIncludingFootnotes set to kTrue to include footnotes in the text stats calculations.

uint32 StatsScope::fLastChangedCounter

fLastChangedCounter used internally to find out when to update stats.

int32 StatsScope::fLastModelLength

fLastModelLength used internally to find out when to update stats.

UIDRef StatsScope::fStoryUIDRef

fStoryUIDRef Reference of the story to calculate stats on.

WhichScope StatsScope::fWhichScope

fWhichScope Specify wich type of stats to calculate using WhichScope enum.