Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: i18n ::
interface XTextConversion
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XTextConversion
Description Method to convert text from one type to another Since version OpenOffice.org 1.1.1

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 [in] long [in] long [in] ::com::sun::star::lang::Locale [in] short [in] long raises( | aText, nStartPos, nLength, aLocale, nTextConversionType, nTextConversionOptions ) ::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 partion 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 [in] long [in] long [in] ::com::sun::star::lang::Locale [in] short [in] long raises( | aText, nStartPos, nLength, aLocale, nTextConversionType, nTextConversionOptions ) ::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 partion 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 [in] short [in] long raises( | aLocale, nTextConversionType, nTextConversionOptions ) ::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 © 2003 Sun Microsystems, Inc.