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