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

Public Member Functions

 HyphenExceptionsList (const HyphenExceptionsList &copy)
 
void clear ()
 
void Clear ()
 
int32 size () const
 
int32 Length () const
 
void Insert (const HyphenExceptions &xx)
 
const HyphenExceptionsoperator[] (int32 i) const
 
HyphenExceptionsoperator[] (int32 i)
 
HyphenExceptionsListoperator= (const HyphenExceptionsList &copy)
 
bool16 operator== (const HyphenExceptionsList &other) const
 
bool16 operator!= (const HyphenExceptionsList &other) const
 
void ReadWrite (IPMStream *s)
 

Member Function Documentation

void HyphenExceptionsList::clear ()

Clears hyphenation exceptions list.

void HyphenExceptionsList::Clear ()
inline

Clears hyphenation exceptions list.

void HyphenExceptionsList::Insert (const HyphenExceptionsxx)

Inserts the specified hyphenation exception into the list in sorted order.

Parameters
xxHyphenation exception to be inserted.
int32 HyphenExceptionsList::Length () const
inline

Returns size of hyphenation exceptions list.

Returns
int32 Size of hyphenation excpetions list.
bool16 HyphenExceptionsList::operator!= (const HyphenExceptionsListother) const
inline

Checks if the hyphenation exceptions list is different than the other one. Two lists are considered not euqal if any item in the lists are not equal.

Parameters
otherOther hyphenation exceptions list to compare with
Returns
bool16 kTrue if two are considered not equal
bool16 HyphenExceptionsList::operator== (const HyphenExceptionsListother) const

Checks if the hyphenation exceptions list is the same as the other one. Two lists are considered euqal if every item in the lists are equal.

Parameters
otherOther hyphenation exceptions list to compare with
Returns
bool16 kTrue if two are considered equal
const HyphenExceptions& HyphenExceptionsList::operator[] (int32 i) const
inline

Returns the hyphenation exception in the list at specified index.

Parameters
iIndex in the hyphenation exeptions list.
Returns
HyphenExceptions& Hyphenation exception at specified index
HyphenExceptions& HyphenExceptionsList::operator[] (int32 i)
inline

Returns the hyphenation exception in the list at specified index.

Parameters
iIndex in the hyphenation exeptions list.
Returns
HyphenExceptions& Hyphenation exception at specified index
void HyphenExceptionsList::ReadWrite (IPMStreams)

Read and write for the hyphenation exceptions list

Parameters
sstream to read from or write to
int32 HyphenExceptionsList::size () const
inline

Returns size of hyphenation exceptions list.

Returns
int32 Size of hyphenation excpetions list.