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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_i18n_XIndexEntrySupplier_idl__
  20 #define __com_sun_star_i18n_XIndexEntrySupplier_idl__
  21
  22 #include <com/sun/star/lang/Locale.idl>
  23
  24
  25 module com { module sun { module star { module i18n {
  26
  27
  28 /**
  29     supplies information on index entries to generate a "table of
  30     alphabetical index" for a given locale.
  31 */
  32
  33 published interface XIndexEntrySupplier : com::sun::star::uno::XInterface
  34 {
  35     /**
  36         returns the capital index key for sorting a table of indexes, to
  37         a given index entry, to a given com::sun::star::lang::Locale and to a
  38         given sort algorithm.
  39
  40         <p> For example, in English locale it returns <b>"K"</b> for
  41         "keyboard"
  42      */
  43     string getIndexCharacter( [in] string aIndexEntry, [in]
  44     com::sun::star::lang::Locale aLocale, [in] string aSortAlgorithm );
  45
  46     /**
  47         returns the page number word of an index entry, where one page
  48         or more pages are combined to one page number entry, for a given
  49         com::sun::star::lang::Locale.
  50
  51         <p> For example, in English locale it returns <br/>
  52         <b>"p."</b>  for <em>bMorePages</em> == `FALSE` <br/>
  53         <b>"pp."</b> for <em>bMorePages</em> == `TRUE` </p>
  54     */
  55     string getIndexFollowPageWord( [in] boolean bMorePages,
  56                                    [in] com::sun::star::lang::Locale aLocale );
  57 };
  58
  59 };};};};
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */