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