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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
/* -*- 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 .
*/
module com { module sun { module star { module accessibility {
interface XAccessible;
/** Implement this interface to give access to a two-dimensional table.
<p>The XAccessibleTable interface is used to represent
two-dimensional tables. This interface combines the two interfaces
<code>javax.accessibility.AccessibleTable</code> and
<code>javax.accessibility.AccessibleExtendedTable</code> of the Java Accessibility API
(version 1.4).</p>
<p>All XAccessible objects that represent cells or
cell-clusters of a table have to be at the same time children of the
table. This is necessary to be able to convert row and column indices
into child indices and vice versa with the methods
XAccessibleTable::getAccessibleIndex(),
XAccessibleTable::getAccessibleRow(), and
XAccessibleTable::getAccessibleColumn().</p>
<p>The range of valid coordinates for this interface are implementation
dependent. However, that range includes at least the intervals
from the first row or column with the index 0 up to the last (but not
including) used row or column as returned by
XAccessibleTable::getAccessibleRowCount() and
XAccessibleTable::getAccessibleColumnCount(). In case of
Calc the current range of valid indices for retrieving data include
the maximum table size minus one.</p>
@since OOo 1.1.2
*/
interface XAccessibleTable : ::com::sun::star::uno::XInterface
{
/** Returns the number of used rows in the table.
<p>The implementation, however, may allow the access of columns
beyond this number.</p>
@return
Returns the number of used rows in the table or 0 for an empty
table.
*/
long getAccessibleRowCount ();
/** Returns the number of used columns in the table.
<p>The implementation, however, may allow the access of columns
beyond this number.</p>
@return
Returns the number of used columns in the table or 0 for an empty
table.
*/
long getAccessibleColumnCount ();
/** Returns the description text of the specified row in the
table.
@param nRow
The index of the row for which to retrieve the description.
@return
Returns the description text of the specified row in the table
if such a description exists. Otherwise an empty string is
returned.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside
the valid range of 0 up to
XAccessibleTable::getAccessibleRowCount() - 1.
*/
string getAccessibleRowDescription ([in] long nRow)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the description text of the specified column in the
table.
@param nColumn
The index of the column for which to retrieve the description.
@return
Returns the description text of the specified row in the table
if such a description exists. Otherwise an empty string is
returned.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside
the valid range of 0 up to
XAccessibleTable::getAccessibleColumnCount() - 1.
*/
string getAccessibleColumnDescription ([in] long nColumn)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the number of rows occupied by the Accessible at the
specified row and column in the table.
<p>The result differs from 1 if the specified cell spans multiple
rows.</p>
@param nRow
Row index of the accessible for which to return the column
extent.
@param nColumn
Column index of the accessible for which to return the column
extent.
@return
Returns the row extent of the specified cell.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside
the valid range of 0 up to
XAccessibleTable::getAccessibleRowCount() - 1.
*/
long getAccessibleRowExtentAt ([in] long nRow, [in] long nColumn)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the number of columns occupied by the Accessible at the
specified row and column in the table.
<p>The result differs from 1 if the specified cell spans multiple
columns.</p>
@param nRow
Row index of the accessible for which to return the column
extent.
@param nColumn
Column index of the accessible for which to return the column
extent.
@return
Returns the column extent of the specified.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside
the valid range of 0 up to
XAccessibleTable::getAccessibleColumnCount() - 1.
*/
long getAccessibleColumnExtentAt ([in] long nRow, [in] long nColumn)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the row headers as an XAccessibleTable
object.
<p>Content and size of the returned table are implementation
dependent.</p>
@return
Returns always a valid reference to an
XAccessibleTable object.
*/
XAccessibleTable getAccessibleRowHeaders ();
/** Returns the column headers as an XAccessibleTable
object.
<p>Content and size of the returned table are implementation
dependent.</p>
@return
Returns always a valid reference to an
XAccessibleTable object.
*/
XAccessibleTable getAccessibleColumnHeaders ();
/** Returns a list of the indices of completely selected rows in a
table.
@return
The returned sequence contains indices of all completely
selected rows in the table. This sequence is in ascending
order. If no row is selected then the sequence is empty.
*/
sequence<long> getSelectedAccessibleRows ();
/** Returns a list of the indices of completely selected columns in a
table.
@return
The returned sequence contains indices of all completely
selected columns in the table. This sequence is in ascending
order. If no column is selected then the sequence is empty.
*/
sequence<long> getSelectedAccessibleColumns ();
/** Returns a boolean value indicating whether the specified row is
completely selected.
@param nRow
Index of the row for which to determine whether it is selected.
@return
Returns `TRUE` if the specified row is selected completely and
`FALSE` otherwise.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified row index is not valid, i.e. lies not inside
the valid range of 0 up to
XAccessibleTable::getAccessibleRowCount() - 1.
*/
boolean isAccessibleRowSelected ([in] long nRow)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns a boolean value indicating whether the specified column
is completely selected.
@param nColumn
Index of the column for which to determine whether it is
selected.
@return
Returns `TRUE` if the specified column is selected completely
and `FALSE` otherwise.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column index is not valid, i.e. lies not inside
the valid range of 0 up to
XAccessibleTable::getAccessibleColumnCount() - 1.
*/
boolean isAccessibleColumnSelected ([in] long nColumn)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the XAccessible object at the specified row
and column in the table.
<p>This method has been renamed from the Java name
<code>getAccessibleAt</code> to
XAccessibleTable::getAccessibleCellAt() to avoid
ambiguities with the
XAccessibleComponent::getAccessibleAt() method when
accessed, for instance, from StarBasic.</p>
@param nRow
The row index for which to retrieve the cell.
@param nColumn
The column index for which to retrieve the cell.
@return
If both row and column index are valid then the corresponding
XAccessible object is returned that represents the
requested cell regardless of whether the cell is currently
visible (on the screen).
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the specified column and/or row index is not valid, i.e. lies not inside
the valid range of 0 up to
XAccessibleTable::getAccessibleColumnCount() - 1.
*/
XAccessible getAccessibleCellAt ([in] long nRow, [in] long nColumn)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the caption for the table.
@return
If the table has a caption then a reference to it is returned,
else an empty reference is returned.
*/
XAccessible getAccessibleCaption ();
/** Returns the summary description of the table.
@return
Returns a reference to an implementation dependent
XAccessible object representing the table's summary
or an empty reference if the table does not support a summary.
*/
XAccessible getAccessibleSummary ();
/** Returns a boolean value indicating whether the accessible at the
specified row and column is selected.
@param nRow
Row index of the cell for which to determine if the accessible
object that spans that cell is selected.
@param nColumn
Column index of the cell for which to determine if the
accessible object that spans that cell is selected.
@return
Returns `TRUE` if the given row and column indices are valid
and the specified accessible object is selected. Otherwise
`FALSE` is returned.
*/
boolean isAccessibleSelected ([in] long nRow, [in] long nColumn)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the child index of the accessible object that spans the
specified cell.
<p>This is the same index that would be returned by calling
XAccessibleContext::getAccessibleIndexInParent() for
that accessible object.</p>
@param nRow
Row index of the accessible object for which to return the child
index.
@param nColumn
Row index of the accessible object for which to return the child
index.
@return
Child index of the specified accessible object or -1 if one or
both of the given indices is/are invalid.
*/
hyper getAccessibleIndex ([in] long nRow, [in] long nColumn)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Translate the given child index into the corresponding row
index.
@param nChildIndex
Index of the child of the table for which to return the row
index.
@return
Returns the row index of the cell of the specified child or the
index of the first row if the child spans multiple rows.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if nChildIndex addresses an invalid row.
*/
long getAccessibleRow ([in] hyper nChildIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Translate the given child index into the corresponding column
index.
@param nChildIndex
Index of the child of the table for which to return the column
index.
@return
Returns the column index of the cell of the specified child or
the index of the first column if the child spans multiple
columns.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if nChildIndex addresses an invalid column.
*/
long getAccessibleColumn ([in] hyper nChildIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
