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