ISpellingDataStrand.h

//========================================================================================
// 
// $File$
// 
// Owner: hhorton
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef _H_SPELLINGDATASTRAND
#define _H_SPELLINGDATASTRAND

#include "IPMUnknown.h"
#include "LinguisticID.h"

typedef enum SpellingState {kSpellingUnchecked = -1, kSpellingCorrect, kSpellingError, kIncorrectWord, kUncapitalizedWord, kGrammarError, kRepeatedWord, kUncapitalizedStartOfSentence,
 kNoteAnchor, kDeletedText} SpellingState;


class ITextModel;

class ISpellingDataStrand : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISPELLINGDATASTRAND };

 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;
};

class ISpellingStateData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISPELLINGSTATECMDDATA };

 virtual void Set(UIDRef& spellingDataStrandRef, UIDRef& modelRef, SpellingState spellingState, TextIndex start, int32 length) = 0;

 virtual void GetSpellingStrandRef(UIDRef& ref) = 0;

 virtual void GetModelRef(UIDRef& ref) = 0;

 virtual void GetSpellingState(SpellingState& spellingState) = 0;

 virtual void GetStartTextIndex(TextIndex& start) = 0;

 virtual void GetLength(int32& length) = 0;
};

#endif