1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_DocumentIndexMark_idl__
24#define __com_sun_star_text_DocumentIndexMark_idl__
25
26#ifndef __com_sun_star_text_TextContent_idl__
27#include <com/sun/star/text/TextContent.idl>
28#endif
29#ifndef __com_sun_star_text_BaseIndexMark_idl__
30#include <com/sun/star/text/BaseIndexMark.idl>
31#endif
32
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module text {
37
38//=============================================================================
39
40/** is a <type>TextRange</type> which is explicitly marked
41	as an index entry for a <type>DocumentIndex</type>.
42 */
43published service DocumentIndexMark
44{
45	service com::sun::star::text::TextContent;
46
47	service com::sun::star::text::BaseIndexMark;
48
49	//-------------------------------------------------------------------------
50	/** contains the primary key of the index entry.
51	 	It is used to build a hierarchical document index.
52	 */
53	[property] string PrimaryKey;
54	//-------------------------------------------------------------------------
55	/** contains the secondary key of the index entry.
56	 	It is used to build a hierarchical document index.
57	 */
58	[property] string SecondaryKey;
59	//-------------------------------------------------------------------------
60	/** determins if this entry is a main entry. In a document index this entry will
61		be emphasized by assigning a character style to it.
62	 */
63	[property] boolean IsMainEntry;
64};
65
66//=============================================================================
67
68}; }; }; };
69#endif
70