accessible/public/nsIAccessibleTable.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Paul Sandoz (paul.sandoz@sun.com)
  25  *   Bill Haneman (bill.haneman@sun.com)
  26  *   John Gaunt (jgaunt@netscape.com)
  27  *
  28  * Alternatively, the contents of this file may be used under the terms of
  29  * either of the GNU General Public License Version 2 or later (the "GPL"),
  30  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  31  * in which case the provisions of the GPL or the LGPL are applicable instead
  32  * of those above. If you wish to allow use of your version of this file only
  33  * under the terms of either the GPL or the LGPL, and not to allow others to
  34  * use your version of this file under the terms of the MPL, indicate your
  35  * decision by deleting the provisions above and replace them with the notice
  36  * and other provisions required by the GPL or the LGPL. If you do not delete
  37  * the provisions above, a recipient may use your version of this file under
  38  * the terms of any one of the MPL, the GPL or the LGPL.
  39  *
  40  * ***** END LICENSE BLOCK ***** */
  41
  42 #include "nsISupports.idl"
  43
  44 interface nsIAccessible;
  45
  46 [scriptable, uuid(dcc1e5c3-966e-45b2-b30a-839d35432b24)]
  47 interface nsIAccessibleTable : nsISupports
  48 {
  49   readonly attribute nsIAccessible       caption;
  50   readonly attribute AString             summary;
  51   readonly attribute long                columns;
  52   readonly attribute nsIAccessibleTable  columnHeader;
  53   readonly attribute long                rows;
  54   readonly attribute nsIAccessibleTable  rowHeader;
  55
  56   /**
  57    * Returns the accessible object at the specified row and column in the table.
  58    * If both row and column index are valid then the corresponding accessible
  59    * object is returned that represents the requested cell regardless of whether
  60    * the cell is currently visible (on the screen).
  61    *
  62    * @param row - The row index for which to retrieve the cell.
  63    * @param column - The column index for which to retrieve the cell.
  64    */
  65   nsIAccessible cellRefAt(in long row, in long column);
  66
  67   /**
  68    * Translates the given row and column indices into the corresponding cell
  69    * index.
  70    *
  71    * @param row - index of the row of the table for which to return the cell
  72    *              index.
  73    * @param column - index of the column of the table for which to return
  74    *                 the cell index.
  75    */
  76   long getIndexAt(in long row, in long column);
  77
  78   /**
  79    * Translates the given child index into the corresponding column index.
  80    *
  81    * @param index - index of the child of the table for which to return
  82    *                the column index.
  83    */
  84   long getColumnAtIndex(in long index);
  85
  86   /**
  87    * Translates the given child index into the corresponding row index.
  88    *
  89    * @param index - index of the child of the table for which to return
  90    *                the row index.
  91    */
  92   long getRowAtIndex(in long index);
  93
  94   /**
  95    * Returns the number of columns occupied by the accessible object
  96    * at the specified row and column in the table. The result differs from 1
  97    * if the specified cell spans multiple columns.
  98    *
  99    * @param row - Row index of the accessible for which to return
 100    *              the column extent.
 101    * @param column - Column index of the accessible for which to return
 102    *                 the column extent.
 103    */
 104   long getColumnExtentAt(in long row, in long column);
 105
 106   /**
 107    * Returns the number of rows occupied by the accessible oject
 108    * at the specified row and column in the table. The result differs from 1
 109    * if the specified cell spans multiple rows.
 110    *
 111    * @param row  - Row index of the accessible for which to return
 112    *               the column extent.
 113    * @param column - Column index of the accessible for which to return
 114    *                 the column extent.
 115    */
 116   long getRowExtentAt(in long row, in long column);
 117
 118   /**
 119    * Returns the description text of the specified column in the table.
 120    * @param column - The index of the column for which to retrieve
 121    *                 the description.
 122    */
 123   AString getColumnDescription(in long column);
 124
 125   /**
 126    * Returns the description text of the specified row in the table.
 127    * @param row - The index of the row for which to retrieve the description.
 128    */
 129   AString getRowDescription(in long row);
 130
 131   /**
 132    * Returns a boolean value indicating whether the specified column is
 133    * completely selected.
 134    *
 135    * @param column  - Index of the column for which to determine whether it is
 136    *                   selected.
 137    */
 138   boolean isColumnSelected(in long column);
 139
 140   /**
 141    * Returns a boolean value indicating whether the specified row is completely
 142    * selected.
 143    *
 144    * @param row - Index of the row for which to determine whether it is
 145    *              selected.
 146    */
 147   boolean isRowSelected(in  long row);
 148
 149   /**
 150    * Returns a boolean value indicating whether the specified cell is selected.
 151    *
 152    * @param row - Index of the row for the cell to determine whether it is
 153    *              selected.
 154    * @param column - Index of the column for the cell to determine whether it
 155    *                 is selected.
 156    */
 157   boolean isCellSelected(in long row, in long column);
 158
 159   /**
 160    * Returns the total number of selected cells.
 161    */
 162   readonly attribute unsigned long selectedCellsCount;
 163
 164   /**
 165    * Returns the total number of selected columns.
 166    */
 167   readonly attribute unsigned long selectedColumnsCount;
 168
 169   /**
 170    * Returns the total number of selected rows.
 171    */
 172   readonly attribute unsigned long selectedRowsCount;
 173
 174   /**
 175    * Returns a list of cells indexes currently selected.
 176    *
 177    * @param cellsSize - length of array
 178    * @param cells - array of indexes of selected cells
 179    */
 180   void getSelectedCells(out unsigned long cellsSize,
 181                         [retval, array, size_is(cellsSize)] out long cells);
 182
 183   /**
 184    * Returns a list of column indexes currently selected.
 185    *
 186    * @param columnsSize - Length of array
 187    * @param columns - Array of indexes of selected columns
 188    */
 189   void getSelectedColumns(out unsigned long columnsSize,
 190                           [retval, array, size_is(columnsSize)] out long columns);
 191
 192   /**
 193    * Returns a list of row indexes currently selected.
 194    *
 195    * @param rowsSize - Length of array
 196    * @param rows - Array of indexes of selected rows
 197    */
 198   void getSelectedRows(out unsigned long rowsSize,
 199                        [retval, array, size_is(rowsSize)] out long rows);
 200
 201   /**
 202    * Selects a row and unselects all previously selected rows.
 203    *
 204    * @param row - Index of the row to be selected.
 205    */
 206   void selectRow(in long row);
 207
 208   /**
 209    * Selects a column and unselects all previously selected columns.
 210    *
 211    * @param column - Index of the column to be selected.
 212    */
 213   void selectColumn(in long column);
 214
 215   /**
 216    * Unselects one row, leaving other selected rows selected (if any).
 217    *
 218    * @param row  - Index of the row to be selected.
 219   */
 220   void unselectRow(in long row);
 221
 222   /**
 223    * Unselects one column, leaving other selected columns selected (if any).
 224    *
 225    * @param column - Index of the column to be selected.
 226    */
 227   void unselectColumn(in long column);
 228
 229   /**
 230    * Use heuristics to determine if table is most likely used for layout.
 231    */
 232   boolean isProbablyForLayout();
 233 };
 234