#include <IFrameListComposer.h>

Inheritance diagram for IFrameListComposer:

Public Types
enum	{ kDefaultIID = IID_IFRAMELISTCOMPOSER }

Public Member Functions
virtual void	RecomposeThruLastFrame ()=0

virtual void	RecomposeThruTextIndex (TextIndex composeUpThruThisIndex)=0

virtual void	RecomposeThru (TextIndex composeUpThruThisIndex, const IMultiColumnTextFrame *sentinalMCFrame=nil)=0

virtual bool16	RecomposeOneFrame (IdleTimer *interruptCheck)=0

virtual bool16	RecomposeUntil (TextIndex index, const IMultiColumnTextFrame mcFrame, IdleTimer timeCheck)=0

virtual void	RecomposeFully ()=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 controls recomposition either by frame or up to a given TextIndex.

Member Function Documentation

virtual void IFrameListComposer::RecomposeFully ( )

pure virtual

This method will compose all damaged frames in the FrameList and, if one or more frames WERE damaged and result in overset, and the addition of additional frames is supported and appropriate for this FrameList, additional frames will be added until the FrameList is no longer overset or it is determined that adding frames is not helping.

virtual bool16 IFrameListComposer::RecomposeOneFrame ( IdleTimer * interruptCheck )

pure virtual

Recomposes the first damaged frame in the frame list. For use by background recomposition.

Parameters

interruptCheck Pointer to optional IdleTimer

Returns: kTrue if composition finished within the time given by the IdleTimer, kFalse if the frame remains damaged

virtual void IFrameListComposer::RecomposeThru	(	TextIndex	composeUpThruThisIndex,
		const IMultiColumnTextFrame *	sentinalMCFrame = `nil`
	)

pure virtual

Recompose all frames up thru the one containing this text index or the specified MultiColumnTextFrame, whichever comes first.

Parameters

composeUpThruThisIndex
sentinalMCFrame	Optional pointer to MultiColumnTextFrame

virtual void IFrameListComposer::RecomposeThruLastFrame ( )

pure virtual

Recompose all TextFrameColumns in the IFrameList.

virtual void IFrameListComposer::RecomposeThruTextIndex ( TextIndex composeUpThruThisIndex )

pure virtual

Recompose all frames up thru the one containing the specified TextIndex.

Parameters

composeUpThruThisIndex TextIndex to compose upto, pass kInvalidTextIndex to compose all text in the FrameList.

virtual bool16 IFrameListComposer::RecomposeUntil	(	TextIndex	index,
		const IMultiColumnTextFrame *	mcFrame,
		IdleTimer *	timeCheck
	)

pure virtual

Recomposes damaged frames until index is composed or frame is composed or timeCheck returns 0, whichever comes first.

Parameters

index	TextIndex to compose upto, pass kInvalidTextIndex to compose all text in the FrameList.
mcFrame	Pointer to MultiColumnTextFrame to compose thru, pass nil to compose all frames in the FrameList.
timeCheck	Pointer to optional IdleTimer

Returns: kTrue if composition finished within the time given by the IdleTimer, kFalse if the target frame remains damaged.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation