IInlineData.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IInlineData__
#define __IInlineData__

#include "IPMUnknown.h"
#include "TextID.h"
#include "ParcelKey.h"

class IHierarchy;
class IItemContext;
class IParcel;
class ITextFrameColumn;
class ITextModel;
class ITextParcelList;
class ITextStoryThread;
class IWaxLine;
class IWaxStrand;
class PMMatrix;
class PMPoint;
class PMRect;

class IInlineData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IINLINEDATA };

 virtual UID GetTextModelUID() const = 0;

 virtual ITextModel* QueryTextModel() const = 0;

 virtual IWaxStrand* QueryWaxStrand() const = 0;

 virtual const ITextStoryThread* QueryStoryThread() const = 0;

 virtual const ITextParcelList* QueryTextParcelList() const = 0;

 virtual ParcelKey GetParcelKey() const = 0;

 virtual const IParcel * QueryParcel() const = 0;

 virtual PMMatrix GetWaxToILGMatrix() const = 0;

 virtual TextIndex GetILGIndex() const = 0;

 virtual UIDRef GetTextFrameRef() const = 0;

 virtual ITextFrameColumn* QueryTextFrame() const = 0;

 virtual UID GetSpreadUID() const = 0;

 virtual void SetObjectDesignation(ClassID objectType) = 0;

 virtual ClassID GetObjectDesignation() const = 0;

 virtual PMRect GetGlyphBoundingBox() const = 0;
 virtual PMRect GetPaintedBoundingBox() const = 0;
 virtual PMRect GetPrintedBoundingBox(bool32 includeAdornments = kTrue) const = 0;

 virtual PMRect GetConstrainedTo() const = 0;

 virtual void RecomposeThru() const = 0;

 virtual void InlineChangeDamage() const = 0;
 
 virtual void InlineContentDamage() const = 0;

 // Returns the item context on the text frame containing the Inline,
 // or the one on the last text frame, if the frame is overset.
 virtual IItemContext* QueryItemContext() const = 0;

 virtual void UnRegister() = 0;

 virtual bool16 GetHasPageItemHyperlink() const = 0;

 virtual void ConvertPhase2(ITextModel* textModel, TextIndex at,
 int32 privatePhase2Code) = 0;

 virtual bool16 Register(const IWaxLine* waxLine,
 const IParcel* pParcel,
 const PMMatrix& waxToILGMatrix) = 0;

 virtual bool16 Rebuilt(const PMMatrix& waxToILGMatrix, bool16* damagedBack = nil) = 0;

 virtual bool16 GetRegistering() const = 0;

};

#endif