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 XHyphenatedWord
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

Methods' Summary
getWord  
getLocale  
getHyphenationPos  
getHyphenatedWord  
getHyphenPos  
isAlternativeSpelling is used to query if the hyphenation result is an alternative spelling.  
Methods' Details
getWord
string
getWord();

Returns
the word that was hyphenated.
getLocale
::com::sun::star::lang::Locale
getLocale();

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

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
string
getHyphenatedWord();

Returns
the hyphenated word as it should be written (without the hyphen character).
getHyphenPos
short
getHyphenPos();

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
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

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.