ISpellingDataStrand Class Reference

#include <ISpellingDataStrand.h>

Inheritance diagram for ISpellingDataStrand:

Public Types
enum	{ kDefaultIID = IID_ISPELLINGDATASTRAND }

Public Member Functions
virtual void	MarkInsertDamage (TextIndex start, int32 length)=0
virtual void	MarkDeleteDamage (TextIndex start, int32 length, bool16 paraStrandAfter=kTrue)=0
virtual int32	MarkPasteDamage (TextIndex start, int32 length)=0
virtual void	MarkChangeDamage (TextIndex start, int32 length, bool16 addOneToLength=kFalse)=0
virtual void	MarkGeometryDamage (TextIndex start, int32 length)=0
virtual void	MarkRegenDamage (TextIndex start, int32 length)=0
virtual void	MarkContentDamage (TextIndex start, int32 length)=0
virtual void	SetSpellingDataState (TextIndex startpos, int32 numchars, SpellingState spellingState, ITextModel *model)=0
virtual SpellingState	GetSpellingDataRun (TextIndex position, int32 *count, TextIndex *runBegin=nil)=0
virtual void	SetDamageStart (ITextModel *model, TextIndex t)=0
virtual TextIndex	GetDamageStart (void)=0
virtual void	SetNumErrors (int32 n)=0
virtual int32	GetNumErrors (void)=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

Interface for managing the text model's Spelling Data Strand

Member Function Documentation

virtual TextIndex ISpellingDataStrand::GetDamageStart ( void  )

pure virtual

get the damage start index

Returns

damage start index

virtual int32 ISpellingDataStrand::GetNumErrors ( void  )

pure virtual

mark paste damage for the spelling strand

Returns

number of errors

virtual SpellingState ISpellingDataStrand::GetSpellingDataRun ( TextIndex  position, int32 *  count, TextIndex *  runBegin = nil  )

pure virtual

get the spelling data run

Parameters

position	IN: start text index
count	OUT: character length
runBegin	OUT: run's start index

Returns

spelling state of the run

virtual void ISpellingDataStrand::MarkChangeDamage ( TextIndex  start, int32  length, bool16  addOneToLength = kFalse  )

pure virtual

mark change damage for the spelling strand

Parameters

start	start text index
length	character length
addOneToLength	ignored

virtual void ISpellingDataStrand::MarkContentDamage ( TextIndex  start, int32  length  )

pure virtual

mark content damage for the spelling strand

Parameters

start	start text index
length	character length

virtual void ISpellingDataStrand::MarkDeleteDamage ( TextIndex  start, int32  length, bool16  paraStrandAfter = kTrue  )

pure virtual

mark delete damage for the spelling strand

Parameters

start	start text index
length	character length
paraStrandAfter	ignored

virtual void ISpellingDataStrand::MarkGeometryDamage ( TextIndex  start, int32  length  )

pure virtual

mark geometry damage for the spelling strand

Parameters

start	start text index
length	character length

virtual void ISpellingDataStrand::MarkInsertDamage ( TextIndex  start, int32  length  )

pure virtual

mark insert damage for the spelling strand

Parameters

start	start text index
length	character length

virtual int32 ISpellingDataStrand::MarkPasteDamage ( TextIndex  start, int32  length  )

pure virtual

mark paste damage for the spelling strand

Parameters

start	start text index
length	character length

Returns

pasted length

virtual void ISpellingDataStrand::MarkRegenDamage ( TextIndex  start, int32  length  )

pure virtual

mark regen damage for the spelling strand

Parameters

start	start text index
length	character length

virtual void ISpellingDataStrand::SetDamageStart ( ITextModel *  model, TextIndex  t  )

pure virtual

set the damage start index

Parameters

model	text model
t	start text index

virtual void ISpellingDataStrand::SetNumErrors ( int32  n )

pure virtual

set the number of errors

Parameters

n	number of errors

virtual void ISpellingDataStrand::SetSpellingDataState ( TextIndex  startpos, int32  numchars, SpellingState  spellingState, ITextModel *  model  )

pure virtual

set the spelling data state

Parameters

startpos	start text index
numchars	character length
spellingState	new spelling state
model	text model