/*************************************************************************
 *
 *  $RCSfile: DocumentIndex.idl,v $
 *
 *  $Revision: 1.5.14.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:50:53 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/


#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
 */
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
