SLCTileManager Class Reference

#include <SLCTileManager.h>

Public Member Functions
	SLCTileManager (void)
virtual	~SLCTileManager (void)
virtual SLComposerStatusCode	Initialise (const IParagraphComposer::Tiler *tiler, ParcelKey parcelKey, Text::FirstLineOffsetMetric flo, const PMReal &lineIndentLeft, const PMReal &lineIndentRight)
virtual SLComposerStatusCode	MakeTileMeasures (const PMReal &yPosition, const SLCLineMetrics &lineMetrics, Text::GridAlignmentMetric gridAlignment, const PMReal &gridAlignmentMetricAdj, const TextIndex &nCurrentPosition)
virtual void	Finish (void)
bool16	IsStoryOverset (void) const
ParcelKey	GetParcelKey (void) const
const PMReal &	GetHeight (void) const
const PMReal &	GetTOPHeight (void) const
Text::FirstLineOffsetMetric	GetTOPHeightMetric (void)
bool16	GetAtTOP (void) const
bool16	GetParcelPositionDependent (void) const
const PMReal &	GetTileTop (void) const
const PMReal &	GetTileBottom (void) const
SLCTileMeasures &	GetTileMeasures (void)
virtual void	Dump (void)

Detailed Description

Manages the tiler (IParagraphComposer::Tiler) and creates tile measures (SLCTileMeasures) that represent the areas on a line into which text can flow. Normally there will only be one tile on a line. However text wrap may cause intrusions which breaks up the places in the line text can go. The tiler takes care of this as well as accounting for the effect of irregularly shaped text containers.

See Also

IParagraphComposer

SLCTileMeasure

Constructor & Destructor Documentation

SLCTileManager::SLCTileManager ( void  )

inline

Constructor. Nothing much done here.

virtual SLCTileManager::~SLCTileManager ( void  )

inlinevirtual

Destructor. Nothing done here.

Member Function Documentation

void SLCTileManager::Dump ( void  )

virtual

Dump info to Trace.

void SLCTileManager::Finish ( void  )

virtual

Tidies up after composition of the line is complete.

Precondition

Initialise has been called.

Postcondition

references held by the object are released.

bool16 SLCTileManager::GetAtTOP ( void  ) const

inline

kTrue if at top of parcel, kFalse otherwise.

const PMReal& SLCTileManager::GetHeight ( void  ) const

inline

Returns

height of the tiles.

ParcelKey SLCTileManager::GetParcelKey ( void  ) const

inline

Returns

IParcelList key of parcel that contains the tiles.

bool16 SLCTileManager::GetParcelPositionDependent ( void  ) const

inline

kTrue if parcel position dependent, kFalse otherwise.

const PMReal& SLCTileManager::GetTileBottom ( void  ) const

inline

Bottom of the tiles derived from tiles returned by the tiler.

SLCTileMeasures& SLCTileManager::GetTileMeasures ( void  )

inline

Essential tile measures derived from tiles returned by the tiler adjusted to account for left and right line indents.

Returns

tile measures to be used to flow text into the line.

const PMReal& SLCTileManager::GetTileTop ( void  ) const

inline

Top of the tiles derived from tiles returned by tiler.

const PMReal& SLCTileManager::GetTOPHeight ( void  ) const

inline

Returns

height of tiles when they are at the top of the parcel.

Text::FirstLineOffsetMetric SLCTileManager::GetTOPHeightMetric ( void  )

inline

Returns

metric used to control the offset between top of parcel and the text baseline when the tiles are at the top of the parcel.

SLComposerStatusCode SLCTileManager::Initialise ( const IParagraphComposer::Tiler *  tiler, ParcelKey  parcelKey, Text::FirstLineOffsetMetric  flo, const PMReal &  lineIndentLeft, const PMReal &  lineIndentRight  )

virtual

Prepares the object to use the given tiler.

Parameters

tiler	to be used to obtain tiles, the reference count is bumped.
parcelKey	into IParcelList of parcel into which text is to flow.
lineIndentLeft	is used to set the left edge of the tile measures if it intrudes into a tiler tile.
lineIndentRight	is used to set the right edge of the tile measures if it intrudes into a tiler tile.

Postcondition

MakeTileMeasures can be called.

Finish must be called.

bool16 SLCTileManager::IsStoryOverset ( void  ) const

inline

Returns

kTrue if the story is overset, kFalse otherwise.

SLComposerStatusCode SLCTileManager::MakeTileMeasures ( const PMReal &  yPosition, const SLCLineMetrics &  lineMetrics, Text::GridAlignmentMetric  gridAlignment, const PMReal &  gridAlignmentMetricAdj, const TextIndex &  nCurrentPosition  )

virtual

Get tiles from the tiler at the given yPosition and with the given parameters.

Precondition

Initialise has been called.

Parameters

yPosition
lineMetrics
gridAlignment
gridAlignmentMetricAdj
nCurrentPosition

Postcondition

GetTileMeasures can be called.

other accessors for tiler returned and derived properties can be called.