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

(Global Index)

Syntax

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

Description

This interfaces gives access to a dictionary entry.

A dictionary entry can supply a word and its hyhenation and indicate if it is a negative word. If it is a negative entry it may supply a replacement text to be used instead of the entry word.

Hyphenation positions are represented by an '=' in the word. If the '=' is the last character of the word this means it should not be hyphenated. If there is no '=' charcter in the word, hyphenation positions will be determined automatically (i.e., from the hyphenator service alone).

Entries whose words only differ in hyphenation are considered to be equal. Also a '.' at the end of the word will make no difference.

See also

XDictionary

See also

XInterface

Method Summary

getDictionaryWord

isNegative

getReplacementText is the suggested replacement text for negative words.

Method Details



getDictionaryWord

Syntax

string getDictionaryWord ();

Description

Returns

the word defining this entry.

isNegative

Syntax

boolean isNegative ();

Description

Returns

true if the word (entry) is a negative one and should not be used, false otherwise.

See also

getReplacementText

getReplacementText

Syntax

string getReplacementText ();

Description

is the suggested replacement text for negative words.

It is undefined if the entry is not negative.

Returns

the replacement text for a negative entry. An empty string indicates that no replacement text is provided.

See also

isNegative
Top of Page