2009-09-11 01:07:56 +00:00
|
|
|
/*************************************************************************
|
|
|
|
*
|
|
|
|
* File Name (AccessibleTable2.idl)
|
2013-05-19 01:21:42 +00:00
|
|
|
*
|
|
|
|
* IAccessible2 IDL Specification
|
|
|
|
*
|
|
|
|
* Copyright (c) 2007, 2012 Linux Foundation
|
|
|
|
* Copyright (c) 2006 IBM Corporation
|
|
|
|
* Copyright (c) 2000, 2006 Sun Microsystems, Inc.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
*
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
*
|
|
|
|
* 2. Redistributions in binary form must reproduce the above
|
|
|
|
* copyright notice, this list of conditions and the following
|
|
|
|
* disclaimer in the documentation and/or other materials
|
|
|
|
* provided with the distribution.
|
2009-09-11 01:07:56 +00:00
|
|
|
*
|
2013-05-19 01:21:42 +00:00
|
|
|
* 3. Neither the name of the Linux Foundation nor the names of its
|
|
|
|
* contributors may be used to endorse or promote products
|
|
|
|
* derived from this software without specific prior written
|
|
|
|
* permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
|
|
|
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
|
|
|
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
|
|
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
|
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
|
|
|
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
|
|
|
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*
|
|
|
|
* This BSD License conforms to the Open Source Initiative "Simplified
|
|
|
|
* BSD License" as published at:
|
|
|
|
* http://www.opensource.org/licenses/bsd-license.php
|
|
|
|
*
|
|
|
|
* IAccessible2 is a trademark of the Linux Foundation. The IAccessible2
|
|
|
|
* mark may be used in accordance with the Linux Foundation Trademark
|
|
|
|
* Policy to indicate compliance with the IAccessible2 specification.
|
|
|
|
*
|
|
|
|
************************************************************************/
|
2009-09-11 01:07:56 +00:00
|
|
|
|
|
|
|
import "objidl.idl";
|
|
|
|
import "oaidl.idl";
|
|
|
|
import "oleacc.idl";
|
|
|
|
import "Accessible2.idl";
|
|
|
|
import "IA2CommonTypes.idl";
|
|
|
|
|
|
|
|
/** @brief This interface gives access to a two-dimensional table.
|
|
|
|
|
|
|
|
Please also refer to the IAccessibleTableCell interface.
|
|
|
|
|
|
|
|
If you want to support older applications you should also support the
|
|
|
|
IAccessibleTable inteface.
|
|
|
|
*/
|
|
|
|
[object, uuid(6167f295-06f0-4cdd-a1fa-02e25153d869)]
|
|
|
|
interface IAccessibleTable2 : IUnknown
|
|
|
|
{
|
|
|
|
|
|
|
|
/** @brief Returns the accessible object at the specified row and column in
|
|
|
|
the table. This object could be an IAccessible or an IAccessible2.
|
|
|
|
@param [in] row
|
|
|
|
The 0 based row index for which to retrieve the cell.
|
|
|
|
@param [in] column
|
|
|
|
The 0 based column index for which to retrieve the cell.
|
|
|
|
@param [out] cell
|
|
|
|
If both row and column index are valid then the corresponding accessible
|
|
|
|
object is returned that represents the requested cell regardless of whether
|
|
|
|
the cell is currently visible (on the screen).
|
|
|
|
@retval S_OK
|
2013-05-19 01:21:42 +00:00
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
2009-09-11 01:07:56 +00:00
|
|
|
*/
|
|
|
|
[propget] HRESULT cellAt
|
|
|
|
(
|
|
|
|
[in] long row,
|
|
|
|
[in] long column,
|
|
|
|
[out, retval] IUnknown **cell
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the caption for the table. The returned object could be
|
|
|
|
an IAccessible or an IAccessible2.
|
|
|
|
@param [out] accessible
|
|
|
|
If the table has a caption then a reference to it is returned, else a NULL
|
|
|
|
pointer is returned.
|
|
|
|
@retval S_OK
|
2013-05-19 01:21:42 +00:00
|
|
|
@retval S_FALSE if there is nothing to return, [out] value is NULL
|
|
|
|
@deprecated use a describedBy relation
|
2009-09-11 01:07:56 +00:00
|
|
|
*/
|
|
|
|
[propget] HRESULT caption
|
|
|
|
(
|
|
|
|
[out, retval] IUnknown **accessible
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the description text of the specified column in the table.
|
|
|
|
@param [in] column
|
|
|
|
The 0 based index of the column for which to retrieve the description.
|
|
|
|
@param [out] description
|
|
|
|
Returns the description text of the specified column in the table if such a
|
|
|
|
description exists. Otherwise a NULL pointer is returned.
|
|
|
|
@retval S_OK
|
|
|
|
@retval S_FALSE if there is nothing to return, [out] value is NULL
|
2013-05-19 01:21:42 +00:00
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
2009-09-11 01:07:56 +00:00
|
|
|
*/
|
|
|
|
[propget] HRESULT columnDescription
|
|
|
|
(
|
|
|
|
[in] long column,
|
|
|
|
[out, retval] BSTR *description
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
|
|
/** @brief Returns the total number of columns in table
|
|
|
|
@param [out] columnCount
|
|
|
|
Number of columns in table (including columns outside the current viewport)
|
|
|
|
@retval S_OK
|
|
|
|
*/
|
|
|
|
[propget] HRESULT nColumns
|
|
|
|
(
|
|
|
|
[out, retval] long *columnCount
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the total number of rows in table
|
|
|
|
@param [out] rowCount
|
|
|
|
Number of rows in table (including rows outside the current viewport)
|
|
|
|
@retval S_OK
|
|
|
|
*/
|
|
|
|
[propget] HRESULT nRows
|
|
|
|
(
|
|
|
|
[out, retval] long *rowCount
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the total number of selected cells
|
|
|
|
@param [out] cellCount
|
|
|
|
Number of cells currently selected
|
|
|
|
@retval S_OK
|
|
|
|
*/
|
|
|
|
[propget] HRESULT nSelectedCells
|
|
|
|
(
|
|
|
|
[out, retval] long *cellCount
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the total number of selected columns
|
|
|
|
@param [out] columnCount
|
|
|
|
Number of columns currently selected
|
|
|
|
@retval S_OK
|
|
|
|
*/
|
|
|
|
[propget] HRESULT nSelectedColumns
|
|
|
|
(
|
|
|
|
[out, retval] long *columnCount
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the total number of selected rows
|
|
|
|
@param [out] rowCount
|
|
|
|
Number of rows currently selected
|
|
|
|
@retval S_OK
|
|
|
|
*/
|
|
|
|
[propget] HRESULT nSelectedRows
|
|
|
|
(
|
|
|
|
[out, retval] long *rowCount
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the description text of the specified row in the table.
|
|
|
|
@param [in] row
|
|
|
|
The 0 based index of the row for which to retrieve the description.
|
|
|
|
@param [out] description
|
|
|
|
Returns the description text of the specified row in the table if such a
|
|
|
|
description exists. Otherwise a NULL pointer is returned.
|
|
|
|
@retval S_OK
|
|
|
|
@retval S_FALSE if there is nothing to return, [out] value is NULL
|
2013-05-19 01:21:42 +00:00
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
2009-09-11 01:07:56 +00:00
|
|
|
*/
|
|
|
|
[propget] HRESULT rowDescription
|
|
|
|
(
|
|
|
|
[in] long row,
|
|
|
|
[out, retval] BSTR *description
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns a list of accessibles currently selected.
|
|
|
|
@param [out] cells
|
|
|
|
Pointer to an array of references to selected accessibles. The array is
|
2013-05-19 01:21:42 +00:00
|
|
|
allocated by the server with CoTaskMemAlloc and freed by the client with
|
|
|
|
CoTaskMemFree.
|
2009-09-11 01:07:56 +00:00
|
|
|
@param [out] nSelectedCells
|
|
|
|
The number of accessibles returned; the size of the returned array.
|
|
|
|
@retval S_OK
|
|
|
|
@retval S_FALSE if there are none, [out] values are NULL and 0 respectively
|
|
|
|
*/
|
|
|
|
[propget] HRESULT selectedCells
|
|
|
|
(
|
2013-05-19 01:21:42 +00:00
|
|
|
[out, size_is(,*nSelectedCells)] IUnknown ***cells,
|
2009-09-11 01:07:56 +00:00
|
|
|
[out, retval] long *nSelectedCells
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns a list of column indexes currently selected (0 based).
|
|
|
|
@param [out] selectedColumns
|
|
|
|
A pointer to an array of column indexes of selected columns (each index is
|
2013-05-19 01:21:42 +00:00
|
|
|
0 based). The array is allocated by the server with CoTaskMemAlloc and
|
|
|
|
freed by the client with CoTaskMemFree.
|
2009-09-11 01:07:56 +00:00
|
|
|
@param [out] nColumns
|
|
|
|
The number of column indexes returned; the size of the returned array.
|
|
|
|
@retval S_OK
|
|
|
|
@retval S_FALSE if there are none, [out] values are NULL and 0 respectively
|
|
|
|
*/
|
|
|
|
[propget] HRESULT selectedColumns
|
|
|
|
(
|
|
|
|
[out, size_is(,*nColumns)] long **selectedColumns,
|
|
|
|
[out, retval] long *nColumns
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns a list of row indexes currently selected (0 based).
|
|
|
|
@param [out] selectedRows
|
2013-05-19 01:21:42 +00:00
|
|
|
An array of row indexes of selected rows (each index is 0 based). The array
|
|
|
|
is allocated by the server with CoTaskMemAlloc and freed by the client with
|
|
|
|
CoTaskMemFree.
|
2009-09-11 01:07:56 +00:00
|
|
|
@param [out] nRows
|
|
|
|
The number of row indexes returned; the size of the returned array.
|
|
|
|
@retval S_OK
|
|
|
|
@retval S_FALSE if there are none, [out] values are NULL and 0 respectively
|
|
|
|
*/
|
|
|
|
[propget] HRESULT selectedRows
|
|
|
|
(
|
|
|
|
[out, size_is(,*nRows)] long **selectedRows,
|
|
|
|
[out, retval] long *nRows
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the summary description of the table. The returned object could be
|
|
|
|
an IAccessible or an IAccessible2.
|
|
|
|
@param [out] accessible
|
|
|
|
Returns a reference to an implementation dependent accessible object
|
|
|
|
representing the table's summary or a NULL pointer if the table
|
|
|
|
does not support a summary.
|
|
|
|
@retval S_OK
|
2013-05-19 01:21:42 +00:00
|
|
|
@retval S_FALSE if there is nothing to return, [out] value is NULL
|
|
|
|
@deprecated Use the labeledBy relation
|
2009-09-11 01:07:56 +00:00
|
|
|
*/
|
|
|
|
[propget] HRESULT summary
|
|
|
|
(
|
|
|
|
[out, retval] IUnknown **accessible
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns a boolean value indicating whether the specified column is
|
|
|
|
completely selected.
|
|
|
|
@param [in] column
|
|
|
|
0 based index of the column for which to determine whether it is selected.
|
|
|
|
@param [out] isSelected
|
|
|
|
Returns TRUE if the specified column is selected completely and FALSE otherwise.
|
|
|
|
@retval S_OK
|
2013-05-19 01:21:42 +00:00
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
2009-09-11 01:07:56 +00:00
|
|
|
*/
|
|
|
|
[propget] HRESULT isColumnSelected
|
|
|
|
(
|
|
|
|
[in] long column,
|
|
|
|
[out, retval] boolean *isSelected
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns a boolean value indicating whether the specified row is completely
|
|
|
|
selected.
|
|
|
|
@param [in] row
|
|
|
|
0 based index of the row for which to determine whether it is selected.
|
|
|
|
@param [out] isSelected
|
|
|
|
Returns TRUE if the specified row is selected completely and FALSE otherwise.
|
|
|
|
@retval S_OK
|
2013-05-19 01:21:42 +00:00
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
2009-09-11 01:07:56 +00:00
|
|
|
*/
|
|
|
|
[propget] HRESULT isRowSelected
|
|
|
|
(
|
|
|
|
[in] long row,
|
|
|
|
[out, retval] boolean *isSelected
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Selects a row and unselects all previously selected rows.
|
|
|
|
|
|
|
|
The behavior should mimic that of the application, but for those applications
|
|
|
|
which do not have a means in the GUI to select a full row of cells the behavior
|
|
|
|
should be as follows: First any selected rows in the table are unselected. Then
|
|
|
|
the entire row of cells for the specified row is selected. If any of the
|
|
|
|
cells in the selected row span additional rows, the cells in those rows
|
|
|
|
are also selected.
|
|
|
|
@param [in] row
|
|
|
|
0 based index of the row to be selected.
|
|
|
|
@retval S_OK
|
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
|
|
|
*/
|
|
|
|
HRESULT selectRow
|
|
|
|
(
|
|
|
|
[in] long row
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Selects a column and unselects all previously selected columns.
|
|
|
|
|
|
|
|
The behavior should mimic that of the application, but for those applications
|
|
|
|
which do not have a means in the GUI to select a full column of cells the behavior
|
|
|
|
should be as follows: First any selected columns in the table are unselected. Then
|
|
|
|
the entire column of cells for the specified column is selected. If any of the
|
|
|
|
cells in the selected column span additional columns, the cells in those columns
|
|
|
|
are also selected.
|
|
|
|
@param [in] column
|
|
|
|
0 based index of the column to be selected.
|
|
|
|
@retval S_OK
|
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
|
|
|
*/
|
|
|
|
HRESULT selectColumn
|
|
|
|
(
|
|
|
|
[in] long column
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Unselects one row, leaving other selected rows selected (if any).
|
|
|
|
|
|
|
|
The behavior should mimic that of the application, but for those applications
|
|
|
|
which do not have a means in the GUI to unselect a full row of cells the
|
|
|
|
behavior should be as follows: The entire row of cells for the specified
|
|
|
|
row is unselected. If any of the cells in the selected row span additional
|
|
|
|
rows, the cells in those rows are also unselected.
|
|
|
|
@param [in] row
|
|
|
|
0 based index of the row to be unselected.
|
|
|
|
@retval S_OK
|
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
|
|
|
*/
|
|
|
|
HRESULT unselectRow
|
|
|
|
(
|
|
|
|
[in] long row
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Unselects one column, leaving other selected columns selected (if any).
|
|
|
|
|
|
|
|
The behavior should mimic that of the application, but for those applications
|
|
|
|
which do not have a means in the GUI to unselect a full column of cells the
|
|
|
|
behavior should be as follows: The entire column of cells for the specified
|
|
|
|
column is unselected. If any of the cells in the selected column span additional
|
|
|
|
columns, the cells in those columns are also unselected.
|
|
|
|
@param [in] column
|
|
|
|
0 based index of the column to be unselected.
|
|
|
|
@retval S_OK
|
|
|
|
@retval E_INVALIDARG if bad [in] passed
|
|
|
|
*/
|
|
|
|
HRESULT unselectColumn
|
|
|
|
(
|
|
|
|
[in] long column
|
|
|
|
);
|
|
|
|
|
|
|
|
/** @brief Returns the type and extents describing how a table changed.
|
|
|
|
|
|
|
|
Provided for use by the IA2_EVENT_TABLE_MODEL_CHANGED event handler.
|
|
|
|
|
|
|
|
This data is only guaranteed to be valid while the thread notifying the event
|
|
|
|
continues. Once the handler has returned, the validity of the data depends on
|
|
|
|
how the server manages the life cycle of its objects. Also, note that the server
|
|
|
|
may have different life cycle management strategies for controls depending on
|
|
|
|
whether or not a control manages its children. Lists, trees, and tables can have
|
|
|
|
a large number of children and thus it's possible that the child objects for those
|
|
|
|
controls would only be created as needed. Servers should document their life cycle
|
|
|
|
strategy as this will be of interest to assistive technology or script engines
|
|
|
|
accessing data out of process or from other threads. Servers only need to save the
|
|
|
|
most recent row and column values associated with the change and a scope of the
|
|
|
|
entire application is adequate.
|
|
|
|
|
|
|
|
@param [out] modelChange
|
|
|
|
A struct of (type(insert, delete, update), firstRow, lastRow, firstColumn, lastColumn).
|
|
|
|
@retval S_OK
|
|
|
|
@retval S_FALSE if there is nothing to return, [out] value is NULL
|
|
|
|
*/
|
|
|
|
[propget] HRESULT modelChange
|
|
|
|
(
|
|
|
|
[out, retval] IA2TableModelChange *modelChange
|
|
|
|
);
|
|
|
|
|
|
|
|
}
|