ITextTiler.h

//========================================================================================
// 
// $File$
// 
// Owner: bparadie, ekenning, zwilliam
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ITextTiler__
#define __ITextTiler__

#include "IPMUnknown.h"

#include "CTextEnum.h"
#include "PMRect.h"
#include "ParcelKey.h"
#include "TextID.h"
#include "TextWrapRef.h"


class ITextTiler : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITEXTTILER };

 virtual bool16 GetIsAnArea() const = 0;

 virtual bool16 GetAppearsMultiplePlaces() const = 0;

 virtual PMMatrix GetToContentMatrix() const = 0;

 virtual PMRect GetContentBounds() const = 0;

 class Tiler
 {
 protected:
 Tiler();

 private:
 Tiler(const Tiler&);
 Tiler& operator=(const Tiler&);

 public:
 virtual ~Tiler();

 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;

#ifdef NOT_YET

 virtual bool16 GetSliceAt(PMReal yPosition,
 PMReal height,
 PMRectCollection& tiles,
 PMReal& leftMargin,
 PMReal& rightMargin) const = 0;

#endif

 virtual void ClearLocalWraps() = 0;

 virtual void AddLocalWrap(const TextWrapRef& wrapRef) = 0;

 };

 virtual Tiler* NewTiler(bool16 includeExternalInlineWraps = kTrue,
 bool16 includeInternalInlineWrap = kFalse) const = 0;

#ifdef ID_DEPRECATED // ParagraphComposer, Galley, GalleyInfo

 virtual PMRect GetNetContentAreaBounds() const;

 virtual bool16 GetIsNetContentAreaASingleRectangle() const;

 virtual bool16 GetLocalTiles(PMReal yPosition,
 PMReal minWidth,
 PMReal height,
 Text::GridAlignmentMetric alignmentMetric,
 PMReal alignmentMetricOffset,
 PMReal heightLeadingDiff,
 TextIndex nCurrentPosition,
 PMRectCollection& tiles,
 bool16 *pParcelPositionDependent,
 PMReal *pLeftMargin,
 PMReal *pRightMargin) const;
#endif

};

#endif