accessible/interfaces/nsIAccessibleSelectable.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 interface nsIAccessible;
   9 interface nsIArray;
  10
  11 /**
  12  * An accessibility interface for selectable widgets.
  13  */
  14 [scriptable, builtinclass, uuid(8efb03d4-1354-4875-94cf-261336057626)]
  15 interface nsIAccessibleSelectable : nsISupports
  16 {
  17   /**
  18    * Return an nsIArray of selected items within the widget.
  19    */
  20   readonly attribute nsIArray selectedItems;
  21
  22   /**
  23    * Return the number of currently selected items.
  24    */
  25   readonly attribute unsigned long selectedItemCount;
  26
  27   /**
  28    * Return a nth selected item within the widget.
  29    */
  30   nsIAccessible getSelectedItemAt(in unsigned long index);
  31
  32   /**
  33    * Return true if the given item is selected.
  34    */
  35   boolean isItemSelected(in unsigned long index);
  36
  37   /**
  38    * Adds the specified item to the widget's selection.
  39    */
  40   void addItemToSelection(in unsigned long index);
  41
  42   /**
  43    * Removes the specified item from the widget's selection.
  44    */
  45   void removeItemFromSelection(in unsigned long index);
  46
  47   /**
  48    * Select all items.
  49    *
  50    * @return false if the object does not accept multiple selection,
  51    *         otherwise true.
  52    */
  53   boolean selectAll();
  54
  55   /**
  56    * Unselect all items.
  57    */
  58   void unselectAll();
  59 };