Method to convert text from one type to another. More...

Inheritance diagram for XTextConversion:

Public Member Functions
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.
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.
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.
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.

Detailed Description

Method to convert text from one type to another.

Developers Guide: Office Development - Implementing a New Locale - XTextConversion
Office Development - Overview and Using the API - XTextConversion

Member Function Documentation

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.

This is for the conversion in non-interactive mode.

Parameters

aText	Text string to be converted.
nStartPos	The start position in aText for the conversion
nLength	The length of the portion in aText for the conversion
Locale	Locale the conversion is referring to.
nTextConversionType	One of TextConversionType values.
nTextConversionOptions	Combination of TextConversionOption values.

Exceptions

NoSupportException when nConversionDictionaryType is not known by the implementation, or when the locale is not supported.

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.

Parameters

aText	Text string to be converted.
nStartPos	The start position in aText for the conversion
nLength	The length of the portion in aText for the conversion
Locale	Locale the conversion is referring to.
nTextConversionType	One of TextConversionType values.
nTextConversionOptions	Combination of TextConversionOption values.

Exceptions

NoSupportException when nConversionDictionaryType is not known by the implementation, or when the locale is not supported.

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.

Parameters

Locale	Locale the conversion is referring to.
nTextConversionType	One of TextConversionType values.
nTextConversionOptions	Combination of TextConversionOption values.

Returns: TRUE if the entry is a valid entry for the dictionary FALSE otherwise.

Exceptions

NoSupportException when nConversionDictionaryType is not known by the implementation, or when the locale is not supported.

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