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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XSimpleText.idl,v $
* $Revision: 1.13 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_text_XSimpleText_idl__
#define __com_sun_star_text_XSimplText_idl__
#ifndef __com_sun_star_text_XTextRange_idl__
#include <com/sun/star/text/XTextRange.idl>
#endif
#ifndef __com_sun_star_text_XTextCursor_idl__
#include <com/sun/star/text/XTextCursor.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_text_XTextContent_idl__
#include <com/sun/star/text/XTextContent.idl>
#endif
#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif
//=============================================================================
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 <type>TextCursor</type> 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 <type>TextCursor</type> which is located
at the specified <type>TextRange</type> 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
<type>TextCursor</type>.
@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 <type>XTextRange</type> for this argument.
<p>If the parameter <member>bAbsorb</member> 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>
*/
[oneway] 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
|
