#include <IPreflightObjectModelUtils.h>

Inheritance diagram for IPreflightObjectModelUtils:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTOBJECTMODELUTILS }

Public Member Functions
virtual PreflightObjectID	GetDocumentObject (const IDocument *iDoc) const =0

virtual PreflightObjectID	GetSpreadObject (const ISpread *iSpread) const =0

virtual PreflightObjectID	GetShapeObject (const IShape *iShape) const =0

virtual PreflightObjectID	GetTextRangeObject (const UIDRef &textModelRef, TextIndex start, int32 span) const =0

virtual PreflightObjectID	GetTextWaxRunObject (const UIDRef &textModelRef, TextIndex start) const =0

virtual PreflightObjectID	GetTextWaxRunAdornmentObject (const UIDRef &textModelRef, TextIndex start, ClassID adornmentID) const =0

virtual PreflightObjectID	GetTextCharacterObject (const UIDRef &textModelRef, TextIndex index) const =0

virtual PreflightObjectID	GetTableAreaObject (const UIDRef &tableModelRef, const UIDRef &tableFrameRef, const GridArea &area) const =0

virtual PreflightObjectID	GetSpellCheckStateObject (const IDocument *iDoc) const =0

virtual PreflightObjectID	GetTrackedChangeStateObject (const IDocument *iDoc) 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

Preflight object model utilities. These utilities initialize and return PreflightObjectIDs corresponding to well-known entities in the InDesign object model.

This interface lives on the global utilities boss. Use it via

Utils<IPreflightObjectModelUtils>()->XX();



or 



Utils<IPreflightObjectModelUtils> iUtils;

iUtils->XX();

Member Function Documentation

virtual PreflightObjectID IPreflightObjectModelUtils::GetDocumentObject ( const IDocument * iDoc ) const

pure virtual

Obtain a preflight ObjectID for a document.

Parameters

iDoc	IN The document you want an object ID for.

Returns: The object ID corresponding to the document. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetShapeObject ( const IShape * iShape ) const

pure virtual

Obtain a preflight ObjectID for a page item (IShape based). The result will will be a kPreflightOM_PageItem class preflight object; no attempt is made to specialize further.

Parameters

iDoc	IN The page item you want an object ID for.

Returns: The object ID corresponding to the spread. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetSpellCheckStateObject ( const IDocument * iDoc ) const

pure virtual

Obtain a preflight ObjectID for the document spell check state. This is a virtual object which is invalidated when the application-level spell check state changes or dynamic spelling indicates that the document has moved from a no-error to error state or vice-versa.

Returns: The object ID corresponding to the spell check state. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetSpreadObject ( const ISpread * iSpread ) const

pure virtual

Obtain a preflight ObjectID for a spread.

Parameters

iDoc	IN The spread you want an object ID for.

Returns: The object ID corresponding to the spread. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetTableAreaObject	(	const UIDRef &	tableModelRef,
		const UIDRef &	tableFrameRef,
		const GridArea &	area
	)		const

pure virtual

Obtain a preflight ObjectID for a table area or table frame area.

Parameters

tableModelRef	IN The UIDRef of the table model.
tableFrameRef	IN The UIDRef of the table frame model, or UIDRef() if this is table area and not a frame area.
area	IN The grid area for the cell range. Empty area = whole table.

Returns: The object ID corresponding to the table or frame area. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetTextCharacterObject	(	const UIDRef &	textModelRef,
		TextIndex	index
	)		const

pure virtual

Obtain a preflight ObjectID for a single character. The class ID is kPreflightOM_TextCharacter and is reported differently from a single-character text range, ie its glyph data is shown.

Parameters

textModelRef	IN The UIDRef of the text model.
index	IN The index of the character in the model.

Returns: The object ID corresponding to the character. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetTextRangeObject	(	const UIDRef &	textModelRef,
		TextIndex	start,
		int32	span
	)		const

pure virtual

Obtain a preflight ObjectID for a text range. The class ID is kPreflightOM_TextRange.

Parameters

textModelRef	IN The UIDRef of the text model.
start	IN The starting index in model.
span	IN The number of characters in the range (starting at 'start')

Returns: The object ID corresponding to the text range. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetTextWaxRunAdornmentObject	(	const UIDRef &	textModelRef,
		TextIndex	start,
		ClassID	adornmentID
	)		const

pure virtual

Obtain a preflight ObjectID for a text wax run adornment. The class ID is kPreflightOM_WaxRunAdornment.

Parameters

textModelRef	IN The UIDRef of the text model.
start	IN The starting index in model of the wax run.
adornmentID	IN The class ID of the adornment on the run. If kInvalidClass, this is the same as calling GetTextWaxRunObject.

Returns: The object ID corresponding to the text run. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetTextWaxRunObject	(	const UIDRef &	textModelRef,
		TextIndex	start
	)		const

pure virtual

Obtain a preflight ObjectID for a text wax run. The class ID is kPreflightOM_WaxRun.

Parameters

textModelRef	IN The UIDRef of the text model.
start	IN The starting index in model of the wax run.

Returns: The object ID corresponding to the text range. Note that this is NOT a UID; this ID makes sense only within the preflight model.

virtual PreflightObjectID IPreflightObjectModelUtils::GetTrackedChangeStateObject ( const IDocument * iDoc ) const

pure virtual

Obtain a preflight ObjectID for the tracked change state. This is a virtual object which is invalidated when the the document has moved from a no-error to error state or vice-versa.

Returns: The object ID corresponding to the spell check state. Note that this is NOT a UID; this ID makes sense only within the preflight model.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation