XHyphenatedWord Interface Reference

gives information obtained by a successful hyphenation attempt. More...

import"XHyphenatedWord.idl";

Inheritance diagram for XHyphenatedWord:

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. More...
Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...
void	acquire ()
	increases the reference counter by one. More...
void	release ()
	decreases the reference counter by one. More...

Detailed 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

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

Member Function Documentation

getHyphenatedWord()

string getHyphenatedWord

(

)

Returns

the hyphenated word as it should be written (without the hyphen character).

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.

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.

getLocale()

com::sun::star::lang::Locale getLocale

(

)

Returns

the language of the hyphenated word.

See also

com::sun::star::lang::Locale

getWord()

string getWord

(

)

Returns

the word that was hyphenated.

isAlternativeSpelling()

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.

Returns

TRUE if it is an alternative spelling, FALSE otherwise.

---

The documentation for this interface was generated from the following file:

• com/sun/star/linguistic2/XHyphenatedWord.idl