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

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