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