IParagraphComposer::Tiler Class Reference

Inheritance diagram for IParagraphComposer::Tiler:

Public Member Functions
virtual IParcelList *	GetParcelList () const =0
virtual ParcelKey	GetFirstParcelKey () const =0
virtual ParcelKey	GetNextParcelKey (ParcelKey key) const =0
virtual bool16	GetHasAnyValidStartBreakLocation () const =0
virtual bool16	GetParcelIsValidStartBreakLocation (ParcelKey key, Text::StartBreakLocation mode) const =0
virtual ParcelKey	GetNextParcelKeyByBreak (ParcelKey key, Text::StartBreakLocation mode) const =0
virtual ParcelKey	GetPreviousParcelKey (ParcelKey key) const =0
virtual bool16	MoveToTopNextParcelByBreak (Text::StartBreakLocation mode, ParcelKey *pKey, PMReal *pYPosition) const =0
virtual PMRect	GetParcelContentBounds (ParcelKey key) const =0
virtual bool16	GetParcelContentIsAnArea (ParcelKey key) const =0
virtual bool16	GetHasAnyIntrusionsAt (ParcelKey key) const =0
virtual PMReal	GetParcelEffectiveVerticalSpacing (ParcelKey key) const =0
virtual UID	GetParcelFrameUID (ParcelKey key) const =0
virtual PMMatrix	GetParcelContentToFrameMatrix (ParcelKey key) const =0
virtual bool16	GetParcelAppearsMultiplePlaces (ParcelKey key) const =0
virtual bool16	GetTiles (PMReal minWidth, PMReal height, PMReal TOPHeight, Text::GridAlignmentMetric gridAlignment, PMReal gridAlignmentAdj, Text::LeadingModel leadingModel, PMReal leading, PMReal leadingModelOffset, PMReal minHeightLeadingDiff, TextIndex nCurrentPosition, bool16 affectedByVerticalJustification, ParcelKey *pParcelKey, PMReal *pYOffset, Text::FirstLineOffsetMetric *pTOPHeightMetric, PMRectCollection &tiles, bool16 *pAtTOP, bool16 *pParcelPositionDependent, PMReal *pLeftMargin, PMReal *pRightMargin) const =0
virtual PMReal	GetParcelGrowableContentBottom (ParcelKey key) const =0
	In the context of the composing paragraph.
virtual PMReal	GetParcelTileableContentTop (ParcelKey key) const =0
virtual PMReal	GetParcelTileableContentBottom (ParcelKey key) const =0
virtual bool16	GetParcelShouldInvalNewWax (ParcelKey key) const =0

Member Function Documentation

virtual ParcelKey IParagraphComposer::Tiler::GetFirstParcelKey ( ) const

pure virtual

In the context of the composing paragraph, returns the ParcelKey of the first logical parcel. Note that the returned value may differ from what the IParcelList would have returned.

virtual bool16 IParagraphComposer::Tiler::GetHasAnyIntrusionsAt ( ParcelKey  key ) const

pure virtual

In the context of the composing paragraph, returns kTrue if the specified Parcel has any active TextWraps.

virtual ParcelKey IParagraphComposer::Tiler::GetNextParcelKey ( ParcelKey  key ) const

pure virtual

In the context of the composing paragraph, returns the ParcelKey of the logical parcel after the specified Parcel. Note that the returned value may differ from what the IParcelList would have returned.

virtual ParcelKey IParagraphComposer::Tiler::GetNextParcelKeyByBreak ( ParcelKey  key, Text::StartBreakLocation  mode  ) const

pure virtual

In the context of the composing paragraph, returns the ParcelKey of the first logical parcel with the specified break attribute with the search starting at the specified parcel. If the specified parcel matches the specified break location it will be returned. If no parcel can be found searching forward which matches the specified break location an invalid ParcelKey will be returned. Note that the returned value may differ from what the IParcelList would have returned.

virtual bool16 IParagraphComposer::Tiler::GetParcelShouldInvalNewWax ( ParcelKey  key ) const

pure virtual

Sometimes the ParcelContainer knows that it is going to be doing iterative composition and for performance reasons it does not want the new WaxLines to spend time build WaxRuns which may just be tossed away. Note that this is just an advisory, WaxLines which contain OwnedItems typically need to be notified in all cases and the OwnedItem may decide to trigger the WaxRuns to be created anyway.

Parameters

key	ParcelKey of the Parcel where the new Wax is created.

Returns

kTrue if new WaxLines created by the ParagraphComposer should be Inval()ed, kFalse otherwise.

virtual ParcelKey IParagraphComposer::Tiler::GetPreviousParcelKey ( ParcelKey  key ) const

pure virtual

In the context of the composing paragraph, returns the ParcelKey of the logical parcel before the specified Parcel. Note that the returned value may differ from what the IParcelList would have returned.

virtual bool16 IParagraphComposer::Tiler::GetTiles ( PMReal  minWidth, PMReal  height, PMReal  TOPHeight, Text::GridAlignmentMetric  gridAlignment, PMReal  gridAlignmentAdj, Text::LeadingModel  leadingModel, PMReal  leading, PMReal  leadingModelOffset, PMReal  minHeightLeadingDiff, TextIndex  nCurrentPosition, bool16  affectedByVerticalJustification, ParcelKey *  pParcelKey, PMReal *  pYOffset, Text::FirstLineOffsetMetric *  pTOPHeightMetric, PMRectCollection &  tiles, bool16 *  pAtTOP, bool16 *  pParcelPositionDependent, PMReal *  pLeftMargin, PMReal *  pRightMargin  ) const

pure virtual

In the context of the composing paragraph returns a tile matching the specified criteria. Note that because of straddle heads this call may result in the removal and/or addition of Parcels after the specified Parcel.

Parameters

affectedByVerticalJustification

Set to kTrue the WaxLine is part of paragraph that would be normally spread by vertical justification. kFalse if affected by a dropcap, paragraph gyudori, etc.