Hyp Namespace Reference

Typedefs
typedef K2Vector< InterfacePtr < ILanguage > >	HyphenationServices
typedef int32	HyphenIndex
typedef int32	HyphenQuality
typedef KeyValuePair < HyphenIndex, HyphenQuality >	HyphenationPoint
typedef K2Vector < HyphenationPoint >	HyphenationPoints

Detailed Description

Data types used by the Hyphenator plug-in to implement hyphenation.

Typedef Documentation

typedef KeyValuePair<HyphenIndex, HyphenQuality> Hyp::HyphenationPoint

Hypenation point represented as an index/quality pair with lookup by hyphen index (HyphenIndex).

typedef K2Vector<HyphenationPoint> Hyp::HyphenationPoints

Collection of the hyphenation points for a word.

typedef K2Vector<InterfacePtr<ILanguage> > Hyp::HyphenationServices

Collection of hyphenation service boss objects (kHypHyphenationServiceBoss). A reference to the language (ILanguage) interface is maintained because the hyphenation manager (IHyphenationMgr, HypHyphenationMgr) locate services by language.

typedef int32 Hyp::HyphenIndex

Index in a word to a hyphenation point. A hyphen index is the position before the hyphen. For example to indicate that the word kitten is hyphenated between the t's (kit-ten) it's hyphen index would be 2.

typedef int32 Hyp::HyphenQuality

The quality measure for a hypenation point takes one of the values given in IHyphenatedWord, kRegularHyphenPoint, kDiscretionaryHyphenPoint etc.