INTEGRATION: CWS hhc (1.1.2); FILE ADDED

2003/03/27 14:00:09 tl 1.1.2.2: #105688# Hangul/Hanja converrsion
2003/03/27 11:02:17 tl 1.1.2.1: #105688# Hangul/Hanja converrsion

1 files changed, 193 insertions, 0 deletions

diff --git a/offapi/com/sun/star/i18n/XTextConversion.idl b/offapi/com/sun/star/i18n/XTextConversion.idl
new file mode 100644
index 000000000000..4fc564a4a38f
--- /dev/null
+++ b/offapi/com/sun/star/i18n/XTextConversion.idl
@@ -0,0 +1,193 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XTextConversion.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2003-04-17 17:57:08 $
+ *
+ *  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., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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 WARRANTY OF ANY KIND, EITHER EXPRESSED 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: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_i18n_XTextConversion_idl__
+#define __com_sun_star_i18n_XTextConversion_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_lang_Locale_idl__
+#include <com/sun/star/lang/Locale.idl>
+#endif
+
+#ifndef __com_sun_star_i18n_TextConversionResult_idl__
+#include <com/sun/star/i18n/TextConversionResult.idl>
+#endif
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+#ifndef __com_sun_star_lang_NoSupportException_idl__
+#include <com/sun/star/lang/NoSupportException.idl>
+#endif
+
+
+//=============================================================================
+
+module com {  module sun {  module star {  module i18n {
+
+//=============================================================================
+
+/** Method to convert text from one type to another
+*/
+interface XTextConversion : ::com::sun::star::uno::XInterface
+{
+    //---------------------------------------------------------------------
+    /** Method to search dictionaries for the conversion candidates.
+
+        @param aText
+            Text string to be converted.
+        @param nStartPos
+            The start position in aText for the conversion
+        @param nLength
+            The length of the partion in aText for the conversion
+        @param aLocal
+            Locale the conversion is referring to.
+        @param nTextConversionType
+            One of <type>TextConversionType</type> values.
+        @param nTextConversionOptions
+            Combination of <type>TextConversionOption</type> values.
+        @returns
+            <type>TextConversionResult</type>
+
+        @throws NoSupportException
+            when <var>nConversionDictionaryType</var> is not known by the implementation,
+            or when the locale is not supported.
+    */
+    TextConversionResult getConversions(
+            [in] string aText,
+            [in] long nStartPos,
+            [in] long nLength,
+            [in] ::com::sun::star::lang::Locale aLocale,
+            [in] short nTextConversionType,
+            [in] long nTextConversionOptions )
+        raises( com::sun::star::lang::IllegalArgumentException,
+                com::sun::star::lang::NoSupportException );
+
+    //---------------------------------------------------------------------
+    /** Method to search dictionaries for the conversion candidate, if there
+        are multiple candidates, it will return first one. This is for the
+        conversion in non-interactive mode.
+
+        @param aText
+            Text string to be converted.
+        @param nStartPos
+            The start position in aText for the conversion
+        @param nLength
+            The length of the partion in aText for the conversion
+        @param aLocal
+            Locale the conversion is referring to.
+        @param nTextConversionType
+            One of <type>TextConversionType</type> values.
+        @param nTextConversionOptions
+            Combination of <type>TextConversionOption</type> values.
+        @returns
+            Converted text
+
+        @throws NoSupportException
+            when <var>nConversionDictionaryType</var> is not known by the implementation,
+            or when the locale is not supported.
+    */
+    string getConversion(
+            [in] string aText,
+            [in] long nStartPos,
+            [in] long nLength,
+            [in] ::com::sun::star::lang::Locale aLocale,
+            [in] short nTextConversionType,
+            [in] long nTextConversionOptions )
+        raises( com::sun::star::lang::IllegalArgumentException,
+                com::sun::star::lang::NoSupportException );
+
+    //---------------------------------------------------------------------
+    /** Method to query if the conversion type should be interactive or
+        non-interactive mode.
+
+        @param aLocal
+            Locale the conversion is referring to.
+        @param nTextConversionType
+            One of <type>TextConversionType</type> values.
+        @param nTextConversionOptions
+            Combination of <type>TextConversionOption</type> values.
+        @returns
+            <TRUE/> if the entry is a valid entry for the dictionary
+            <FALSE/> otherwise.
+
+        @throws NoSupportException
+            when <var>nConversionDictionaryType</var> is not known by the implementation,
+            or when the locale is not supported.
+    */
+    boolean interactiveConversion(
+            [in] ::com::sun::star::lang::Locale aLocale,
+            [in] short nTextConversionType,
+            [in] long nTextConversionOptions )
+        raises( com::sun::star::lang::IllegalArgumentException,
+                com::sun::star::lang::NoSupportException );
+};
+
+
+//=============================================================================
+
+}; }; }; };
+
+#endif