interface XPossibleHyphens in module com::sun::star::linguistic2::

(Global Index)

Syntax

interface XPossibleHyphens : com::sun::star::uno::XInterface ;

Description

Gives information about a word's possible hyphenation points.

Example: In German pre-spelling-reform you may have the following: getWord: Dampfschiffahrt getPossibleHyphens: Dampf=schiff=fahrt getOrigHyphensPositions: 4, 9 That is "Dampfschiffahrt" can be hyphenated after the "pf" (4) and between the double "ff" (9). And if you are going to hyphenate it at position 9 you will get an additional "f" before the hyphen character.

See also

XHyphenator

Method Summary

getWord

getLocale

getPossibleHyphens

getHyphenationPositions

Method Details



getWord

Syntax

string getWord ();

Description

Returns

the word for which the information of possible hyphenation points was obtained.

getLocale

Syntax

com::sun::star::lang::Locale getLocale ();

Returns

the language of the hyphenated word.

See also

Locale

getPossibleHyphens

Syntax

string getPossibleHyphens ();

Description

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

Syntax

sequence< short > getHyphenationPositions ();

Description

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 'getPossibleHyphens' string.

See also

getWord

See also

getPossibleHyphens
Top of Page