offapi/com/sun/star/i18n/XIndexEntrySupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_i18n_XIndexEntrySupplier_idl__
  28 #define __com_sun_star_i18n_XIndexEntrySupplier_idl__
  29
  30 #ifndef __com_sun_star_lang_Locale_idl__
  31 #include <com/sun/star/lang/Locale.idl>
  32 #endif
  33
  34 //============================================================================
  35
  36 module com { module sun { module star { module i18n {
  37
  38 //============================================================================
  39
  40 /**
  41     supplies information on index entries to generate a "table of
  42     alphabetical index" for a given locale.
  43 */
  44
  45 published interface XIndexEntrySupplier : com::sun::star::uno::XInterface
  46 {
  47     //------------------------------------------------------------------------
  48     /**
  49         returns the capital index key for sorting a table of indexes, to
  50         a given index entry, to a given <type
  51         scope="com::sun::star::lang">Locale</type> and to a given sort
  52         algorithm.
  53
  54         <p> For example, in English locale it returns <b>"K"</b> for
  55         "keyboard"
  56      */
  57     string getIndexCharacter( [in] string aIndexEntry, [in]
  58     com::sun::star::lang::Locale aLocale, [in] string aSortAlgorithm );
  59
  60     //------------------------------------------------------------------------
  61     /**
  62         returns the page number word of an index entry, where one page
  63         or more pages are combined to one page number entry, for a given
  64         <type scope="com::sun::star::lang">Locale</type>.
  65
  66         <p> For example, in English locale it returns <br/>
  67         <b>"p."</b>  for <em>bMorePages</em> == <FALSE/> <br/>
  68         <b>"pp."</b> for <em>bMorePages</em> == <TRUE/> </p>
  69     */
  70     string getIndexFollowPageWord( [in] boolean bMorePages,
  71                                    [in] com::sun::star::lang::Locale aLocale );
  72 };
  73
  74 //============================================================================
  75 };};};};
  76
  77 #endif
  78