IHyphenationStyle.h

//========================================================================================
// 
// $File$
// 
// Owner: Eric_Menninga
// 
// $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 __IHyphenationStyle__
#define __IHyphenationStyle__


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

class ILanguage;


class IHyphenationStyle : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IHYPHENATIONSTYLE };

 typedef enum { kHyphensOff = 0, kHyphensManual, kHyphensDictionary,
 kHyphensAlgorithm } HyphenationMethod;

 enum ProviderHyphenationStyle {
 kHyph_All = 0,
 kHyph_AllButUnaesthetic,
 kHyph_Aesthetic,
 kHyph_PreferredAesthetic
 };

 virtual int16 MinCharsBefore() const = 0;

 virtual int16 MinCharsAfter() const = 0;

 virtual int16 ShortestWord() const = 0;

 virtual void SetMinCharsBefore(int16 i) = 0;

 virtual void SetMinCharsAfter(int16 i) = 0;

 virtual void SetShortestWord(int16 i) = 0;

 virtual PMReal HyphenationZone() const = 0;

 virtual void SetHyphenationZone(PMReal zone) = 0;

 virtual void SetLadderLimit(int16 ladderCount) = 0;

 virtual int16 GetLadderLimit() const = 0;

 virtual HyphenationMethod GetHyphenationMethod() const = 0;

 virtual void SetHyphenationMethod(HyphenationMethod method) = 0;

 virtual bool16 HyphenateCapitalized() const = 0;

 virtual void SetHyphenateCapitalized(bool16 b) = 0;

 virtual double GetHyphenationPenaltyFactor() const = 0;

 virtual void SetHyphenationPenaltyFactor(double p) = 0;

 virtual double GetLastLineHyphenPenalty() const = 0;

 virtual void SetLastLineHyphenPenalty(double d) = 0;

 virtual bool16 PreventLastWordHyphen() const = 0;

 virtual void SetLastWordHyphenPrevention(bool16 b) = 0;

 virtual ILanguage *QueryLanguage() const = 0;

 virtual void SetLanguageUID(UID nLanguage) = 0;

 virtual UID GetLanguageUID() const = 0;

 virtual bool16 GetPreventCrossFrameHyphen() const = 0;

 virtual void SetPreventCrossFrameHyphen(bool16 p) = 0;

 /* Get the hyphenation style for the provider. The provider Duden has four styles that give different hyphenation points.
 @return the provider hyphenations style.
 */
 virtual ProviderHyphenationStyle GetProviderHyphenationStyle() const = 0;

 virtual void SetProviderHyphenationStyle(IHyphenationStyle::ProviderHyphenationStyle providerHyphenationStyle) = 0;
};


#endif // __IHyphenationStyle__