michael@0: /************************************************************************* michael@0: * michael@0: * File Name (AccessibleTableCell.idl) michael@0: * michael@0: * IAccessible2 IDL Specification michael@0: * michael@0: * Copyright (c) 2007, 2013 Linux Foundation michael@0: * Copyright (c) 2006 IBM Corporation michael@0: * Copyright (c) 2000, 2006 Sun Microsystems, Inc. michael@0: * All rights reserved. michael@0: * michael@0: * michael@0: * Redistribution and use in source and binary forms, with or without michael@0: * modification, are permitted provided that the following conditions michael@0: * are met: michael@0: * michael@0: * 1. Redistributions of source code must retain the above copyright michael@0: * notice, this list of conditions and the following disclaimer. michael@0: * michael@0: * 2. Redistributions in binary form must reproduce the above michael@0: * copyright notice, this list of conditions and the following michael@0: * disclaimer in the documentation and/or other materials michael@0: * provided with the distribution. michael@0: * michael@0: * 3. Neither the name of the Linux Foundation nor the names of its michael@0: * contributors may be used to endorse or promote products michael@0: * derived from this software without specific prior written michael@0: * permission. michael@0: * michael@0: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND michael@0: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, michael@0: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF michael@0: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE michael@0: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR michael@0: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, michael@0: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT michael@0: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; michael@0: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) michael@0: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN michael@0: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR michael@0: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, michael@0: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. michael@0: * michael@0: * This BSD License conforms to the Open Source Initiative "Simplified michael@0: * BSD License" as published at: michael@0: * http://www.opensource.org/licenses/bsd-license.php michael@0: * michael@0: * IAccessible2 is a trademark of the Linux Foundation. The IAccessible2 michael@0: * mark may be used in accordance with the Linux Foundation Trademark michael@0: * Policy to indicate compliance with the IAccessible2 specification. michael@0: * michael@0: ************************************************************************/ michael@0: michael@0: import "objidl.idl"; michael@0: import "oaidl.idl"; michael@0: import "oleacc.idl"; michael@0: import "Accessible2.idl"; michael@0: michael@0: /** @brief This interface gives access to the cells of a two-dimensional table. michael@0: michael@0: Please also refer to the IAccessibleTable2 interface. michael@0: michael@0: */ michael@0: [object, uuid(594116B1-C99F-4847-AD06-0A7A86ECE645)] michael@0: interface IAccessibleTableCell : IUnknown michael@0: { michael@0: michael@0: /** @brief Returns the number of columns occupied by this cell accessible. michael@0: michael@0: The result is greater than 1 if the specified cell spans multiple columns. michael@0: @param [out] nColumnsSpanned michael@0: Returns the 1 based column extent of the specified cell. michael@0: @retval S_OK michael@0: */ michael@0: [propget] HRESULT columnExtent michael@0: ( michael@0: [out, retval] long *nColumnsSpanned michael@0: ); michael@0: michael@0: /** @brief Returns the column headers as an array of cell accessibles. michael@0: michael@0: @param [out] cellAccessibles michael@0: Pointer to an array of references to cell accessibles. The array is allocated michael@0: by the server. The client must free it with CoTaskMemFree. michael@0: @param [out] nColumnHeaderCells michael@0: The number of accessibles returned; the size of the returned array. michael@0: @retval S_OK michael@0: @retval S_FALSE if there is no header, [out] values are NULL and 0 respectively michael@0: */ michael@0: [propget] HRESULT columnHeaderCells michael@0: ( michael@0: [out, size_is(,*nColumnHeaderCells)] IUnknown ***cellAccessibles, michael@0: [out, retval] long *nColumnHeaderCells michael@0: ); michael@0: michael@0: /** @brief Translates this cell accessible into the corresponding column index. michael@0: michael@0: @param [out] columnIndex michael@0: Returns the 0 based column index of the cell of the specified cell or the index of michael@0: the first column if the cell spans multiple columns. michael@0: @retval S_OK michael@0: */ michael@0: [propget] HRESULT columnIndex michael@0: ( michael@0: [out, retval] long *columnIndex michael@0: ); michael@0: michael@0: /** @brief Returns the number of rows occupied by this cell accessible. michael@0: michael@0: @param [out] nRowsSpanned michael@0: Returns the row extent of the specified cell. michael@0: @retval S_OK michael@0: */ michael@0: [propget] HRESULT rowExtent michael@0: ( michael@0: [out, retval] long *nRowsSpanned michael@0: ); michael@0: michael@0: /** @brief Returns the row headers as an array of cell accessibles. michael@0: michael@0: @param [out] cellAccessibles michael@0: Pointer to an array of references to cell accessibles. The array is allocated michael@0: by the server. The client must free it with CoTaskMemFree. michael@0: @param [out] nRowHeaderCells michael@0: The number of accessibles returned; the size of the returned array. michael@0: @retval S_OK michael@0: @retval S_FALSE if there is no header, [out] values are NULL and 0 respectively michael@0: */ michael@0: [propget] HRESULT rowHeaderCells michael@0: ( michael@0: [out, size_is(,*nRowHeaderCells)] IUnknown ***cellAccessibles, michael@0: [out, retval] long *nRowHeaderCells michael@0: ); michael@0: michael@0: /** @brief Translates this cell accessible into the corresponding row index. michael@0: michael@0: @param [out] rowIndex michael@0: Returns the 0 based row index of the specified cell or the index of michael@0: the first row if the cell spans multiple rows. michael@0: @retval S_OK michael@0: */ michael@0: [propget] HRESULT rowIndex michael@0: ( michael@0: [out, retval] long *rowIndex michael@0: ); michael@0: michael@0: /** @brief Returns a boolean value indicating whether this cell is selected. michael@0: michael@0: @param [out] isSelected michael@0: Returns TRUE if the specified cell is selected and FALSE otherwise. michael@0: @retval S_OK michael@0: */ michael@0: [propget] HRESULT isSelected michael@0: ( michael@0: [out, retval] boolean *isSelected michael@0: ); michael@0: michael@0: /** @brief Gets the row and column indexes and extents of this cell accessible michael@0: and whether or not it is selected. michael@0: michael@0: This is a convenience function. It is not mandatory to implement it. michael@0: @param [out] row michael@0: 0 based row index. michael@0: @param [out] column michael@0: 0 based column index. michael@0: @param [out] rowExtents michael@0: Number of cells spanned by this cell in this row. michael@0: @param [out] columnExtents michael@0: Number of cells spanned by this cell in this column. michael@0: @param [out] isSelected michael@0: Indicates if the specified cell is selected. michael@0: @retval S_OK michael@0: */ michael@0: [propget] HRESULT rowColumnExtents michael@0: ( michael@0: [out] long *row, michael@0: [out] long *column, michael@0: [out] long *rowExtents, michael@0: [out] long *columnExtents, michael@0: [out, retval] boolean *isSelected michael@0: ); michael@0: michael@0: /** @brief Returns a reference to the accessbile of the containing table. michael@0: michael@0: @param [out] table michael@0: Returns a reference to the IUnknown of the containing table. michael@0: @retval S_OK michael@0: */ michael@0: [propget] HRESULT table michael@0: ( michael@0: [out, retval] IUnknown **table michael@0: ); michael@0: michael@0: }