/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DocumentIndexMark.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 06:10:23 $
 *
 *  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_DocumentIndexMark_idl__
#define __com_sun_star_text_DocumentIndexMark_idl__

#ifndef __com_sun_star_text_TextContent_idl__
#include <com/sun/star/text/TextContent.idl>
#endif
#ifndef __com_sun_star_text_BaseIndexMark_idl__
#include <com/sun/star/text/BaseIndexMark.idl>
#endif


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

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

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

/** is a <type>TextRange</type> which is explicitly marked
	as an index entry for a <type>DocumentIndex</type>.
 */
published service DocumentIndexMark
{
	service com::sun::star::text::TextContent;

	service com::sun::star::text::BaseIndexMark;

	//-------------------------------------------------------------------------
	/** contains the primary key of the index entry.
	 	It is used to build a hierarchical document index.
	 */
	[property] string PrimaryKey;
	//-------------------------------------------------------------------------
	/** contains the secondary key of the index entry.
	 	It is used to build a hierarchical document index.
	 */
	[property] string SecondaryKey;
	//-------------------------------------------------------------------------
	/** determins if this entry is a main entry. In a document index this entry will
		be emphasized by assigning a character style to it.
	 */
	[property] boolean IsMainEntry;
};

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

}; }; }; };
#endif
