xref: /AOO41X/main/offapi/com/sun/star/text/XTextRange.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextRange_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_XTextRange_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir//=============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweir module com {  module sun {  module star {  module text {
33cdf0e10cSrcweir
34cdf0e10cSrcweir published interface XText;
35cdf0e10cSrcweir
36cdf0e10cSrcweir//=============================================================================
37cdf0e10cSrcweir
38cdf0e10cSrcweir// DocMerge from xml: interface com::sun::star::text::XTextRange
39cdf0e10cSrcweir/** describes the object's position in a text.
40cdf0e10cSrcweir
41cdf0e10cSrcweir
42cdf0e10cSrcweir
43cdf0e10cSrcweir	<p>It represents a text range. The beginning and end of the range may
44cdf0e10cSrcweir	be identical.
45cdf0e10cSrcweir	</p>
46cdf0e10cSrcweir */
47cdf0e10cSrcweirpublished interface XTextRange: com::sun::star::uno::XInterface
48cdf0e10cSrcweir{
49cdf0e10cSrcweir	//-------------------------------------------------------------------------
50cdf0e10cSrcweir
51cdf0e10cSrcweir	// DocMerge from idl: method com::sun::star::text::XTextRange::getText
52cdf0e10cSrcweir	/** @returns
53cdf0e10cSrcweir				the text interface in which the text position is contained.
54cdf0e10cSrcweir	 */
55cdf0e10cSrcweir	XText getText();
56cdf0e10cSrcweir
57cdf0e10cSrcweir	//-------------------------------------------------------------------------
58cdf0e10cSrcweir
59cdf0e10cSrcweir	// DocMerge from idl: method com::sun::star::text::XTextRange::getStart
60cdf0e10cSrcweir	/** @returns
61cdf0e10cSrcweir				a text range which contains only the start of this text range.
62cdf0e10cSrcweir	 */
63cdf0e10cSrcweir	XTextRange getStart();
64cdf0e10cSrcweir
65cdf0e10cSrcweir	//-------------------------------------------------------------------------
66cdf0e10cSrcweir
67cdf0e10cSrcweir	// DocMerge from idl: method com::sun::star::text::XTextRange::getEnd
68cdf0e10cSrcweir	/** @returns
69cdf0e10cSrcweir				a text range which contains only the end of this text range.
70cdf0e10cSrcweir	 */
71cdf0e10cSrcweir	XTextRange getEnd();
72cdf0e10cSrcweir
73cdf0e10cSrcweir	//-------------------------------------------------------------------------
74cdf0e10cSrcweir
75cdf0e10cSrcweir	// DocMerge from idl: method com::sun::star::text::XTextRange::getString
76cdf0e10cSrcweir	/** @returns
77cdf0e10cSrcweir			 	the string that is included in this text range.
78cdf0e10cSrcweir	 */
79cdf0e10cSrcweir	string getString();
80cdf0e10cSrcweir
81cdf0e10cSrcweir	//-------------------------------------------------------------------------
82cdf0e10cSrcweir
83cdf0e10cSrcweir	// DocMerge from xml: method com::sun::star::text::XTextRange::setString
84cdf0e10cSrcweir	/** the whole string of characters of this piece of text is replaced.
85cdf0e10cSrcweir
86cdf0e10cSrcweir
87cdf0e10cSrcweir
88cdf0e10cSrcweir		<p>All styles are removed when applying this method.
89cdf0e10cSrcweir
90cdf0e10cSrcweir		</p>
91cdf0e10cSrcweir	 */
92cdf0e10cSrcweir	[oneway] void setString( [in] string aString );
93cdf0e10cSrcweir
94cdf0e10cSrcweir};
95cdf0e10cSrcweir
96cdf0e10cSrcweir//=============================================================================
97cdf0e10cSrcweir
98cdf0e10cSrcweir}; }; }; };
99cdf0e10cSrcweir
100cdf0e10cSrcweir#endif
101