IDictionaryUtils.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 __IDictionaryUtils__
#define __IDictionaryUtils__

#include "IPMUnknown.h"

#include "LinguisticID.h"
#include "K2Vector.h"
#include "KeyValuePair.h"

class IDocument;
class WideString;
class PMString;
class ILanguage;
class HyphenExceptionsList;
class IScript;
class IUserDict;
class IScriptRequestData;

typedef K2Vector<KeyValuePair<int32, int32> > HyphenPoints; // sorted


#include "ITextUtils.h" //for FuncIsWordChar

class IDictionaryUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDICTIONARYUTILS };
 
 virtual bool16 GetAllUserDictsStringList(HyphenExceptionsList& list, bool16 bMerge) const = 0;
 virtual void CopyUserDictsToDocument(IDocument * doc) const = 0;
 virtual bool16 CheckForAndHandleHyphConflicts(IDocument * doc, HyphenExceptionsList& heList) const = 0;
 virtual bool16 GetProximityWord( const PMString& rNewWord, WideString *pWord, HyphenPoints *pPoints ) const = 0;

 virtual bool16 ImportUserDict( ILanguage* pLang, IUserDict* userDict, ClassID nProvider, IDFile *userDoctFile = nil, bool16 replaceOldDict = kTrue, bool16 ignoreRanking = kFalse, FuncIsWordChar isDictWordChar = nil, bool16 caseSensitive = kFalse ) const = 0;

 virtual bool16 ExportUserDict( ILanguage* pLang, IUserDict* userDict, ClassID nProvider, IDFile *userDoctFile = nil ) const = 0;

 //For Scripting
 virtual int32 GetNumUserDicts() const = 0 ;
 virtual IScript* QueryUserDictByName( const IScriptRequestData* data, const PMString& name ) const = 0 ;
 virtual IScript* QueryUserDictByLanguageIndex( const IScriptRequestData* data, int32 n ) const = 0 ;
 virtual IScript* QueryUserDictByIndex( const IScriptRequestData* data, int32 n ) const = 0 ;
};


#endif // __IDictionaryUtils__