IHyphenationService.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 __IHyphenationService__
#define __IHyphenationService__

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

class TextCharBuffer;

//----------------------------------------------------------------------------------------
// Interface IHyphenationService
//----------------------------------------------------------------------------------------
class IHyphenatedWord;

enum LinguisticServiceMode {
 kLinguisticService_Nothing = 0x00, 
 kLinguisticService_ManualBit = 0x01, 
 kLinguisticService_UserDictBit = 0x02, 
 kLinguisticService_DictionaryBit = 0x04, 
 kLinguisticService_AlgorithmBit = 0x08, 
 kLinguisticService_ManualOnly = 0x01,
 kLinguisticService_UserDict = 0x03, 
 kLinguisticService_Dictionary = 0x07, 
 kLinguisticService_Algorithm = 0x0F 
};

enum LinguisticProviderHyphenationStyle {
 kLinguisticProviderHyphenation_All,
 kLinguisticProviderHyphenation_AllButUnaesthetic,
 kLinguisticProviderHyphenation_Aesthetic,
 kLinguisticProviderHyphenation_PreferredAesthetic
};


class IHyphenationService : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHYPHENATIONSERVICE };

 virtual IHyphenatedWord* Hyphenate(const TextCharBuffer &rWord, LinguisticServiceMode hyphenMode, uint16 nMinTail = 0, uint16 nMinHead = 0, LinguisticProviderHyphenationStyle providerHyphStyle = kLinguisticProviderHyphenation_All) = 0;

 virtual bool16 Set( const PMString &rFileName ) = 0;

 virtual void CheckUserDictionary(bool16 checkIt) = 0;
};

#endif