InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextTiler::Tiler Class Referenceabstract

Public Member Functions

virtual PMRect GetNetContentAreaBounds () const =0
 
virtual bool16 GetIsNetContentAreaASingleRectangle () const =0
 
virtual bool16 GetTilesAt (PMReal yPosition, PMReal minWidth, PMReal height, Text::GridAlignmentMetric alignmentMetric, PMReal alignmentMetricOffset, PMReal heightLeadingDiff, PMRectCollection &tiles, bool16 *pParcelPositionDependent, PMReal *pLeftMargin, PMReal *pRightMargin) const =0
 
virtual bool16 GetMarginsAt (PMReal yPosition, PMReal &leftMargin, PMReal &rightMargin) const =0
 
virtual void ClearLocalWraps ()=0
 
virtual void AddLocalWrap (const TextWrapRef &wrapRef)=0
 

Member Function Documentation

virtual void ITextTiler::Tiler::AddLocalWrap (const TextWrapRefwrapRef)
pure virtual

Adds a local Wrap to the Tiler. The caller may call this multiple times with new wraps since the last call to ClearLocalWraps().

Parameters
wrapRefReference to TextWrapRef.
virtual void ITextTiler::Tiler::ClearLocalWraps ()
pure virtual

Forces the Tiler to forget about all local wraps.

virtual bool16 ITextTiler::Tiler::GetIsNetContentAreaASingleRectangle () const
pure virtual

Returns kTrue if the current tileable area as represented by the current state of the Tiler is a single rectangle.

Returns
kTrue is tileable area is a single rectangle
virtual bool16 ITextTiler::Tiler::GetMarginsAt (PMReal yPosition,
PMRealleftMargin,
PMRealrightMargin 
) const
pure virtual
Returns
kTrue if a tile found, kFalse otherwise.
virtual PMRect ITextTiler::Tiler::GetNetContentAreaBounds () const
pure virtual

Returns the bounds of the current tileable area as represented by the current state of the Tiler. If there are no StandOffs in effect the value returned is the same as GetContentBounds().

Returns
the bounds of the tileable area
virtual bool16 ITextTiler::Tiler::GetTilesAt (PMReal yPosition,
PMReal minWidth,
PMReal height,
Text::GridAlignmentMetric alignmentMetric,
PMReal alignmentMetricOffset,
PMReal heightLeadingDiff,
PMRectCollectiontiles,
bool16 * pParcelPositionDependent,
PMRealpLeftMargin,
PMRealpRightMargin 
) const
pure virtual

Find a tile of the specfied height with the specfied minimum width starting at the specfied yPosition.

Returns
kTrue if a tile found, kFalse otherwise.