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_XDocumentIndexMark_idl__
28#define __com_sun_star_text_XDocumentIndexMark_idl__
29
30#ifndef __com_sun_star_text_XTextContent_idl__
31#include <com/sun/star/text/XTextContent.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module text {
38
39//=============================================================================
40
41// DocMerge from xml: interface com::sun::star::text::XDocumentIndexMark
42/** gives access to the mark of a document index entry.@see DocumentIndexMark
43 */
44published interface XDocumentIndexMark: com::sun::star::text::XTextContent
45{
46	//-------------------------------------------------------------------------
47
48	// DocMerge from idl: method com::sun::star::text::XDocumentIndexMark::getMarkEntry
49	/** @returns
50				the explicitly set string for the index mark.
51
52		 @see setMarkEntry
53	 */
54	string getMarkEntry();
55
56	//-------------------------------------------------------------------------
57
58	// DocMerge from xml: method com::sun::star::text::XDocumentIndexMark::setMarkEntry
59	/** sets an explicit string for this index mark to use
60		in the index.
61
62
63
64		<p>If empty, the string of the <type>TextRange</type> to which
65		the <type>TextContent</type> refers is used in the index.</p>
66	 */
67	void setMarkEntry( [in] string aIndexEntry );
68
69};
70
71//=============================================================================
72
73}; }; }; };
74
75
76#endif
77