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_BaseIndexMark_idl__
24#define __com_sun_star_text_BaseIndexMark_idl__
25
26#ifndef __com_sun_star_text_TextContent_idl__
27#include <com/sun/star/text/TextContent.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module text {
34
35//=============================================================================
36
37/** is a <type>TextRange</type> which is explicitly marked
38	as an index entry. This is the base service of index marks for <type>DocumentIndex</type>,
39 	<type>ContentIndex</type>, and <type>UserIndex</type>.
40 */
41published service BaseIndexMark
42{
43	service com::sun::star::text::TextContent;
44	//-------------------------------------------------------------------------
45
46	/**	the string that will be inserted into the corresponding index. If AlternativeText is empty then
47		the string that is marked by the TextRange is inserted into the index.
48	 */
49	[property] string AlternativeText;
50};
51
52//=============================================================================
53
54}; }; }; };
55#endif
56
57
58