IInlineData Class Reference

#include <IInlineData.h>

Inheritance diagram for IInlineData:

Public Types
enum	{ kDefaultIID = IID_IINLINEDATA }

Public Member Functions
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
virtual IItemContext *	QueryItemContext () const =0
virtual void	UnRegister ()=0
virtual bool16	GetHasPageItemHyperlink () const =0
virtual void	ConvertPhase2 (ITextModel *textModel, TextIndex at, int32 privatePhase2Code)=0
	Adobe internal use only.
virtual bool16	Register (const IWaxLine *waxLine, const IParcel *pParcel, const PMMatrix &waxToILGMatrix)=0
	Adobe internal use only.
virtual bool16	Rebuilt (const PMMatrix &waxToILGMatrix, bool16 *damagedBack=nil)=0
	Adobe internal use only.
virtual bool16	GetRegistering () const =0
	Adobe internal use only.
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

The ILG is considered position dependent content for the Parcel and as such must be notified whenever it moves relative to the Pasteboard.

Member Function Documentation

virtual PMRect IInlineData::GetConstrainedTo ( ) const

pure virtual

Returns

The pasteboard rectangle that the Inline is constrained to.

virtual PMRect IInlineData::GetGlyphBoundingBox ( ) const

pure virtual

Equivalent to GetStrokeBoundingBox() on the child PageItem.

virtual bool16 IInlineData::GetHasPageItemHyperlink ( ) const

pure virtual

Returns kTrue if any descendent of the Inline has a page item hyperlink.

virtual TextIndex IInlineData::GetILGIndex ( ) const

pure virtual

Returns

the TextIndex of the ILG in the strands

virtual ClassID IInlineData::GetObjectDesignation ( ) const

pure virtual

Returns

The key used by the item strand

virtual PMRect IInlineData::GetPaintedBoundingBox ( ) const

pure virtual

Equivalent to GetPaintedBBox() on the child PageItem.

virtual ParcelKey IInlineData::GetParcelKey ( ) const

pure virtual

Returns

the registered ParcelKey of the ILG. This value is set when the ILG is Applied() and cleared when it is Unregister()ed. Thus registered Inlines return a valid ParcelKey and unregistered ones do not.

virtual PMRect IInlineData::GetPrintedBoundingBox ( bool32  includeAdornments = kTrue ) const

pure virtual

Equivalent to GetPrintedBBox() on the child PageItem.

Parameters

includeAdornments

[IN] Whether or not printing adornments are included in the resulting bounding box

virtual UID IInlineData::GetSpreadUID ( ) const

pure virtual

Returns

the root UID of the TextFrame associated with the Parcel.

virtual UIDRef IInlineData::GetTextFrameRef ( ) const

pure virtual

Returns

UIDRef for the TextFrameColumn that the Parcel containing the Inline is part of.

virtual UID IInlineData::GetTextModelUID ( ) const

pure virtual

Returns

the UID of the text story containing the ILG

virtual PMMatrix IInlineData::GetWaxToILGMatrix ( ) const

pure virtual

Relative to the Wax, or content coordinate space, the Inline is translated by the waxToILGMatrix provided at Register().

Returns

PMMatrix to translate from Wax to Inline position

virtual const IParcel* IInlineData::QueryParcel ( ) const

pure virtual

Returns

the Parcel of the ILG. This value is set when the ILG is Applied() and cleared when it is Unregister()ed.

virtual const ITextStoryThread* IInlineData::QueryStoryThread ( ) const

pure virtual

Returns

the TextStoryThread containing the ILG

virtual ITextFrameColumn* IInlineData::QueryTextFrame ( ) const

pure virtual

Returns

The TextFrameColumn that the Parcel containing the Inline is part of.

virtual ITextModel* IInlineData::QueryTextModel ( ) const

pure virtual

Returns

the text story containing the ILG

virtual const ITextParcelList* IInlineData::QueryTextParcelList ( ) const

pure virtual

Returns

the TextParcelList of the text story thread containing the ILG

virtual IWaxStrand* IInlineData::QueryWaxStrand ( ) const

pure virtual

Returns

the WaxStrand of the text story containing the ILG

virtual void IInlineData::RecomposeThru ( ) const

pure virtual

The containing story thread, and any threads that it is anchored in, are forced to be composed. Note that this may or may not result in the Inline being registered - the inline or a containing anchor thread may still be in overset.

virtual void IInlineData::SetObjectDesignation ( ClassID  objectType )

pure virtual

Sets (when created) the type of object, the key used by the item strand

Parameters

objectType

ClassID

virtual void IInlineData::UnRegister ( )

pure virtual

Unregister the Inline. May be safely called even if the Inline is already unregistered.