LibreOffice
LibreOffice 24.2 SDK API Reference
XAccessibleTable.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 module com { module sun { module star { module accessibility {
21 
22  interface XAccessible;
23 
52 {
63 
74 
91  string getAccessibleRowDescription ([in] long nRow)
93 
109  string getAccessibleColumnDescription ([in] long nColumn)
111 
134  long getAccessibleRowExtentAt ([in] long nRow, [in] long nColumn)
136 
159  long getAccessibleColumnExtentAt ([in] long nRow, [in] long nColumn)
161 
173 
185 
194  sequence<long> getSelectedAccessibleRows ();
195 
204  sequence<long> getSelectedAccessibleColumns ();
205 
221  boolean isAccessibleRowSelected ([in] long nRow)
223 
240  boolean isAccessibleColumnSelected ([in] long nColumn)
242 
270  XAccessible getAccessibleCellAt ([in] long nRow, [in] long nColumn)
272 
280 
289 
306  boolean isAccessibleSelected ([in] long nRow, [in] long nColumn)
308 
328  hyper getAccessibleIndex ([in] long nRow, [in] long nColumn)
330 
345  long getAccessibleRow ([in] hyper nChildIndex)
347 
363  long getAccessibleColumn ([in] hyper nChildIndex)
365 };
366 
367 }; }; }; };
368 
369 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:31
Implement this interface to give access to a two-dimensional table.
Definition: XAccessibleTable.idl:52
sequence< long > getSelectedAccessibleRows()
Returns a list of the indices of completely selected rows in a table.
long getAccessibleRow([in] hyper nChildIndex)
Translate the given child index into the corresponding row index.
XAccessibleTable getAccessibleColumnHeaders()
Returns the column headers as an XAccessibleTable object.
XAccessible getAccessibleCellAt([in] long nRow, [in] long nColumn)
Returns the XAccessible object at the specified row and column in the table.
long getAccessibleColumnExtentAt([in] long nRow, [in] long nColumn)
Returns the number of columns occupied by the Accessible at the specified row and column in the table...
XAccessibleTable getAccessibleRowHeaders()
Returns the row headers as an XAccessibleTable object.
boolean isAccessibleColumnSelected([in] long nColumn)
Returns a boolean value indicating whether the specified column is completely selected.
long getAccessibleColumn([in] hyper nChildIndex)
Translate the given child index into the corresponding column index.
string getAccessibleColumnDescription([in] long nColumn)
Returns the description text of the specified column in the table.
long getAccessibleRowCount()
Returns the number of used rows in the table.
long getAccessibleRowExtentAt([in] long nRow, [in] long nColumn)
Returns the number of rows occupied by the Accessible at the specified row and column in the table.
long getAccessibleColumnCount()
Returns the number of used columns in the table.
boolean isAccessibleSelected([in] long nRow, [in] long nColumn)
Returns a boolean value indicating whether the accessible at the specified row and column is selected...
sequence< long > getSelectedAccessibleColumns()
Returns a list of the indices of completely selected columns in a table.
string getAccessibleRowDescription([in] long nRow)
Returns the description text of the specified row in the table.
XAccessible getAccessibleCaption()
Returns the caption for the table.
hyper getAccessibleIndex([in] long nRow, [in] long nColumn)
Returns the child index of the accessible object that spans the specified cell.
boolean isAccessibleRowSelected([in] long nRow)
Returns a boolean value indicating whether the specified row is completely selected.
XAccessible getAccessibleSummary()
Returns the summary description of the table.
This interface has to be implemented by any class that wants to be accessible.
Definition: XAccessible.idl:50
base interface of all UNO interfaces
Definition: XInterface.idl:46
Definition: Ambiguous.idl:20