InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IHyphenationService Class Referenceabstract
Inheritance diagram for IHyphenationService:
IPMUnknownCPMUnknown< IHyphenationService >HypHyphenationService

Public Types

enum  { kDefaultIID = IID_IHYPHENATIONSERVICE }
 

Public Member Functions

virtual IHyphenatedWordHyphenate (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
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual void IHyphenationService::CheckUserDictionary (bool16 checkIt)
pure virtual

Sets check user dictionary flag.

Parameters
checkItkTrue to turn on check user dictionary flag.

Implemented in HypHyphenationService.

virtual IHyphenatedWord* IHyphenationService::Hyphenate (const TextCharBufferrWord,
LinguisticServiceMode hyphenMode,
uint16 nMinTail = 0,
uint16 nMinHead = 0,
LinguisticProviderHyphenationStyle providerHyphStyle = kLinguisticProviderHyphenation_All 
)
pure virtual

returns nil or a new HyphenatedWord with further information.

Parameters
rWordword to hyphenate
hyphenModehow to hyphenate word
nMinTailnumber of characters at end without hyphen point
nMinHeadnumber of characters at beginning without hyphen point
providerHyphStylestyle of the provider to be used for hyphenation
Returns
IHyphenatedWord* New hyphenated word with specified information or nil.

Implemented in HypHyphenationService.

virtual bool16 IHyphenationService::Set (const PMStringrFileName)
pure virtual

Sets file name in hyphenation service.

Parameters
rFileNameFile name to set to.
Returns
bool16 kTrue if successfully set the file name.

Implemented in HypHyphenationService.