1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_i18n_XIndexEntrySupplier_idl__ 24cdf0e10cSrcweir#define __com_sun_star_i18n_XIndexEntrySupplier_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_lang_Locale_idl__ 27cdf0e10cSrcweir#include <com/sun/star/lang/Locale.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================ 31cdf0e10cSrcweir 32cdf0e10cSrcweirmodule com { module sun { module star { module i18n { 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================ 35cdf0e10cSrcweir 36cdf0e10cSrcweir/** 37cdf0e10cSrcweir supplies information on index entries to generate a "table of 38cdf0e10cSrcweir alphabetical index" for a given locale. 39cdf0e10cSrcweir*/ 40cdf0e10cSrcweir 41cdf0e10cSrcweirpublished interface XIndexEntrySupplier : com::sun::star::uno::XInterface 42cdf0e10cSrcweir{ 43cdf0e10cSrcweir //------------------------------------------------------------------------ 44cdf0e10cSrcweir /** 45cdf0e10cSrcweir returns the capital index key for sorting a table of indexes, to 46cdf0e10cSrcweir a given index entry, to a given <type 47cdf0e10cSrcweir scope="com::sun::star::lang">Locale</type> and to a given sort 48cdf0e10cSrcweir algorithm. 49cdf0e10cSrcweir 50cdf0e10cSrcweir <p> For example, in English locale it returns <b>"K"</b> for 51cdf0e10cSrcweir "keyboard" 52cdf0e10cSrcweir */ 53cdf0e10cSrcweir string getIndexCharacter( [in] string aIndexEntry, [in] 54cdf0e10cSrcweir com::sun::star::lang::Locale aLocale, [in] string aSortAlgorithm ); 55cdf0e10cSrcweir 56cdf0e10cSrcweir //------------------------------------------------------------------------ 57cdf0e10cSrcweir /** 58cdf0e10cSrcweir returns the page number word of an index entry, where one page 59cdf0e10cSrcweir or more pages are combined to one page number entry, for a given 60cdf0e10cSrcweir <type scope="com::sun::star::lang">Locale</type>. 61cdf0e10cSrcweir 62cdf0e10cSrcweir <p> For example, in English locale it returns <br/> 63cdf0e10cSrcweir <b>"p."</b> for <em>bMorePages</em> == <FALSE/> <br/> 64cdf0e10cSrcweir <b>"pp."</b> for <em>bMorePages</em> == <TRUE/> </p> 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir string getIndexFollowPageWord( [in] boolean bMorePages, 67cdf0e10cSrcweir [in] com::sun::star::lang::Locale aLocale ); 68cdf0e10cSrcweir}; 69cdf0e10cSrcweir 70cdf0e10cSrcweir//============================================================================ 71cdf0e10cSrcweir};};};}; 72cdf0e10cSrcweir 73cdf0e10cSrcweir#endif 74cdf0e10cSrcweir 75