Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: i18n ::
interface XTextConversion
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

Methods' Summary
getConversions | Method to search dictionaries for the conversion candidates.
getConversion | 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.
interactiveConversion | Method to query if the conversion type should be interactive or non-interactive mode.

Methods' Details
getConversions
TextConversionResult
getConversions( | [in] string | aText,
| [in] long | nStartPos,
| [in] long | nLength,
| [in] ::com::sun::star::lang::Locale | aLocale,
| [in] short | nTextConversionType,
| [in] long | nTextConversionOptions )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::NoSupportException );
Description Method to search dictionaries for the conversion candidates. Parameter aText Text string to be converted. Parameter nStartPos The start position in aText for the conversion Parameter nLength The length of the portion in aText for the conversion Parameter aLocal Locale the conversion is referring to. Parameter nTextConversionType One of TextConversionType values. Parameter nTextConversionOptions Combination of TextConversionOption values. Returns TextConversionResult Throws NoSupportException when nConversionDictionaryType is not known by the implementation, or when the locale is not supported.
getConversion
string
getConversion( | [in] string | aText,
| [in] long | nStartPos,
| [in] long | nLength,
| [in] ::com::sun::star::lang::Locale | aLocale,
| [in] short | nTextConversionType,
| [in] long | nTextConversionOptions )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::NoSupportException );
Description 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. Parameter aText Text string to be converted. Parameter nStartPos The start position in aText for the conversion Parameter nLength The length of the portion in aText for the conversion Parameter aLocal Locale the conversion is referring to. Parameter nTextConversionType One of TextConversionType values. Parameter nTextConversionOptions Combination of TextConversionOption values. Returns Converted text Throws NoSupportException when nConversionDictionaryType is not known by the implementation, or when the locale is not supported.
interactiveConversion
boolean
interactiveConversion( | [in] ::com::sun::star::lang::Locale | aLocale,
| [in] short | nTextConversionType,
| [in] long | nTextConversionOptions )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::NoSupportException );
Description Method to query if the conversion type should be interactive or non-interactive mode. Parameter aLocal Locale the conversion is referring to. Parameter nTextConversionType One of TextConversionType values. Parameter nTextConversionOptions Combination of TextConversionOption values. Returns true if the entry is a valid entry for the dictionary false otherwise. Throws NoSupportException when nConversionDictionaryType is not known by the implementation, or when the locale is not supported.

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.