Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XDictionaryEntry
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, ::com::sun::star::uno::XInterface

Methods' Summary
getDictionaryWord  
isNegative  
getReplacementText is the suggested replacement text for negative words.  
Methods' Details
getDictionaryWord
string
getDictionaryWord();

Returns
the word defining this entry.
isNegative
boolean
isNegative();

Returns
true if the word (entry) is a negative one and should not be used, false otherwise.
getReplacementText
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.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.