/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XIndexEntrySupplier.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 01:56:48 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_i18n_XIndexEntrySupplier_idl__
#define __com_sun_star_i18n_XIndexEntrySupplier_idl__

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

//============================================================================

module com { module sun { module star { module i18n {

//============================================================================

/**
    supplies information on index entries to generate a "table of
    alphabetical index" for a given locale.
*/

published interface XIndexEntrySupplier : com::sun::star::uno::XInterface
{
    //------------------------------------------------------------------------
    /**
        returns the capital index key for sorting a table of indexes, to
        a given index entry, to a given <type
        scope="com::sun::star::lang">Locale</type> and to a given sort
        algorithm.

        <p> For example, in English locale it returns <b>"K"</b> for
        "keyboard"
     */
    string getIndexCharacter( [in] string aIndexEntry, [in]
    com::sun::star::lang::Locale aLocale, [in] string aSortAlgorithm );

    //------------------------------------------------------------------------
    /**
        returns the page number word of an index entry, where one page
        or more pages are combined to one page number entry, for a given
        <type scope="com::sun::star::lang">Locale</type>.

        <p> For example, in English locale it returns <br/>
        <b>"p."</b>  for <em>bMorePages</em> == <FALSE/> <br/>
        <b>"pp."</b> for <em>bMorePages</em> == <TRUE/> </p>
    */
    string getIndexFollowPageWord( [in] boolean bMorePages,
                                   [in] com::sun::star::lang::Locale aLocale );
};

//============================================================================
};};};};
//============================================================================
#endif

