InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IHyphenationExceptions Class Referenceabstract
Inheritance diagram for IHyphenationExceptions:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IHYPHENATIONEXCEPTIONS }
 

Public Member Functions

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 IHyphenatedWordLookupExceptionWord (const TextCharBuffer &trimmed, const ILanguage *lang, int16 minTail, int16 minHead) const =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 IHyphenationExceptions::GetHyphenationExceptionsList (HyphenExceptionsListlist) const
pure virtual

Gets hyphenation exceptions list.

Parameters
list[OUT] Hyphenation exceptions list retrieved.
virtual bool16 IHyphenationExceptions::GetHyphenExceptionsByLanguage (const HyphenExceptions ** hyphenExceptions,
const ILanguagelang 
) const
pure virtual

Gets hyphenation exceptions by specific language.

Parameters
hyphenExceptions[OUT] Hyphenation exceptions returned.
langlanguage for which to retrieve hyphenation exceptions.
virtual int32 IHyphenationExceptions::GetNumHyphExceptionStructs (void ) const
pure virtual

Returns the length of hyphenation exceptions list.

Returns
int32 Length of hyphenation exceptions list.
virtual IHyphenatedWord* IHyphenationExceptions::LookupExceptionWord (const TextCharBuffertrimmed,
const ILanguagelang,
int16 minTail,
int16 minHead 
) const
pure virtual
    Gets hyphenation information for a word from the hyphenation exceptions.

Parameters
trimmedword to hyphenate
langlanguage to hyphenate in
nMinTailnumber of characters at end without hyphen point
nMinHeadnumber of characters at beginning without hyphen point
Returns
IHyphenatedWord* Hyphenated word found or nil.
virtual void IHyphenationExceptions::SetDefaultHyphenationExceptionsList (const HyphenExceptionsListlist)
pure virtual

Sets default hyphenation exceptions list.

Parameters
listHyphenation exceptions list to set as default.
virtual void IHyphenationExceptions::SetHyphenationExceptionsList (const HyphenExceptionsListlist)
pure virtual

Sets hyphenation exceptions list.

Parameters
listHyphenation exceptions list to set to.
virtual bool16 IHyphenationExceptions::SetHyphenExceptionsByLanguage (const HyphenExceptionshyphenExceptions,
const ILanguagelang 
)
pure virtual

Sets hyphenation exceptions for specific language.

Parameters
hyphenExceptionsHyphenation exceptions to set to.
langlanguage for which to set hyphenation exceptions.
Returns
bool16 kTrue if successfully set the hyphenation exceptions for the language.