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