1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_DocumentIndexMark_idl__
28#define __com_sun_star_text_DocumentIndexMark_idl__
29
30#ifndef __com_sun_star_text_TextContent_idl__
31#include <com/sun/star/text/TextContent.idl>
32#endif
33#ifndef __com_sun_star_text_BaseIndexMark_idl__
34#include <com/sun/star/text/BaseIndexMark.idl>
35#endif
36
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module text {
41
42//=============================================================================
43
44/** is a <type>TextRange</type> which is explicitly marked
45	as an index entry for a <type>DocumentIndex</type>.
46 */
47published service DocumentIndexMark
48{
49	service com::sun::star::text::TextContent;
50
51	service com::sun::star::text::BaseIndexMark;
52
53	//-------------------------------------------------------------------------
54	/** contains the primary key of the index entry.
55	 	It is used to build a hierarchical document index.
56	 */
57	[property] string PrimaryKey;
58	//-------------------------------------------------------------------------
59	/** contains the secondary key of the index entry.
60	 	It is used to build a hierarchical document index.
61	 */
62	[property] string SecondaryKey;
63	//-------------------------------------------------------------------------
64	/** determins if this entry is a main entry. In a document index this entry will
65		be emphasized by assigning a character style to it.
66	 */
67	[property] boolean IsMainEntry;
68};
69
70//=============================================================================
71
72}; }; }; };
73#endif
74