Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

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

Methods' Summary
getWord  
getLocale  
getPossibleHyphens  
getHyphenationPositions  
Methods' Details
getWord
string
getWord();

Returns
the word for which the information of possible hyphenation points was obtained.
getLocale
::com::sun::star::lang::Locale
getLocale();

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

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
sequence< short >
getHyphenationPositions();

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 string returned by XPossibleHyphens::getPossibleHyphens.
Top of Page

Apache Software Foundation

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

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