blob: 42d2414ed8137f3ffd135b126ebf1f68c32a16d1 (
plain)
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_accessibility_XAccessibleMultiLineText_idl__
#define __com_sun_star_accessibility_XAccessibleMultiLineText_idl__
#ifndef __com_sun_star_accessibility_XAccessibleText_idl__
#include <com/sun/star/accessibility/XAccessibleText.idl>
#endif
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif
#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif
module com { module sun { module star { module accessibility {
/** Implement this interface to give provide a mapping between text index
and line numbers.
<p>This interface is typically used in conjunction with the
<type>XAccessibleText</type> interface and extents it with a notion
of line numbers</p>
@since OOo 3.0.0
*/
/// not yet published
interface XAccessibleMultiLineText
: ::com::sun::star::accessibility::XAccessibleText
{
/** Returns the line number at the specified index.
<p>For a text object that is spread over multiple lines, this method
provides a mapping from a text index to the corresponding line number.
</p>
@param nIndex
Index for which the line number should be returned.
The valid range is 0..length.
@return
Returns the line number of the specified text index.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the index is invalid.
*/
long getLineNumberAtIndex([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the text of the specified line.
<p>Returns the substring of text that makes up the specified line
number.</p>
<p>The number of lines can be obtained by calling
<member>XAccessibleMultiLineText::getLineNumberAtIndex</member>
with the index of the last character. In a loop, the last line
has been reached when <member>TextSegment::SegmentEnd</member>
of the returned value is equal to the index of the last
character of the text.</p>
@param nLineNo
The number of the line to return the substring from.
The valid range is 0..getLineNumberAtIndex(getCharacterCount()).
@return
Returns the requested text portion. This portion may be empty
or invalid when no appropriate text portion is found.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the line number is invalid
*/
TextSegment getTextAtLineNumber([in] long nLineNo)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the text of the line in which the caret is located.
<p>The substring returned will most of the time be identical to
calling <member>XAccessibleText::getTextAtIndex</member> with
the index returned by <member>XAccessibleText::getCaretPosition</member>
and type <const scope="AccessibleTextType">LINE</type> beside the
following special case:</p>
<p>Some text implementations place the caret at the end of the current
line when the <b>End</b> key gets pressed. Since the index of this position
is identical to the one of the first character of the following line,
<member>XAccessibleMultiLineText::getLineNumberAtIndex</member> will
return the line following the current one in this case.</p>
@return
Returns the requested text portion. This portion may be empty
or invalid if the paragraph object does not have a valid caret
position.
*/
TextSegment getTextAtLineWithCaret();
/** Returns the number of the line in which the caret is located.
<p>The line number returned will most of the time be identical to
calling <member>XAccessibleMultiLineText::getLineNumberAtIndex</member>
with the index returned by <member>XAccessibleText::getCaretPosition</member>
beside the following special case:</p>
<p>Some text implementations place the caret at the end of the current
line when the <b>End</b> key gets pressed. Since the index of this position
is identical to the one of the first character of the following line,
<member>XAccessibleMultiLineText::getLineNumberAtIndex</member> will
return the line following the current one in this case.</p>
@return
Returns the index of the line in which the caret is located or -1
if the paragraph does not have a valid caret position.
*/
long getNumberOfLineWithCaret();
};
}; }; }; };
#endif
|
