HypHyphenatedWord.h

//========================================================================================
//
// $File$
//
// Owner: Adobe Developer Technologies
//
// $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 __HypHyphenatedWord__
#define __HypHyphenatedWord__

#include "Hyp.h"

// Forward declarations:
class WideString;
class PMString;
class HypHyphenationPair;
class IHyphenatedWord;
class TextCharBuffer;

class HypHyphenatedWord : public IHyphenatedWord
{
 public:
 HypHyphenatedWord(const TextCharBuffer& originalWord, const uint16 nMinTail, const uint16 nMinHead, const Hyp::HyphenationPoints& hyphenationPoints);

 virtual ~HypHyphenatedWord();

 public:
 virtual int32 GetPointCount() const;

 virtual int32 GetIndexOfPoint(int32 nNthPoint) const;

 virtual int32 GetQualityOfPoint(int32 nNthPoint) const;

 virtual WideString GetWord() const;

 virtual void GetPartsOfPoint(int32 nNthPoint, WideString* pFirstPart, WideString* pLastPart) const;

 virtual void GetFirstPartOfPoint(int32 nNthPoint, WideString* pPart) const;

 virtual void GetLastPartOfPoint(int32 nNthPoint, WideString* pPart) const;

 virtual void Merge(const IHyphenatedWord* pToMergeWith);

 virtual void ValidatePointRanges();

 private:
 const TextCharBuffer fOriginalWord;
 const uint16 fnMinTail;
 const uint16 fnMinHead;
 Hyp::HyphenationPoints fHyphenationPoints;
};

#endif // __HypHyphenatedWord__