| LibreOffice
    LibreOffice 24.8 SDK API Reference | 
gives information obtained by a successful hyphenation attempt. More...
import "XHyphenatedWord.idl";
 
  
| Public Member Functions | |
| string | getWord () | 
| com::sun::star::lang::Locale | getLocale () | 
| short | getHyphenationPos () | 
| string | getHyphenatedWord () | 
| short | getHyphenPos () | 
| boolean | isAlternativeSpelling () | 
| is used to query if the hyphenation result is an alternative spelling. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
gives information obtained by a successful hyphenation attempt.
This interface is used as a return value for some of the hyphenator functions.
| string getHyphenatedWord | ( | ) | 
| short getHyphenationPos | ( | ) | 
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.
| short getHyphenPos | ( | ) | 
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.
| com::sun::star::lang::Locale getLocale | ( | ) | 
| string getWord | ( | ) | 
| boolean isAlternativeSpelling | ( | ) | 
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.