Language
The Free and Open Productivity Suite
:: 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' Details |
getWord
- Returns
- the word that was hyphenated.
|
|
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
- 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
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.
