offapi/com/sun/star/i18n/XExtendedTextConversion.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 module com { module sun { module star { module i18n {
  22
  23
  24
  25 /**
  26     This interface provides Text Conversion service.
  27
  28     <p> It is derived from
  29     ::com::sun::star::i18n::XTextConversion and provides
  30     a new conversion function containing position map (offset) between original
  31     and converted string. </p>
  32
  33      @since OOo 2.0
  34  */
  35 published interface XExtendedTextConversion : ::com::sun::star::i18n::XTextConversion
  36 {
  37     /**
  38         The functionality of this method is same as
  39         ::com::sun::star::i18n::XTextConversion::getConversion(),
  40         except an additional output parameter rOffset.
  41
  42         @param aText
  43             See ::com::sun::star::i18n::XTextConversion::getConversion()
  44         @param nStartPos
  45             See ::com::sun::star::i18n::XTextConversion::getConversion()
  46         @param nLength
  47             See ::com::sun::star::i18n::XTextConversion::getConversion()
  48         @param aLocale
  49             See ::com::sun::star::i18n::XTextConversion::getConversion()
  50         @param nTextConversionType
  51             See ::com::sun::star::i18n::XTextConversion::getConversion()
  52         @param nTextConversionOptions
  53             See ::com::sun::star::i18n::XTextConversion::getConversion()
  54
  55         @param rOffset
  56             To find the grapheme of input string corresponding to the
  57             grapheme of output string, rOffset provides the offset array
  58             whose index is the offset of output string, the element
  59             containing the position within the input string.
  60             When the graphemes of input and output strings are simple
  61             one to one mapping, to improve the performance, returned
  62             rOffset will be a zero length array.
  63      */
  64     string getConversionWithOffset(
  65             [in] string aText,
  66             [in] long nStartPos,
  67             [in] long nLength,
  68             [in] ::com::sun::star::lang::Locale aLocale,
  69             [in] short nTextConversionType,
  70             [in] long nTextConversionOptions,
  71             [out] sequence <long> rOffset )
  72         raises( com::sun::star::lang::IllegalArgumentException,
  73                 com::sun::star::lang::NoSupportException );
  74 };
  75
  76 }; }; }; };
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */