IPreflightArtworkTextContext Class Reference

#include <IPreflightArtworkTextContext.h>

Inheritance diagram for IPreflightArtworkTextContext:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTARTWORKTEXTCONTEXT }

Public Member Functions
virtual bool	IsTextNode () 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 Text::DrawPassInfo::Pass	GetPass () const =0
virtual ClassID	GetAdornmentClassID () 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

This interface provides context for a marking operation, group, or context. That is, 

IPreflightArtworkMarkInfo and IPreflightArtworkGroupInfo can tell you all about the specifics 

of the marking operation but this interface tells you what "high level" (ie wax run)

operation it's associated with.

See Also

IPreflightArtworkContext for a longer description of the relationship between marking operations and contexts.

Typical usage:

MyRule::Visit(IPreflightVisitInfo* iVisit)

{

    if (iVisit->GetObjectID().GetClass() == kPrefligthOM_ArtworkMark)

    {

        InterfacePtr<IPreflightObject> iObj(iVisit->QueryObject());

Is this drawn as part of a table? InterfacePtr<IPreflightArtworkContext> iContext(iObj, UseDefaultIID()); InterfacePtr<IPreflightArtworkTextContext> iTextContext(iContext->QueryParentTextContext());

if (iTextContext) { Yes, part of a a text run.. use text model to poke around more.. } } }

Member Function Documentation

virtual TextIndex IPreflightArtworkTextContext::GetAbsoluteStart ( ) const

pure virtual

Returns

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

virtual ClassID IPreflightArtworkTextContext::GetAdornmentClassID ( ) const

pure virtual

Returns

The adornment class ID of the text marking operation, if the marking is done by an adornment. If not, returns kInvalidClass.

virtual ParcelKey IPreflightArtworkTextContext::GetParcelKey ( ) const

pure virtual

Returns

The key of the parcel the text is contained in. ParcelKey() if not a text context node.

virtual TextIndex IPreflightArtworkTextContext::GetParcelRelativeStart ( ) const

pure virtual

Returns

The starting index of the text, relative to the containing parcel. 0 if not a text context node.

virtual Text::DrawPassInfo::Pass IPreflightArtworkTextContext::GetPass ( ) const

pure virtual

Returns

The pass of the text marking operation.

virtual int32 IPreflightArtworkTextContext::GetSpan ( ) const

pure virtual

Returns

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

virtual UIDRef IPreflightArtworkTextContext::GetTextModelRef ( ) const

pure virtual

Returns

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

virtual uint32 IPreflightArtworkTextContext::GetThreadDictKey ( ) const

pure virtual

Returns

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

virtual UID IPreflightArtworkTextContext::GetThreadDictUID ( ) const

pure virtual

Returns

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

virtual bool IPreflightArtworkTextContext::IsTextNode ( ) const

pure virtual

Returns whether this node is a metadata (context) node representing the text information for a bunch of child marking operations. Normally you'd use this only if walking the context stack manually.

Returns

kTrue if a shape node; kFalse otherwise.