offapi/com/sun/star/i18n/XTextConversion.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {  module sun {  module star {  module i18n {
  23
  24
  25 /** Method to convert text from one type to another
  26
  27      @since OOo 1.1.2
  28 */
  29 published interface XTextConversion : ::com::sun::star::uno::XInterface
  30 {
  31     /** Method to search dictionaries for the conversion candidates.
  32
  33         @param aText
  34             Text string to be converted.
  35         @param nStartPos
  36             The start position in aText for the conversion
  37         @param nLength
  38             The length of the portion in aText for the conversion
  39         @param Locale
  40             Locale the conversion is referring to.
  41         @param nTextConversionType
  42             One of TextConversionType values.
  43         @param nTextConversionOptions
  44             Combination of TextConversionOption values.
  45         @returns
  46             TextConversionResult
  47
  48         @throws NoSupportException
  49             when <var>nConversionDictionaryType</var> is not known by the implementation,
  50             or when the locale is not supported.
  51     */
  52     TextConversionResult getConversions(
  53             [in] string aText,
  54             [in] long nStartPos,
  55             [in] long nLength,
  56             [in] ::com::sun::star::lang::Locale Locale,
  57             [in] short nTextConversionType,
  58             [in] long nTextConversionOptions )
  59         raises( com::sun::star::lang::IllegalArgumentException,
  60                 com::sun::star::lang::NoSupportException );
  61
  62     /** Method to search dictionaries for the conversion candidate, if there
  63         are multiple candidates, it will return first one. This is for the
  64         conversion in non-interactive mode.
  65
  66         @param aText
  67             Text string to be converted.
  68         @param nStartPos
  69             The start position in aText for the conversion
  70         @param nLength
  71             The length of the portion in aText for the conversion
  72         @param Locale
  73             Locale the conversion is referring to.
  74         @param nTextConversionType
  75             One of TextConversionType values.
  76         @param nTextConversionOptions
  77             Combination of TextConversionOption values.
  78         @returns
  79             Converted text
  80
  81         @throws NoSupportException
  82             when <var>nConversionDictionaryType</var> is not known by the implementation,
  83             or when the locale is not supported.
  84     */
  85     string getConversion(
  86             [in] string aText,
  87             [in] long nStartPos,
  88             [in] long nLength,
  89             [in] ::com::sun::star::lang::Locale Locale,
  90             [in] short nTextConversionType,
  91             [in] long nTextConversionOptions )
  92         raises( com::sun::star::lang::IllegalArgumentException,
  93                 com::sun::star::lang::NoSupportException );
  94
  95     /** Method to query if the conversion type should be interactive or
  96         non-interactive mode.
  97
  98         @param Locale
  99             Locale the conversion is referring to.
 100         @param nTextConversionType
 101             One of TextConversionType values.
 102         @param nTextConversionOptions
 103             Combination of TextConversionOption values.
 104         @returns
 105             `TRUE` if the entry is a valid entry for the dictionary
 106             `FALSE` otherwise.
 107
 108         @throws NoSupportException
 109             when <var>nConversionDictionaryType</var> is not known by the implementation,
 110             or when the locale is not supported.
 111     */
 112     boolean interactiveConversion(
 113             [in] ::com::sun::star::lang::Locale Locale,
 114             [in] short nTextConversionType,
 115             [in] long nTextConversionOptions )
 116         raises( com::sun::star::lang::IllegalArgumentException,
 117                 com::sun::star::lang::NoSupportException );
 118 };
 119
 120
 121
 122 }; }; }; };
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */