ISpellingService.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __ISpellingService__
#define __ISpellingService__

#include "IPMUnknown.h"
#include "K2Vector.h"

//----------------------------------------------------------------------------------------
// Interface ISpellingService
//----------------------------------------------------------------------------------------

class WideString;
typedef K2Vector<WideString> WideStringList;

class ISpellingService : public IPMUnknown
{
public:
 enum SpellResult {
 kCorrect = 0, 
 kSpellError,
 kIncorrectWord,
 kUncapitalizedWord, 
 kGrammarError,
 kRepeatedWord,
 kUncapitalizedStartOfSentence,

 kNoteAnchor,
 kDeletedText
 } ;

 virtual SpellResult IsCorrect( const WideString &rWord, bool16 *bEndsWithPeriod ) = 0;

 virtual bool16 FindAlternatives( const WideString &rWord, WideStringList *pAlternatives ) = 0;

 virtual SpellResult Spell( const WideString &rWord, WideStringList *pAlternatives, bool16 *bEndsWithPeriod ) = 0;

 virtual SpellResult IsCorrectGrammar( const WideString &rParagraph, int32 *pWordStart, int32 *pWordLength, int32 startAt = 0 ) = 0;

 virtual bool16 Set( const PMString &rCoreFileName, const PMString &rLexFileName, const PMString &rPhonFileName, const PMString &rBaseLangLexFileName ) = 0;

 virtual bool16 SupportsCaseSensitive() = 0;


 virtual SpellResult FindError( const WideString &rParagraph, int32 startAt, int32 *pErrorStart, int32 *pErrorLength, WideStringList* pAlternatives, bool searchBackwards=false) = 0;

 class SpellingError
 {
 public:
 int32 errorStart;
 int32 errorLength;
 SpellResult spellingErrorType;
 };
 virtual void FindAllErrors( const WideString &rParagraph, int32 startAt, std::vector<SpellingError> *pSpellingErrors ) = 0;

};

#endif