XExtendedTextConversion Interface Reference

This interface provides Text Conversion service. More...

import"XExtendedTextConversion.idl";

Inheritance diagram for XExtendedTextConversion:

Public Member Functions
string	getConversionWithOffset ([in] string aText, [in] long nStartPos, [in] long nLength, [in] ::com::sun::star::lang::Locale aLocale, [in] short nTextConversionType, [in] long nTextConversionOptions, [out] sequence< long > rOffset) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
	The functionality of this method is same as com::sun::star::i18n::XTextConversion::getConversion(), except an additional output parameter rOffset. More...
Public Member Functions inherited from XTextConversion
TextConversionResult	getConversions ([in] string aText, [in] long nStartPos, [in] long nLength, [in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
	Method to search dictionaries for the conversion candidates. More...
string	getConversion ([in] string aText, [in] long nStartPos, [in] long nLength, [in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
	Method to search dictionaries for the conversion candidate, if there are multiple candidates, it will return first one. More...
boolean	interactiveConversion ([in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
	Method to query if the conversion type should be interactive or non-interactive mode. 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

This interface provides Text Conversion service.

It is derived from com::sun::star::i18n::XTextConversion and provides a new conversion function containing position map (offset) between original and converted string.

Since

OOo 2.0

Member Function Documentation

getConversionWithOffset()

string getConversionWithOffset	(	[in] string	aText,
		[in] long	nStartPos,
		[in] long	nLength,
		[in] ::com::sun::star::lang::Locale	aLocale,
		[in] short	nTextConversionType,
		[in] long	nTextConversionOptions,
		[out] sequence< long >	rOffset
	)
raises	(	com::sun::star::lang::IllegalArgumentException,
		com::sun::star::lang::NoSupportException
	)

The functionality of this method is same as com::sun::star::i18n::XTextConversion::getConversion(), except an additional output parameter rOffset.

Parameters

aText	See com::sun::star::i18n::XTextConversion::getConversion()
nStartPos	See com::sun::star::i18n::XTextConversion::getConversion()
nLength	See com::sun::star::i18n::XTextConversion::getConversion()
aLocale	See com::sun::star::i18n::XTextConversion::getConversion()
nTextConversionType	See com::sun::star::i18n::XTextConversion::getConversion()
nTextConversionOptions	See com::sun::star::i18n::XTextConversion::getConversion()
rOffset	To find the grapheme of input string corresponding to the grapheme of output string, rOffset provides the offset array whose index is the offset of output string, the element containing the position within the input string. When the graphemes of input and output strings are simple one to one mapping, to improve the performance, returned rOffset will be a zero length array.

---

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

• com/sun/star/i18n/XExtendedTextConversion.idl