1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_i18n_XExtendedIndexEntrySupplier_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_i18n_XExtendedIndexEntrySupplier_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include <com/sun/star/i18n/XIndexEntrySupplier.idl> 28*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/Locale.idl> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module i18n { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski/** 38*b1cdbd2cSJim Jagielski This interface provides information for creating "Table of Index" 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski <p> It is derived from 41*b1cdbd2cSJim Jagielski <type scope="::com::sun::star::i18n">XIndexEntrySupplier</type> and 42*b1cdbd2cSJim Jagielski provides following additional functionalities.</p> 43*b1cdbd2cSJim Jagielski <ul> 44*b1cdbd2cSJim Jagielski <li>Provide supported language/locale list. 45*b1cdbd2cSJim Jagielski <li>Provide supported algorithm list. 46*b1cdbd2cSJim Jagielski <li>Provide phonetic entry support for CJK languge. 47*b1cdbd2cSJim Jagielski <li>Provide method to compare index entry. 48*b1cdbd2cSJim Jagielski </ul> 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski @since OpenOffice 1.1.2 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielskipublished interface XExtendedIndexEntrySupplier : ::com::sun::star::i18n::XIndexEntrySupplier 53*b1cdbd2cSJim Jagielski{ 54*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 55*b1cdbd2cSJim Jagielski /** 56*b1cdbd2cSJim Jagielski Returns locale list for which the IndexEntrySupplier provides service. 57*b1cdbd2cSJim Jagielski */ 58*b1cdbd2cSJim Jagielski sequence < com::sun::star::lang::Locale > getLocaleList(); 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 61*b1cdbd2cSJim Jagielski /** 62*b1cdbd2cSJim Jagielski Returns index algorithm list for specific locale 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielski sequence < string > getAlgorithmList( 65*b1cdbd2cSJim Jagielski [in] com::sun::star::lang::Locale aLocale ); 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 68*b1cdbd2cSJim Jagielski /** 69*b1cdbd2cSJim Jagielski Checks if Phonetic Entry should be used for the locale. 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski boolean usePhoneticEntry( [in] com::sun::star::lang::Locale aLocale); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski /** 75*b1cdbd2cSJim Jagielski Returns phonetic candidate for index entry for the locale. 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski string getPhoneticCandidate( [in] string aIndexEntry, 78*b1cdbd2cSJim Jagielski [in] com::sun::star::lang::Locale aLocale); 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 81*b1cdbd2cSJim Jagielski /** 82*b1cdbd2cSJim Jagielski Loads index algorithm for the locale. 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski @param aIndexAlgorithm 85*b1cdbd2cSJim Jagielski Index algorithm to be loaded. 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski @param nCollatorOptions 88*b1cdbd2cSJim Jagielski Sorting option of <type 89*b1cdbd2cSJim Jagielski scope="::com::sun::star::i18n">CollatorOptions</type> for 90*b1cdbd2cSJim Jagielski comparing index entries 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @return 93*b1cdbd2cSJim Jagielski <TRUE/> if algorithm successfully loaded, 94*b1cdbd2cSJim Jagielski <FALSE/> else. 95*b1cdbd2cSJim Jagielski */ 96*b1cdbd2cSJim Jagielski boolean loadAlgorithm( [in] com::sun::star::lang::Locale aLocale, 97*b1cdbd2cSJim Jagielski [in] string aIndexAlgorithm, 98*b1cdbd2cSJim Jagielski [in] long nCollatorOptions ); 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 101*b1cdbd2cSJim Jagielski /** 102*b1cdbd2cSJim Jagielski Returns index key. 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski <p> Note that loadAlgorithm should be called before calling 105*b1cdbd2cSJim Jagielski this function. </p> 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski @param aIndexEntry 108*b1cdbd2cSJim Jagielski Index entry 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski @param aPhoneticEntry 111*b1cdbd2cSJim Jagielski Phonetic entry 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski @param aLocale 114*b1cdbd2cSJim Jagielski Language attribute for index and phonetic entry. <br/> 115*b1cdbd2cSJim Jagielski aLocale and the locale in loadAlgorithm may be different. 116*b1cdbd2cSJim Jagielski In the case they are different, phonetic entry will not 117*b1cdbd2cSJim Jagielski be used in the index key generation. 118*b1cdbd2cSJim Jagielski */ 119*b1cdbd2cSJim Jagielski string getIndexKey( [in] string aIndexEntry, [in] string aPhoneticEntry, 120*b1cdbd2cSJim Jagielski [in] com::sun::star::lang::Locale aLocale ); 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 123*b1cdbd2cSJim Jagielski /** 124*b1cdbd2cSJim Jagielski Compares index entries 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski <p> Note that loadAlgorithm should be called before calling 127*b1cdbd2cSJim Jagielski this function. </p> 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski @param aIndexEntry1 130*b1cdbd2cSJim Jagielski @param aIndexEntry2 131*b1cdbd2cSJim Jagielski Index entries to be compared 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski @param aPhoneticEntry1 134*b1cdbd2cSJim Jagielski @param aPhoneticEntry2 135*b1cdbd2cSJim Jagielski Phonetic entries to be compared 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski @param aLocale1 138*b1cdbd2cSJim Jagielski @param aLocale2 139*b1cdbd2cSJim Jagielski Language attribute for index and phonetic entry. <br/> 140*b1cdbd2cSJim Jagielski aLocale and the locale in loadAlgorithm may be different. 141*b1cdbd2cSJim Jagielski In the case they are different, phonetic entry will not 142*b1cdbd2cSJim Jagielski be used in the index key generation. 143*b1cdbd2cSJim Jagielski */ 144*b1cdbd2cSJim Jagielski short compareIndexEntry( [in] string aIndexEntry1, [in] string aPhoneticEntry1, 145*b1cdbd2cSJim Jagielski [in] com::sun::star::lang::Locale aLocale1, 146*b1cdbd2cSJim Jagielski [in] string aIndexEntry2, [in] string aPhoneticEntry2, 147*b1cdbd2cSJim Jagielski [in] com::sun::star::lang::Locale aLocale2 ); 148*b1cdbd2cSJim Jagielski}; 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski//============================================================================= 151*b1cdbd2cSJim Jagielski}; }; }; }; 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski#endif 154