InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
HyphenExceptions Class Reference

Public Types

typedef object_type data_type
 

Public Member Functions

 HyphenExceptions (const HyphenExceptions &other)
 
 HyphenExceptions (const ILanguage *language)
 
void operator= (const HyphenExceptions &copy)
 
bool16 operator== (const HyphenExceptions &other) const
 
bool16 operator> (const HyphenExceptions &other) const
 
bool16 operator< (const HyphenExceptions &other) const
 
bool16 empty () const
 
bool16 SameLanguage (const HyphenExceptions &other) const
 
bool16 SameLanguage (const ILanguage *language) const
 
void SetLanguage (const ILanguage *language)
 
ILanguageQueryLanguage () const
 
void SetLanguageName (const PMString &languageName)
 
void ReadWrite (IPMStream *s)
 

Public Attributes

UserDictWordList fStrings
 
UserDictWordList fNotStrings
 

Member Function Documentation

bool16 HyphenExceptions::empty () const
Hyphen exceptions is empty.

Returns
bool16 kTrue if no exceptions in either added or excluded lists
bool16 HyphenExceptions::operator< (const HyphenExceptionsother) const
inline

Hyphenation exception is considered to be smaller than the other one if language name string is smaller.

Parameters
otherHyphenation exception to compare to.
Returns
bool16 kTrue if the hyphenation exception is smaller than the other one.
bool16 HyphenExceptions::operator== (const HyphenExceptionsother) const
inline

Hyphenation exception is considered to be equal if all members are euqal.

Parameters
otherHyphenation exception to compare to.
Returns
bool16 kTrue if the hyphenation exception is the same as the other one.
bool16 HyphenExceptions::operator> (const HyphenExceptionsother) const
inline

Hyphenation exception is considered to be greater than the other one if language name string is greater.

Parameters
otherHyphenation exception to compare to.
Returns
bool16 kTrue if the hyphenation exception is greater than the other one.
ILanguage* HyphenExceptions::QueryLanguage () const

Query language

Returns
ILanguage language of HyphenException
void HyphenExceptions::ReadWrite (IPMStreams)

Read and write for the hyphenation exception

Parameters
sstream to read from or write to
bool16 HyphenExceptions::SameLanguage (const HyphenExceptionsother) const

HyphenExcetions share same language

Parameters
otherOther hyphenation excpetion to check against
Returns
bool16 kTrue if same language
bool16 HyphenExceptions::SameLanguage (const ILanguagelanguage) const

HyphenExcetions share same language

Parameters
languageLanguage to check against
Returns
bool16 kTrue if same language
void HyphenExceptions::SetLanguage (const ILanguagelanguage)

Set language

Parameters
languagelanguage of HyphenException
void HyphenExceptions::SetLanguageName (const PMStringlanguageName)

Set language name

Parameters
languageNamename of language of HyphenException