xref: /AOO41X/main/offapi/com/sun/star/text/XTextRange.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_XTextRange_idl__
28#define __com_sun_star_text_XTextRange_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module text {
37
38 published interface XText;
39
40//=============================================================================
41
42// DocMerge from xml: interface com::sun::star::text::XTextRange
43/** describes the object's position in a text.
44
45
46
47	<p>It represents a text range. The beginning and end of the range may
48	be identical.
49	</p>
50 */
51published interface XTextRange: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54
55	// DocMerge from idl: method com::sun::star::text::XTextRange::getText
56	/** @returns
57				the text interface in which the text position is contained.
58	 */
59	XText getText();
60
61	//-------------------------------------------------------------------------
62
63	// DocMerge from idl: method com::sun::star::text::XTextRange::getStart
64	/** @returns
65				a text range which contains only the start of this text range.
66	 */
67	XTextRange getStart();
68
69	//-------------------------------------------------------------------------
70
71	// DocMerge from idl: method com::sun::star::text::XTextRange::getEnd
72	/** @returns
73				a text range which contains only the end of this text range.
74	 */
75	XTextRange getEnd();
76
77	//-------------------------------------------------------------------------
78
79	// DocMerge from idl: method com::sun::star::text::XTextRange::getString
80	/** @returns
81			 	the string that is included in this text range.
82	 */
83	string getString();
84
85	//-------------------------------------------------------------------------
86
87	// DocMerge from xml: method com::sun::star::text::XTextRange::setString
88	/** the whole string of characters of this piece of text is replaced.
89
90
91
92		<p>All styles are removed when applying this method.
93
94		</p>
95	 */
96	[oneway] void setString( [in] string aString );
97
98};
99
100//=============================================================================
101
102}; }; }; };
103
104#endif
105