INTEGRATION: CWS textconversion (1.1.2); FILE ADDED

2005/08/15 18:23:27 khong 1.1.2.2: #124006# update description
2005/07/18 20:43:46 khong 1.1.2.1: #124006# add extended text conversion API

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

+/*************************************************************************
+ *
+ * $RCSfile: XExtendedTextConversion.idl,v $
+ *
+ * $Revision: 1.2 $
+ *
+ * last change: $Author: rt $ $Date: 2005-11-08 09:11:33 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., May, 2002
+ *
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2002 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (the "License"); You may not use this file
+ * except in compliance with the License.  You may obtain a copy of the
+ * License at http://www.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc..
+ *
+ * Copyright: 2002 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_i18n_XExtendedTextConversion_idl__
+#define __com_sun_star_i18n_XExtendedTextConversion_idl__
+
+#include <com/sun/star/i18n/XTextConversion.idl>
+
+//=============================================================================
+
+module com { module sun { module star { module i18n {
+
+//=============================================================================
+
+
+/**
+    This interface provides Text Conversion service.
+
+    <p> It is derived from
+    <type scope="::com::sun::star::i18n">XTextConversion</type> and provides
+    a new conversion function containing position map (offset) between original
+    and conveted string. </p>
+
+     @since OOo 2.0
+ */
+published interface XExtendedTextConversion : ::com::sun::star::i18n::XTextConversion
+{
+    //-------------------------------------------------------------------------
+    /**
+        The functionality of this method is same as
+        <type scope="::com::sun::star::i18n::XTextConversion>getConversion</type>,
+        except an additional output parameter rOffset.
+
+        @param rOffset
+            To find the grapheme of input string corresponding to the
+            grapheme of output string, rOffset provides the offset array
+            whose index is the offset of output string, the element
+            containing the position within the input string.
+            When the graphemes of input and output strings are simple
+            one to one mapping, to improve the performance, returned
+            rOffset will be a zero length array.
+     */
+    string getConversionWithOffset(
+            [in] string aText,
+            [in] long nStartPos,
+            [in] long nLength,
+            [in] ::com::sun::star::lang::Locale aLocale,
+            [in] short nTextConversionType,
+            [in] long nTextConversionOptions,
+            [out] sequence <long> rOffset )
+        raises( com::sun::star::lang::IllegalArgumentException,
+                com::sun::star::lang::NoSupportException );
+};
+
+//=============================================================================
+}; }; }; };
+//=============================================================================
+#endif