bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/accessibility/AccessibleTableListener.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010 IBM Corporation and others.
   3  *
   4  * This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License 2.0
   6  * which accompanies this distribution, and is available at
   7  * https://www.eclipse.org/legal/epl-2.0/
   8  *
   9  * SPDX-License-Identifier: EPL-2.0
  10  *
  11  * Contributors:
  12  *     IBM Corporation - initial API and implementation
  13  *******************************************************************************/
  14 package org.eclipse.swt.accessibility;
  15
  16 import org.eclipse.swt.internal.*;
  17
  18 /**
  19  * Classes which implement this interface provide methods
  20  * that handle AccessibleTable events.
  21  * <p>
  22  * After creating an instance of a class that implements
  23  * this interface it can be added to an accessible using the
  24  * <code>addAccessibleTableListener</code> method and removed using
  25  * the <code>removeAccessibleTableListener</code> method.
  26  * </p><p>
  27  * Many methods in this listener return cell accessible objects,
  28  * which should implement <code>AccessibleTableCellListener</code>.
  29  * </p>
  30  *
  31  * @see AccessibleTableAdapter
  32  * @see AccessibleTableEvent
  33  * @see AccessibleTableCellListener
  34  * @see AccessibleTableCellEvent
  35  *
  36  * @since 3.6
  37  */
  38 public interface AccessibleTableListener extends SWTEventListener {
  39         /**
  40          * Deselects one column, leaving other selected columns selected (if any).
  41          *
  42          * @param e an event object containing the following fields:<ul>
  43          * <li>[in] column - 0 based index of the column to be unselected.</li>
  44          * <li>[out] result - set to {@link ACC#OK} if the column was deselected.</li>
  45          * </ul>
  46          */
  47         public void deselectColumn(AccessibleTableEvent e);
  48
  49         /**
  50          * Deselects one row, leaving other selected rows selected (if any).
  51          *
  52          * @param e an event object containing the following fields:<ul>
  53          * <li>[in] row - 0 based index of the row to be unselected</li>
  54          * <li>[out] result - set to {@link ACC#OK} if the row was deselected.</li>
  55          * </ul>
  56          */
  57         public void deselectRow(AccessibleTableEvent e);
  58
  59         /**
  60          * Returns the caption for the table.
  61          *
  62          * @param e an event object containing the following fields:<ul>
  63          * <li>[out] accessible - the caption for the table, or null if the table does not have a caption</li>
  64          * </ul>
  65          *
  66          * @deprecated IAccessibleTable2::caption is deprecated, instead use the
  67          * IA2_RELATION_LABELED_BY relation to create a relation between the table and its caption.
  68          */
  69         @Deprecated
  70         public void getCaption(AccessibleTableEvent e);
  71
  72         /**
  73          * Returns the accessible object at the specified row and column in the table.
  74          *
  75          * @param e an event object containing the following fields:<ul>
  76          * <li>[in] row - the 0 based row index for which to retrieve the accessible cell</li>
  77          * <li>[in] column - the 0 based column index for which to retrieve the accessible cell</li>
  78          * <li>[out] accessible - the table cell at the specified row and column index,
  79          *              or null if the row or column index are not valid</li>
  80          * </ul>
  81          */
  82         public void getCell(AccessibleTableEvent e);
  83
  84         /**
  85          * Returns the accessible object for the specified column in the table.
  86          *
  87          * @param e an event object containing the following fields:<ul>
  88          * <li>[in] column - the 0 based column index for which to retrieve the accessible column</li>
  89          * <li>[out] accessible - the table column at the specified column index,
  90          *              or null if the column index is not valid</li>
  91          * </ul>
  92          */
  93         public void getColumn(AccessibleTableEvent e);
  94
  95         /**
  96          * Returns the total number of columns in the table.
  97          *
  98          * @param e an event object containing the following fields:<ul>
  99          * <li>[out] count - the number of columns in the table</li>
 100          * </ul>
 101          */
 102         public void getColumnCount(AccessibleTableEvent e);
 103
 104         /**
 105          * Returns the description text of the specified column in the table.
 106          *
 107          * @param e an event object containing the following fields:<ul>
 108          * <li>[in] column - the 0 based index of the column for which to retrieve the description</li>
 109          * <li>[out] result - the description text of the specified column in the table,
 110          *              or null if the column does not have a description</li>
 111          * </ul>
 112          */
 113         public void getColumnDescription(AccessibleTableEvent e);
 114
 115         /**
 116          * Returns the accessible object for the column header.
 117          *
 118          * @param e an event object containing the following fields:<ul>
 119          * <li>[out] accessible - an accessible object representing the column header,
 120          *              or null if there is no column header</li>
 121          * </ul>
 122          */
 123         public void getColumnHeader(AccessibleTableEvent e);
 124
 125         /**
 126          * Returns the column header cells as an array of accessible objects.
 127          *
 128          * @param e an event object containing the following fields:<ul>
 129          * <li>[out] accessibles - an array of accessible objects representing column header cells,
 130          *              or null if there are no column header cells</li>
 131          * </ul>
 132          */
 133         public void getColumnHeaderCells(AccessibleTableEvent e);
 134
 135         /**
 136          * Returns the columns as an array of accessible objects.
 137          *
 138          * @param e an event object containing the following fields:<ul>
 139          * <li>[out] accessibles - an array of accessible objects representing columns,
 140          *              or null if there are no columns</li>
 141          * </ul>
 142          */
 143         public void getColumns(AccessibleTableEvent e);
 144
 145         /**
 146          * Returns the accessible object for the specified row in the table.
 147          *
 148          * @param e an event object containing the following fields:<ul>
 149          * <li>[in] row - the 0 based row index for which to retrieve the accessible row</li>
 150          * <li>[out] accessible - the table row at the specified row index,
 151          *              or null if the row index is not valid</li>
 152          * </ul>
 153          */
 154         public void getRow(AccessibleTableEvent e);
 155
 156         /**
 157          * Returns the total number of rows in the table.
 158          *
 159          * @param e an event object containing the following fields:<ul>
 160          * <li>[out] count - the number of rows in the table</li>
 161          * </ul>
 162          */
 163         public void getRowCount(AccessibleTableEvent e);
 164
 165         /**
 166          * Returns the description text of the specified row in the table.
 167          *
 168          * @param e an event object containing the following fields:<ul>
 169          * <li>[in] row - the 0 based index of the row for which to retrieve the description</li>
 170          * <li>[out] result - the description text of the specified row in the table,
 171          *              or null if the row does not have a description</li>
 172          * </ul>
 173          */
 174         public void getRowDescription(AccessibleTableEvent e);
 175
 176         /**
 177          * Returns the accessible object for the row header.
 178          *
 179          * @param e an event object containing the following fields:<ul>
 180          * <li>[out] accessible - an accessible object representing the row header,
 181          *              or null if there is no row header</li>
 182          * </ul>
 183          */
 184         public void getRowHeader(AccessibleTableEvent e);
 185
 186         /**
 187          * Returns the row header cells as an array of accessible objects.
 188          *
 189          * @param e an event object containing the following fields:<ul>
 190          * <li>[out] accessibles - an array of accessible objects representing row header cells,
 191          *              or null if there are no row header cells</li>
 192          * </ul>
 193          */
 194         public void getRowHeaderCells(AccessibleTableEvent e);
 195
 196         /**
 197          * Returns the rows as an array of accessible objects.
 198          *
 199          * @param e an event object containing the following fields:<ul>
 200          * <li>[out] accessibles - an array of accessible objects representing rows,
 201          *              or null if there are no rows</li>
 202          * </ul>
 203          */
 204         public void getRows(AccessibleTableEvent e);
 205
 206         /**
 207          * Returns the number of selected cells.
 208          *
 209          * @param e an event object containing the following fields:<ul>
 210          * <li>[out] count -  the number of cells currently selected</li>
 211          * </ul>
 212          */
 213         public void getSelectedCellCount(AccessibleTableEvent e);
 214
 215         /**
 216          * Returns the currently selected cells.
 217          *
 218          * @param e an event object containing the following fields:<ul>
 219          * <li>[out] accessibles - array containing the selected accessible cells</li>
 220          * </ul>
 221          */
 222         public void getSelectedCells(AccessibleTableEvent e);
 223
 224         /**
 225          * Returns the number of selected columns.
 226          *
 227          * @param e an event object containing the following fields:<ul>
 228          * <li>[out] count - the number of columns currently selected</li>
 229          * </ul>
 230          */
 231         public void getSelectedColumnCount(AccessibleTableEvent e);
 232
 233         /**
 234          * Returns the column indexes that are currently selected.
 235          *
 236          * @param e an event object containing the following fields:<ul>
 237          * <li>[out] selected - an array of 0 based column indexes of selected columns</li>
 238          * </ul>
 239          */
 240         public void getSelectedColumns(AccessibleTableEvent e);
 241
 242         /**
 243          * Returns the number of selected rows.
 244          *
 245          * @param e an event object containing the following fields:<ul>
 246          * <li>[out] count - the number of rows currently selected</li>
 247          * </ul>
 248          */
 249         public void getSelectedRowCount(AccessibleTableEvent e);
 250
 251         /**
 252          * Returns the row indexes that are currently selected.
 253          *
 254          * @param e an event object containing the following fields:<ul>
 255          * <li>[out] selected - an array of 0 based row indexes of selected rows</li>
 256          * </ul>
 257          */
 258         public void getSelectedRows(AccessibleTableEvent e);
 259
 260         /**
 261          * Returns the summary description of the table.
 262          *
 263          * @param e an event object containing the following fields:<ul>
 264          * <li>[out] accessible - the summary for the table,
 265          *              or null if the table does not have a summary</li>
 266          * </ul>
 267          *
 268          * @deprecated IAccessibleTable2::summary is deprecated, instead use the
 269          * IA2_RELATION_DESCRIBED_BY relation to create a relation between the table and its summary.
 270          */
 271         @Deprecated
 272         public void getSummary(AccessibleTableEvent e);
 273
 274         /**
 275          * Returns the visible columns as an array of accessible objects.
 276          *
 277          * @param e an event object containing the following fields:<ul>
 278          * <li>[out] accessibles - an array of accessible objects representing visible columns,
 279          *              or null if there are no visible columns</li>
 280          * </ul>
 281          */
 282         public void getVisibleColumns(AccessibleTableEvent e);
 283
 284         /**
 285          * Returns the visible rows as an array of accessible objects.
 286          *
 287          * @param e an event object containing the following fields:<ul>
 288          * <li>[out] accessibles - an array of accessible objects representing visible rows,
 289          *              or null if there are no visible rows</li>
 290          * </ul>
 291          */
 292         public void getVisibleRows(AccessibleTableEvent e);
 293
 294         /**
 295          * Returns a boolean value indicating whether the specified column is
 296          * completely selected.
 297          *
 298          * @param e an event object containing the following fields:<ul>
 299          * <li>[in] column - 0 based index of the column for which to determine whether it is selected</li>
 300          * <li>[out] isSelected - true if the specified column is selected completely, and false otherwise</li>
 301          * </ul>
 302          */
 303         public void isColumnSelected(AccessibleTableEvent e);
 304
 305         /**
 306          * Returns a boolean value indicating whether the specified row is
 307          * completely selected.
 308          *
 309          * @param e an event object containing the following fields:<ul>
 310          * <li>[in] row - 0 based index of the row for which to determine whether it is selected</li>
 311          * <li>[out] isSelected - true if the specified row is selected completely, and false otherwise</li>
 312          * </ul>
 313          */
 314         public void isRowSelected(AccessibleTableEvent e);
 315
 316         /**
 317          * Selects a column.
 318          *
 319          * @param e an event object containing the following fields:<ul>
 320          * <li>[in] column - 0 based index of the column to be selected</li>
 321          * <li>[out] result - set to {@link ACC#OK} if the column was selected.</li>
 322          * </ul>
 323          */
 324         public void selectColumn(AccessibleTableEvent e);
 325
 326         /**
 327          * Selects a row.
 328          *
 329          * @param e an event object containing the following fields:<ul>
 330          * <li>[in] row - 0 based index of the row to be selected</li>
 331          * <li>[out] result - set to {@link ACC#OK} if the row was selected.</li>
 332          * </ul>
 333          */
 334         public void selectRow(AccessibleTableEvent e);
 335
 336         /**
 337          * Selects a column and deselects all previously selected columns.
 338          *
 339          * @param e an event object containing the following fields:<ul>
 340          * <li>[in] column - 0 based index of the column to be selected</li>
 341          * <li>[out] result - set to {@link ACC#OK} if the column was selected.</li>
 342          * </ul>
 343          */
 344         public void setSelectedColumn(AccessibleTableEvent e);
 345
 346         /**
 347          * Selects a row and deselects all previously selected rows.
 348          *
 349          * @param e an event object containing the following fields:<ul>
 350          * <li>[in] row - 0 based index of the row to be selected</li>
 351          * <li>[out] result - set to {@link ACC#OK} if the row was selected.</li>
 352          * </ul>
 353          */
 354         public void setSelectedRow(AccessibleTableEvent e);
 355 }