IUserDictService.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 __IUserDictService__
#define __IUserDictService__

#include "IPMUnknown.h"
#include "K2Vector.h"
#include "KeyValuePair.h"
#include "LinguisticID.h"
//----------------------------------------------------------------------------------------
// Interface IUserDictService
//----------------------------------------------------------------------------------------
class WideString;
class IHyphenatedWord;
class UserDictWordList;

// key: index in word, value: kNoHyphenPoint to kHardHyphenPoint (see LinguisticID.h).
typedef K2Vector<KeyValuePair<int32, int32> > HyphenPoints;

class IUserDict : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IUSERDICT};
 
 virtual void SetFilePathName(const PMString& filePath) = 0;
 virtual const PMString& GetFilePathName(void) const = 0;

 virtual void SetDataFile(void* dataFile) = 0;
 virtual void* GetDataFile(void) const = 0;

 virtual void Flush(void) = 0;

 virtual PMString GetDisplayName() = 0;
};

class IUserDictService : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IUSERDICTSERVICE};

 enum WordType{ kIsAWord, kNotAWord };
 enum UserDictType{ kNone, kIsDict, kNotDict };

 virtual bool16 AddToUserDict(IUserDict* userDict, const UserDictWordList &constWordList, bool16 caseSensitive, bool16 addToNotList = kFalse) = 0;

 virtual bool16 AddToUserDict( IUserDict* userDict, const WideString &rWord, const HyphenPoints *pPoints = nil, bool16 caseSensitive = kFalse ) = 0;

 virtual bool16 RemoveFromUserDict( IUserDict* userDict, const WideString &rWord ) = 0;

 virtual bool16 ClearUserDict(IUserDict* userDict) = 0;

 virtual UserDictType GetCorrectedWord( IUserDict* userDict, const WideString &rWord, WideString *pCorrectedWord ) = 0;
 
 virtual bool16 GetHyphenatedWord( IUserDict* userDict, const WideString &rWord, WideString *pHyphenatedWord ) = 0;

 //--------- SEARCH PATH ROUTINES-----------------

 virtual bool16 AddUserDictToSearchPath(IUserDict* userDict, int32 index, bool16 addToVendorList = kTrue, bool16 initializing = kFalse) = 0;

 virtual bool16 MoveUserDictInSearchPath(int32 oldIndex, int32 newIndex) = 0;

 virtual bool16 RemoveUserDictFromSearchPath(IUserDict* userDict) = 0;

 virtual bool16 ReplaceUserDictInSearchPath(IUserDict* originalUserDict, IUserDict* newUserDict) = 0;
 
 virtual int32 QueryAllUserDictsInSearchPath(K2Vector<IUserDict*>& userDictList, bool16 bOpenFiles) = 0;

 virtual int32 RemoveAllUserDictsFromSearchPath(void) = 0;


 //--------- MISC ROUTINES-----------------

 virtual IUserDict* QueryNotUserDict(void) = 0;

 virtual IUserDict* QueryMainUserDict(void) = 0;

 virtual bool16 SetMainUserDict(IUserDict* userDict) = 0;

 enum CreateType {
 kDoNotCreate,

 kCreateIfNotFound,

 kAlwaysCreate,

 kCreateMemoryOnly
 };

 virtual IUserDict* CreateNewUserDict(const PMString& filePathName, int16 createFlags) = 0;

 virtual bool16 MigrateUserDict(const IDFile& existingDictFile, const IDFile& newDictFile) = 0;

 virtual bool16 InitializePaths(void) = 0;

 virtual bool16 IsReadOnly(IUserDict* userDict) = 0;

 virtual bool16 Flush() = 0;

 virtual void FlushUserDicts(void) = 0;

 virtual const PMString& GetDefaultFilePathName(void) const = 0;

 virtual const PMString& GetNotFilePathName(void) const = 0;


 virtual bool16 RemoveFromMainDict( const WideString &rWord ) = 0;

 virtual bool16 UndoRemoveFromMainDict( const WideString &rWord ) = 0;

 virtual bool16 ClearRemovedFromMainDict(IUserDict* userDict) = 0;

 virtual bool16 CloseNotClamFile() = 0;
 virtual bool16 IsWordInMainDict( const WideString &rWord, const HyphenPoints *pPoints = nil ) = 0;
 
 virtual bool16 Bind( IUserDict* userDict, const WideString &rChangeFrom, const WideString &rChangeTo ) = 0;
 virtual bool16 Unbind( IUserDict* userDict, const WideString &rChangeFrom, const WideString &rChangeTo ) = 0;
};

#endif