Struct xpcom::interfaces::nsIAccessibleTable [] [src]

#[repr(C)]
pub struct nsIAccessibleTable { /* fields omitted */ }

interface nsIAccessibleTable : nsISupports

Methods

impl nsIAccessibleTable
[src]

[src]

Cast this nsIAccessibleTable to one of its base interfaces.

impl nsIAccessibleTable
[src]

[src]

/**
   * Return the caption accessible for the table. For example, html:caption
   * element of html:table element.
   */

readonly attribute nsIAccessible caption;

[src]

/**
   * Return summary description for the table. For example, @summary attribute
   * on html:table element.
   */

readonly attribute AString summary;

[src]

/**
   * Return columns count in the table.
   */

readonly attribute long columnCount;

[src]

/**
   * Return rows count in the table.
   */

readonly attribute long rowCount;

[src]

/**
   * Return the accessible object at the specified row and column in the table.
   * 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).
   *
   * @param  rowIndex     [in] the row index to retrieve the cell at
   * @param  columnIndex  [in] the column index to retrieve the cell at
   */

nsIAccessible getCellAt (in long rowIndex, in long columnIndex);

[src]

/**
   * Translate the given row and column indices into the corresponding cell
   * index.
   *
   * @param  rowIndex    [in] the row index to return cell index at
   * @param  columnIndex [in] the column index to return cell index at
   */

long getCellIndexAt (in long rowIndex, in long columnIndex);

[src]

/**
   * Translate the given cell index into the corresponding column index.
   *
   * @param  cellIndex  [in] index of the table cell to return column index for
   */

long getColumnIndexAt (in long cellIndex);

[src]

/**
   * Translate the given cell index into the corresponding row index.
   *
   * @param cellIndex  [in] index of the table cell to return row index for
   */

long getRowIndexAt (in long cellIndex);

[src]

/**
   * Translate the given cell index into the corresponding row and column
   * indices.
   *
   * @param cellIndex    [in] cell index to return row and column indices for
   * @param rowIndex     [out] row index at the given cell index
   * @param columnIndex  [out] column index at the given cell index
   */

void getRowAndColumnIndicesAt (in long cellIndex, out long rowIndex, out long columnIndex);

[src]

/**
   * Return the number of columns occupied by the accessible cell at
   * the specified row and column in the table. The result differs from 1 if
   * the specified cell spans multiple columns.
   *
   * @param  row     [in] row index of the cell to return the column extent for
   * @param  column  [in] column index of the cell to return the column extent
   *                  for
   */

long getColumnExtentAt (in long row, in long column);

[src]

/**
   * Return the number of rows occupied by the accessible cell at the specified
   * row and column in the table. The result differs from 1 if the specified
   * cell spans multiple rows.
   *
   * @param  row     [in] row index of the cell to return the column extent for
   * @param  column  [in] column index of the cell to return the column extent
   *                  for
   */

long getRowExtentAt (in long row, in long column);

[src]

/**
   * Return the description text of the specified column in the table.
   *
   * @param  columnIndex  [in] the column index to retrieve description for
   */

AString getColumnDescription (in long columnIndex);

[src]

/**
   * Return the description text of the specified row in the table.
   *
   * @param  rowIndex  [in] the row index to retrieve description for
   */

AString getRowDescription (in long rowIndex);

[src]

/**
   * Return a boolean value indicating whether the specified column is
   * selected, i.e. all cells within the column are selected.
   *
   * @param  columnIndex  [in] the column index to determine if it's selected
   */

boolean isColumnSelected (in long columnIndex);

[src]

/**
   * Return a boolean value indicating whether the specified row is selected,
   * i.e. all cells within the row are selected.
   *
   * @param  rowIndex  [in] the row index to determine whether it's selected
   */

boolean isRowSelected (in long rowIndex);

[src]

/**
   * Return a boolean value indicating whether the specified cell is selected.
   *
   * @param  rowIndex     [in] the row index of the cell
   * @param  columnIndex  [in] the column index of the cell
   */

boolean isCellSelected (in long rowIndex, in long columnIndex);

[src]

/**
   * Return the total number of selected cells.
   */

readonly attribute unsigned long selectedCellCount;

[src]

/**
   * Return the total number of selected columns.
   */

readonly attribute unsigned long selectedColumnCount;

[src]

/**
   * Return the total number of selected rows.
   */

readonly attribute unsigned long selectedRowCount;

[src]

/**
   * Return an array of selected cells.
   */

readonly attribute nsIArray selectedCells;

[src]

/**
   * Return an array of cell indices currently selected.
   *
   * @param  cellsArraySize  [in] length of array
   * @param  cellsArray      [in] array of indexes of selected cells
   */

void getSelectedCellIndices (out unsigned long cellsArraySize, [array, size_is (cellsArraySize), retval] out long cellsArray);

[src]

/**
   * Return an array of column indices currently selected.
   *
   * @param  columnsArraySize  [in] length of array
   * @param  columnsArray      [in] array of indices of selected columns
   */

void getSelectedColumnIndices (out unsigned long columnsArraySize, [array, size_is (columnsArraySize), retval] out long columnsArray);

[src]

/**
   * Return an array of row indices currently selected.
   *
   * @param  rowsArraySize  [in] Length of array
   * @param  rowsArray      [in] array of indices of selected rows
   */

void getSelectedRowIndices (out unsigned long rowsArraySize, [array, size_is (rowsArraySize), retval] out long rowsArray);

[src]

/**
   * Select a row and unselects all previously selected rows.
   *
   * @param  rowIndex  [in] the row index to select
   */

void selectRow (in long rowIndex);

[src]

/**
   * Select a column and unselects all previously selected columns.
   *
   * @param  columnIndex  [in] the column index to select
   */

void selectColumn (in long columnIndex);

[src]

/**
   * Unselect the given row, leaving other selected rows selected (if any).
   *
   * @param  rowIndex  [in] the row index to select
  */

void unselectRow (in long rowIndex);

[src]

/**
   * Unselect the given column, leaving other selected columns selected (if any).
   *
   * @param  columnIndex  [in] the column index to select
   */

void unselectColumn (in long columnIndex);

[src]

/**
   * Use heuristics to determine if table is most likely used for layout.
   */

boolean isProbablyForLayout ();

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIAccessibleTable
[src]

IID: nsIID = nsID(3406559161, 4478, 16610, [158, 70, 24, 156, 61, 67, 206, 74])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIAccessibleTable
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIAccessibleTable
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.