1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_text_XSimpleText_idl__
#define __com_sun_star_text_XSimpleText_idl__
#include <com/sun/star/text/XTextRange.idl>
#include <com/sun/star/text/XTextCursor.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/text/XTextContent.idl>
#include <com/sun/star/container/NoSuchElementException.idl>
module com { module sun { module star { module text {
/** is the main interface for a distinct text unit, i.e. the main text of
a document, the text for headers and footers or for single cells of a
table.@see XText
*/
published interface XSimpleText: com::sun::star::text::XTextRange
{
/** @returns
a new instance of a TextCursor service which can
be used to travel in the given text context.
@see com::sun::star::text::TextCursor
*/
com::sun::star::text::XTextCursor createTextCursor();
/** @returns
a new instance of a TextCursor which is located
at the specified TextRange to travel in the
given text context.
<p>The initial position is set to <var>aTextPosition</var>.
@param aTextPosition
specifies the start position for the new
TextCursor.
@see com::sun::star::text::TextCursor
*/
com::sun::star::text::XTextCursor createTextCursorByRange( [in] com::sun::star::text::XTextRange aTextPosition );
/** inserts a string of characters into the text.
<p>The string may contain the following white spaces:
</p>
<ul>
<li>blank</li>
<li>tab</li>
<li>cr (which will insert a paragraph break)</li>
<li>lf (which will insert a line break)</li>
</ul>
@param xRange
specifies the position of insertion. For example,
<method>XSimpleText::createTextCursor</member> can be used to
get an XTextRange for this argument.
<p>If the parameter bAbsorb() was <TRUE/>
the text range will contain the new inserted string, otherwise
the range (and it's text) will remain unchanged.
@param aString
specifies the string to insert.
@param bAbsorb
specifies whether the text spanned by <var>xRange</var> will be
replaced. If <TRUE/> then the content of <var>xRange</var> will
be replaced by <var>aString</var>, otherwise <var>aString</var>
will be inserted at the beginning of <var>xRange</var>.
@example
<listing>
xText.insertString( xTextCursor, "Hello " + aName$ + ",", false )
xText.insertControlCharacter( xTextCursor,
ControlCharacter_PARAGRAPH_BREAK, false );
xText.insertString( xTextCursor, "more text ...", false )
</listing>
*/
void insertString( [in] com::sun::star::text::XTextRange xRange,
[in] string aString,
[in] boolean bAbsorb );
/** inserts a control character (like a paragraph break or a hard
space) into the text.@see com::sun::star::text::ControlCharacter
*/
void insertControlCharacter( [in] com::sun::star::text::XTextRange xRange,
[in] short nControlCharacter,
[in] boolean bAbsorb )
raises( com::sun::star::lang::IllegalArgumentException );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
