LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
XTextConversion Interface Referencepublished

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

import "XTextConversion.idl";

Inheritance diagram for XTextConversion:
XInterface XExtendedTextConversion TextConversion

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

Method to convert text from one type to another.

Since
OOo 1.1.2
Developers Guide
OfficeDev - Implementing a New Locale - XTextConversion
OfficeDev - 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
aTextText string to be converted.
nStartPosThe start position in aText for the conversion
nLengthThe length of the portion in aText for the conversion
LocaleLocale the conversion is referring to.
nTextConversionTypeOne of TextConversionType values.
nTextConversionOptionsCombination of TextConversionOption values.
Returns
Converted text
Exceptions
NoSupportExceptionwhen 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
aTextText string to be converted.
nStartPosThe start position in aText for the conversion
nLengthThe length of the portion in aText for the conversion
LocaleLocale the conversion is referring to.
nTextConversionTypeOne of TextConversionType values.
nTextConversionOptionsCombination of TextConversionOption values.
Returns
TextConversionResult
Exceptions
NoSupportExceptionwhen 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
LocaleLocale the conversion is referring to.
nTextConversionTypeOne of TextConversionType values.
nTextConversionOptionsCombination of TextConversionOption values.
Returns
TRUE if the entry is a valid entry for the dictionary FALSE otherwise.
Exceptions
NoSupportExceptionwhen 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: