1 files changed, 143 insertions, 0 deletions
diff --git a/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl b/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl
new file mode 100644
index 000000000..e640fceda
--- /dev/null
+++ b/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl
@@ -0,0 +1,143 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_i18n_XExtendedIndexEntrySupplier_idl__
+#define __com_sun_star_i18n_XExtendedIndexEntrySupplier_idl__
+
+#include <com/sun/star/i18n/XIndexEntrySupplier.idl>
+#include <com/sun/star/lang/Locale.idl>
+
+
+module com { module sun { module star { module i18n {
+
+
+
+/**
+    This interface provides information for creating "Table of Index"
+
+    <p> It is derived from
+    ::com::sun::star::i18n::XIndexEntrySupplier and
+    provides following additional functionalities.</p>
+    <ul>
+    <li>Provide supported language/locale list.
+    <li>Provide supported algorithm list.
+    <li>Provide phonetic entry support for CJK language.
+    <li>Provide method to compare index entry.
+    </ul>
+
+     @since OOo 1.1.2
+ */
+published interface XExtendedIndexEntrySupplier : ::com::sun::star::i18n::XIndexEntrySupplier
+{
+    /**
+        Returns locale list for which the IndexEntrySupplier provides service.
+     */
+    sequence < com::sun::star::lang::Locale > getLocaleList();
+
+    /**
+        Returns index algorithm list for specific locale
+     */
+    sequence < string > getAlgorithmList(
+                        [in] com::sun::star::lang::Locale aLocale );
+
+    /**
+        Checks if Phonetic Entry should be used for the locale.
+     */
+    boolean usePhoneticEntry( [in] com::sun::star::lang::Locale aLocale);
+
+    /**
+        Returns phonetic candidate for index entry for the locale.
+     */
+    string getPhoneticCandidate( [in] string aIndexEntry,
+                    [in] com::sun::star::lang::Locale aLocale);
+
+    /**
+        Loads index algorithm for the locale.
+
+        @param aLocale
+            The locale.
+
+        @param aIndexAlgorithm
+            Index algorithm to be loaded.
+
+        @param nCollatorOptions
+            Sorting option of ::com::sun::star::i18n::CollatorOptions for
+            comparing index entries
+
+        @return
+            `TRUE` if algorithm successfully loaded,
+            `FALSE` else.
+     */
+    boolean loadAlgorithm( [in] com::sun::star::lang::Locale aLocale,
+                    [in] string aIndexAlgorithm,
+                    [in] long nCollatorOptions );
+
+    /**
+        Returns index key.
+
+        <p> Note that loadAlgorithm should be called before calling
+        this function. </p>
+
+        @param aIndexEntry
+            Index entry
+
+        @param aPhoneticEntry
+            Phonetic entry
+
+        @param aLocale
+            Language attribute for index and phonetic entry. <br/>
+            aLocale and the locale in loadAlgorithm may be different.
+            In the case they are different, phonetic entry will not
+            be used in the index key generation.
+     */
+    string getIndexKey( [in] string aIndexEntry, [in] string aPhoneticEntry,
+                    [in] com::sun::star::lang::Locale aLocale );
+
+    /**
+        Compares index entries
+
+        <p> Note that loadAlgorithm should be called before calling
+        this function. </p>
+
+        @param aIndexEntry1
+        @param aIndexEntry2
+            Index entries to be compared
+
+        @param aPhoneticEntry1
+        @param aPhoneticEntry2
+            Phonetic entries to be compared
+
+        @param aLocale1
+        @param aLocale2
+            Language attribute for index and phonetic entry. <br/>
+            aLocale and the locale in loadAlgorithm may be different.
+            In the case they are different, phonetic entry will not
+            be used in the index key generation.
+     */
+    short compareIndexEntry( [in] string aIndexEntry1, [in] string aPhoneticEntry1,
+                    [in] com::sun::star::lang::Locale aLocale1,
+                    [in] string aIndexEntry2, [in] string aPhoneticEntry2,
+                    [in] com::sun::star::lang::Locale aLocale2 );
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */