IPreflightTextRangeInfo Class Reference

#include <IPreflightTextRangeInfo.h>

Inheritance diagram for IPreflightTextRangeInfo:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTTEXTRANGEINFO }

Public Member Functions
virtual ITextModel *	QueryTextModel () const =0
virtual UIDRef	GetTextModelRef () const =0
virtual UID	GetThreadDictUID () const =0
virtual uint32	GetThreadDictKey () const =0
virtual ParcelKey	GetParcelKey () const =0
virtual TextIndex	GetParcelRelativeStart () const =0
virtual TextIndex	GetAbsoluteStart () const =0
virtual int32	GetSpan () const =0
virtual void	Initialize ()=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

This interface provides text range information corresponding to a preflight text range or wax object. Text is referenced relative to its text story thread to make invalidation more reliable.

You'd use this information if you needed to query the text model as part of writing a preflight rule.

Member Function Documentation

virtual TextIndex IPreflightTextRangeInfo::GetAbsoluteStart ( ) const

pure virtual

Returns

The absolute (ie relative to model) starting index of the text. 0 if not a text context node.

virtual ParcelKey IPreflightTextRangeInfo::GetParcelKey ( ) const

pure virtual

Returns

The key of the parcel the text is contained in.

virtual TextIndex IPreflightTextRangeInfo::GetParcelRelativeStart ( ) const

pure virtual

Returns

The starting index of the text, relative to the parcel it's contained in. 0 if not a text context node.

virtual int32 IPreflightTextRangeInfo::GetSpan ( ) const

pure virtual

Returns

The span of the wax run. Returns 0 if this is not a text context node.

virtual UIDRef IPreflightTextRangeInfo::GetTextModelRef ( ) const

pure virtual

Returns

the text model. Returns UIDRef() if this is not a text context node.

virtual uint32 IPreflightTextRangeInfo::GetThreadDictKey ( ) const

pure virtual

Returns

The key of the story thread. 0 if not a text context node.

virtual UID IPreflightTextRangeInfo::GetThreadDictUID ( ) const

pure virtual

Returns

The UID of the story thread dictionary. kInvalidUID if not a text context node.

virtual void IPreflightTextRangeInfo::Initialize ( )

pure virtual

Initialize. Internal use only.

virtual ITextModel* IPreflightTextRangeInfo::QueryTextModel ( ) const

pure virtual

Get a refcounted text model interface.

Returns

The text model interface related to this text range.