:: com :: sun :: star :: linguistic2 ::

interface XPossibleHyphens

Methods' Summary
getWord  
getLocale  
getPossibleHyphens  
getHyphenationPositions  
Methods' Details
getWord
string
getWord();

Returns
the word for which the information of possible hyphenation points was obtained.
getLocale
::com::sun::star::lang::Locale
getLocale();

Returns
the language of the hyphenated word.
See also
::com::sun::star::lang::Locale
getPossibleHyphens
string
getPossibleHyphens();

Returns
a string depicting the word with all hyphen positions which are represented by "=" characters. If there are any alternative spellings, the word will be altered accordingly.
getHyphenationPositions
sequence< short >
getHyphenationPositions();

Returns
an ascending sequence of numbers where each number is an offset within the original word which denotes a hyphenation position corresponding to one of the hyphens in the string returned by XPossibleHyphens::getPossibleHyphens.
Top of Page