Inheritance diagram for ITextWalkerClient:

Public Types
enum	{ kDefaultIID = IID_ITEXTWALKERCLIENT }

Public Member Functions
virtual bool16	OnStart (ITextWalker *pWalker)=0

virtual bool16	OnEnd (ITextWalker *pWalker)=0

virtual bool16	OnResume (ITextWalker *pWalker)=0

virtual bool16	OnSuspend (ITextWalker *pWalker)=0

virtual bool16	OnNextPosition (ITextWalker pWalker, ITextModel pModel, TextIndex nPosition, TextIndex nStartRange, TextIndex nEndRange, int32 startRangePrcnt, int32 endRangePrcnt, bool16 rangeAdjustable)=0

virtual bool16	OnStoryStart (ITextWalker *pWalker, UID storyUID)=0

virtual void	OnStoryEnd (ITextWalker *pWalker)=0

virtual bool16	OnDocumentStart (ITextWalker *pWalker, const UIDRef &newDoc)=0

virtual void	OnDocumentEnd (ITextWalker *pWalker)=0

virtual void	SetReplacementCount (int32 count)=0

virtual int32	GetReplacementCount ()=0

virtual bool16	UpdateTextRange ()=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual int32 ITextWalkerClient::GetReplacementCount ( )

pure virtual

Gets replacement count.

Returns: int32 Replacement count retrieved.

virtual void ITextWalkerClient::OnDocumentEnd ( ITextWalker * pWalker )

pure virtual

Client operation for end of a document.

Parameters

pWalker Text walker where the document ends.

virtual bool16 ITextWalkerClient::OnDocumentStart	(	ITextWalker *	pWalker,
		const UIDRef &	newDoc
	)

pure virtual

Client operation for start of a document.

Parameters

pWalker	Text walker where the document starts.
newDoc	document which started.

Returns: bool16 kTrue if the operation succeeded.

virtual bool16 ITextWalkerClient::OnEnd ( ITextWalker * pWalker )

pure virtual

Client operation when text walker is ending.

Parameters

pWalker text walker which is ending.

Returns: bool16 kTrue if operation succeeded .

virtual bool16 ITextWalkerClient::OnNextPosition	(	ITextWalker *	pWalker,
		ITextModel *	pModel,
		TextIndex	nPosition,
		TextIndex	nStartRange,
		TextIndex	nEndRange,
		int32	startRangePrcnt,
		int32	endRangePrcnt,
		bool16	rangeAdjustable
	)

pure virtual

Client operation when text walker moves to next position.

Parameters

pWalker	Text walker which moves to next position.
pModel	Text model where moves happens.
nPosition	Previous walker position.
nStartRange	New start position of text walker.
nEndRange	New end position of text walker.
startRangePrcnt	Percentage of the distance where start position moved.
endRangePrcnt	Percentage of the distance where end posistion moved.
rangeAdjustable	To deal with problem of starting the search in the middle of a word we adjust the starting point to the first position we have found something. This allows the search to wrap around (if that's the scope) and find the word we started on.

Returns: bool16 kTrue if the operation succeeded.

virtual bool16 ITextWalkerClient::OnResume ( ITextWalker * pWalker )

pure virtual

Client operation when text walker is resuming.

Parameters

pWalker text walker which is resuming.

Returns: bool16 kTrue if operation succeeded .

virtual bool16 ITextWalkerClient::OnStart ( ITextWalker * pWalker )

pure virtual

Client operation when text walker is starting.

Parameters

pWalker text walker which is starting.

Returns: bool16 kTrue if operation succeeded .

virtual void ITextWalkerClient::OnStoryEnd ( ITextWalker * pWalker )

pure virtual

Client operation for end of a story.

Parameters

pWalker Text walker where the story ends.

virtual bool16 ITextWalkerClient::OnStoryStart	(	ITextWalker *	pWalker,
		UID	storyUID
	)

pure virtual

Client operation for start of a story.

Parameters

pWalker	Text walker where the story starts.
storyUID	story UID.

Returns: bool16 kTrue if the operation succeeded.

virtual bool16 ITextWalkerClient::OnSuspend ( ITextWalker * pWalker )

pure virtual

Client operation when text walker is suspending.

Parameters

pWalker text walker which is suspending.

Returns: bool16 kTrue if operation succeeded .

virtual void ITextWalkerClient::SetReplacementCount ( int32 count )

pure virtual

Sets replacement count.

Parameters

count Replacement count to set to.

virtual bool16 ITextWalkerClient::UpdateTextRange ( )

pure virtual

Does client want to update text range and wants to move text walker. If client will return kFalse, on next walk client will get same startIndex and endIndex. It's usefull for cases where client wants to check many attribute in same range. If you are not sure what to return, return kTrue.

Returns: bool16 kTrue if the client wants to update text range and want to mo.

Public Types

Public Member Functions

Member Function Documentation