Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

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

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.