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

(Global Index)

Syntax

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

Description

gives information obtained by a successful hyphenation attempt.

This interface is used as a return value for some of the hyphenator functions.

See also

XHyphenator

Method Summary

getWord

getLocale

getHyphenationPos

getHyphenatedWord

getHyphenPos

isAlternativeSpelling is used to query if the hyphenation result is an alternative spelling.

Method Details



getWord

Syntax

string getWord ();

Description

Returns

the word that was hyphenated.

getLocale

Syntax

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

Description

Returns

the language of the hyphenated word.

See also

Locale

getHyphenationPos

Syntax

short getHyphenationPos ();

Description

Returns

the position where hyphenation was applied in the word.

The value has to be in the range from 0 (after the first character) to n-2 (before the last character) where n is the length of the word.


getHyphenatedWord

Syntax

string getHyphenatedWord ();

Description

Returns

the hyphenated word as it should be written (without the hyphen character).

getHyphenPos

Syntax

short getHyphenPos ();

Description

Returns

the position of the hyphen in the hyphenated word.

The value has to be in the range from 0 (after the first character) to m-2 (before the last character) where m is the length of the hyphenated word.


isAlternativeSpelling

Syntax

boolean isAlternativeSpelling ();

Description

is used to query if the hyphenation result is an alternative spelling.

A hyphenation result is an alternative spelling if the hyphenated word is different from the word that was hyphenated.

Returns

true if it is an alternative spelling, false otherwise.
Top of Page