IHyphenationExceptions.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.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef _H_IHyphenationExceptions
#define _H_IHyphenationExceptions

#include "IPMUnknown.h"
#include "TextID.h"

class ILanguage;
class TextCharBuffer;
class HyphenExceptions;
class HyphenExceptionsList;
class IHyphenatedWord;

class IHyphenationExceptions: public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IHYPHENATIONEXCEPTIONS };
 
 virtual void SetDefaultHyphenationExceptionsList(const HyphenExceptionsList& list) = 0;
 
 virtual void GetHyphenationExceptionsList(HyphenExceptionsList& list) const = 0;
 virtual void SetHyphenationExceptionsList(const HyphenExceptionsList& list) = 0;
 
 virtual bool16 GetHyphenExceptionsByLanguage(const HyphenExceptions **hyphenExceptions, const ILanguage* lang) const = 0;
 virtual bool16 SetHyphenExceptionsByLanguage(const HyphenExceptions& hyphenExceptions, const ILanguage* lang) = 0;

 virtual int32 GetNumHyphExceptionStructs(void) const = 0;

 virtual IHyphenatedWord* LookupExceptionWord(const TextCharBuffer &trimmed, const ILanguage* lang, int16 minTail, int16 minHead) const = 0;
};

#endif /* _H_IHyphenationExceptions */