#include <IGlobalRecompose.h>

Inheritance diagram for IGlobalRecompose:

Public Types
enum	{ kDefaultIID = IID_IGLOBALRECOMPOSE }

Public Member Functions
virtual void	RecomposeAllStories (bool16 clearModelCaches=kFalse)=0

virtual bool16	SelectiveRecompose (const AttributeChecker &whichAttribute, UID singleStory=kInvalidUID)=0

virtual bool16	SelectiveRecompose (const WaxLineChecker &whichAttribute, UID singleStory=kInvalidUID)=0

virtual bool16	SelectiveRecompose (const ModelChecker &whichAttribute, UID singleStory=kInvalidUID)=0

virtual bool16	SelectiveRecompose (const StoryOptionsChecker &whichAttribute, UID singleStory=kInvalidUID)=0

virtual void	ForceRecompositionToComplete ()=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 class is designed to cause damages to stories in a

document, hence making the entire document or portion of it to recompose when it is needed to. The damages can be set to the entire document, or it can be set according to specified attributes

The following is a sample code on how to use this interface:


  InterfacePtr<IGlobalRecompose> globalRecompose(theFrontDoc, IID_IGLOBALRECOMPOSE);

  MyAttribute attributeAffected;

  globalRecompose->GlobalAttributeDamage(&attributeAffected);

where MyAttribute is a derived class from AttributeChecker containing implementations to check if the front document contains a specifed attributes.

Member Function Documentation

virtual void IGlobalRecompose::ForceRecompositionToComplete ( )

pure virtual

Force the entire document to be fully composed. (The above calls just mark composition damage.)

virtual void IGlobalRecompose::RecomposeAllStories ( bool16 clearModelCaches = kFalse )

pure virtual

Causes damages to all stories in this document.

Parameters

clearModelCaches can be used to automatically clear the ITextReferences cache and the IComposeScanner cache. However, this isn't usually necessary, because those interfaces are caches of MODEL data, not composition data.

virtual bool16 IGlobalRecompose::SelectiveRecompose	(	const AttributeChecker &	whichAttribute,
		UID	singleStory = `kInvalidUID`
	)

pure virtual

Causes damages to stories containing specified attributes.

Parameters

singleStory specifies the UID of a single text model if only one story should be examined. kInvalidUID means all stories.

Returns: if any range of text is marked damaged, the method will return kTrue.

See Also: AttributeChecker

virtual bool16 IGlobalRecompose::SelectiveRecompose	(	const WaxLineChecker &	whichAttribute,
		UID	singleStory = `kInvalidUID`
	)

pure virtual

Causes damages to lines containing specified attributes.

Parameters

singleStory specifies the UID of a single text model if only one story should be examined. kInvalidUID means all stories.

Returns: if any range of text is marked damaged, the method will return kTrue.

See Also: WaxLineChecker

virtual bool16 IGlobalRecompose::SelectiveRecompose	(	const ModelChecker &	whichAttribute,
		UID	singleStory = `kInvalidUID`
	)

pure virtual

Causes damages to stories containing specified styles and overrides.

Parameters

singleStory specifies the UID of a single text model if only one story should be examined. kInvalidUID means all stories.

Returns: if any range of text is marked damaged, the method will return kTrue.

See Also: ModelChecker

virtual bool16 IGlobalRecompose::SelectiveRecompose	(	const StoryOptionsChecker &	whichAttribute,
		UID	singleStory = `kInvalidUID`
	)

pure virtual

Causes damages to stories containing specified story options.

Parameters

singleStory specifies the UID of a single text model if only one story should be examined. kInvalidUID means all stories.

Returns: if any range of text is marked damaged, the method will return kTrue.

See Also: StoryOptionsChecker

Public Types

Public Member Functions

Detailed Description

Member Function Documentation