/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DocumentIndex.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:09:38 $
 *
 *  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_text_DocumentIndex_idl__
#define __com_sun_star_text_DocumentIndex_idl__

#include <com/sun/star/text/BaseIndex.idl>
#ifndef __com_sun_star_text_XDocumentIndexMark_idl__
#include <com/sun/star/text/XDocumentIndexMark.idl>
#endif

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

module com {  module sun {  module star {  module text {

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

/** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
 */
published service DocumentIndex
{
    service  com::sun::star::text::BaseIndex;

    /** determins if alphabetical separators are genererated.
     */
    [optional, property] boolean UseAlphabeticalSeparators;

    /** determins if a index entry is generated for each primary/secondary key.
     */
    [optional, property] boolean UseKeyAsEntry;

    /** determins if same entries on different pages are combined into one index entry.
     */
    [optional, property] boolean UseCombinedEntries;

    /** determins if the similarity of index entries is checked case sensitively.
     */
    [optional, property] boolean IsCaseSensitive;

    /** determins if following page numbers are displayed using a 'pp.'.
     */
    [optional, property] boolean UsePP;

    /** determins if if following page numbers are displayed using a dash.
     */
    [optional, property] boolean UseDash;

    /** determins if all entries start with a capital letter.
     */
    [optional, property] boolean UseUpperCase;

    /** determins the name of the character style that is applied to the number
     of a page where main index entry is located.
     */
    [optional, property] string MainEntryCharacterStyleName;

    /**
     contains all index marks that are related to this index.
     */
    [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;

    //------------------------------------------------------------------------
    /** contains the locale of the index.
     */
    [property] com::sun::star::lang::Locale  Locale;

    //------------------------------------------------------------------------
    /** contains the name of the sort algorithm that is used to sort the entries.
     */
    [property] string SortAlgorithm;
};

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

}; }; }; };

#endif
