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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XExtendedTextConversion.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_i18n_XExtendedTextConversion_idl__
  32 #define __com_sun_star_i18n_XExtendedTextConversion_idl__
  33
  34 #include <com/sun/star/i18n/XTextConversion.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module i18n {
  39
  40 //=============================================================================
  41
  42
  43 /**
  44     This interface provides Text Conversion service.
  45
  46     <p> It is derived from
  47     <type scope="::com::sun::star::i18n">XTextConversion</type> and provides
  48     a new conversion function containing position map (offset) between original
  49     and conveted string. </p>
  50
  51      @since OOo 2.0
  52  */
  53 published interface XExtendedTextConversion : ::com::sun::star::i18n::XTextConversion
  54 {
  55     //-------------------------------------------------------------------------
  56     /**
  57         The functionality of this method is same as
  58         <member scope="::com::sun::star::i18n">XTextConversion::getConversion()</member>,
  59         except an additional output parameter rOffset.
  60
  61         @param rOffset
  62             To find the grapheme of input string corresponding to the
  63             grapheme of output string, rOffset provides the offset array
  64             whose index is the offset of output string, the element
  65             containing the position within the input string.
  66             When the graphemes of input and output strings are simple
  67             one to one mapping, to improve the performance, returned
  68             rOffset will be a zero length array.
  69      */
  70     string getConversionWithOffset(
  71             [in] string aText,
  72             [in] long nStartPos,
  73             [in] long nLength,
  74             [in] ::com::sun::star::lang::Locale aLocale,
  75             [in] short nTextConversionType,
  76             [in] long nTextConversionOptions,
  77             [out] sequence <long> rOffset )
  78         raises( com::sun::star::lang::IllegalArgumentException,
  79                 com::sun::star::lang::NoSupportException );
  80 };
  81
  82 //=============================================================================
  83 }; }; }; };
  84
  85 #endif