IPageItemAdapter Class Reference

#include <IPageItemAdapter.h>

Inheritance diagram for IPageItemAdapter:

Public Types
enum	{ kDefaultIID = IID_IPAGEITEMADAPTER }

Public Member Functions
virtual UIDRef	GetTextFrameRef () const =0
virtual ITextFrameColumn *	QueryTextFrame () const =0
virtual UID	GetSpreadUID () 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 bool16	GetHasPageItemHyperlink () const =0
virtual ParcelKey	GetParcelKey () const =0
virtual const IParcel *	QueryParcel () const =0
virtual ITextModel *	QueryTextModel () const =0
virtual IItemContext *	QueryItemContext () const =0
virtual void	NotifyCacheInval (bool16 isRebuilding) const =0
virtual void	NotifyChangeDamage () const =0
virtual void	NotifyContentDamage () const =0
virtual void	NotifyDescendentChanged () const =0
virtual bool16	GetRegistering () const =0
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 page items can be placed inside text as inlines or placed inside graphic cells of tables. This is a common wrapper of such objects, for interaction of text with objects and vice-versa. This interface is always available on such objects.

Member Function Documentation

virtual PMRect IPageItemAdapter::GetConstrainedTo ( ) const

pure virtual

Returns

The pasteboard rectangle that the PageItem is constrained to.

virtual PMRect IPageItemAdapter::GetGlyphBoundingBox ( ) const

pure virtual

Equivalent to GetStrokeBoundingBox() on the child PageItem.

virtual bool16 IPageItemAdapter::GetHasPageItemHyperlink ( ) const

pure virtual

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

virtual PMRect IPageItemAdapter::GetPaintedBoundingBox ( ) const

pure virtual

Equivalent to GetPaintedBBox() on the child PageItem.

virtual ParcelKey IPageItemAdapter::GetParcelKey ( ) const

pure virtual

Returns

the registered ParcelKey of the Page Item.

virtual PMRect IPageItemAdapter::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 bool16 IPageItemAdapter::GetRegistering ( ) const

pure virtual

Adobe internal use only

virtual UID IPageItemAdapter::GetSpreadUID ( ) const

pure virtual

Returns

the root UID of the TextFrame associated with the Parcel.

virtual UIDRef IPageItemAdapter::GetTextFrameRef ( ) const

pure virtual

Returns

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

virtual void IPageItemAdapter::NotifyCacheInval ( bool16  isRebuilding ) const

pure virtual

Adobe internal use only Called after the parcel containing this object is invalidated

virtual void IPageItemAdapter::NotifyChangeDamage ( ) const

pure virtual

Adobe internal use only Called after the damage is clear, appropriate action to the changes should be taken

virtual void IPageItemAdapter::NotifyContentDamage ( ) const

pure virtual

Adobe internal use only Called after the damage is clear, appropriate action to the changes should be taken

virtual void IPageItemAdapter::NotifyDescendentChanged ( ) const

pure virtual

Adobe internal use only Called if the descendants of the object has been changed, and appropriate action needs to be taken

virtual IItemContext* IPageItemAdapter::QueryItemContext ( ) const

pure virtual

Returns the item context on the text frame containing the object, or the one on the last text frame, if the frame is overset.

virtual const IParcel* IPageItemAdapter::QueryParcel ( ) const

pure virtual

Returns

the Parcel of the Page Item.

virtual ITextFrameColumn* IPageItemAdapter::QueryTextFrame ( ) const

pure virtual

Returns

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

virtual ITextModel* IPageItemAdapter::QueryTextModel ( ) const

pure virtual

Returns

the text story containing the page item