accessible/public/nsIAccessibleSelectable.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Marc Mulcahy (marc.mulcahy@sun.com)
  24  *   Paul Sandoz (paul.sandoz@sun.com)
  25  *   Bill Haneman (bill.haneman@sun.com)
  26  *   Kyle Yuan (kyle.yuan@sun.com)
  27  *   Aaron Leventhal (aaronl@netscape.com)
  28  *
  29  * Alternatively, the contents of this file may be used under the terms of
  30  * either of the GNU General Public License Version 2 or later (the "GPL"),
  31  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  32  * in which case the provisions of the GPL or the LGPL are applicable instead
  33  * of those above. If you wish to allow use of your version of this file only
  34  * under the terms of either the GPL or the LGPL, and not to allow others to
  35  * use your version of this file under the terms of the MPL, indicate your
  36  * decision by deleting the provisions above and replace them with the notice
  37  * and other provisions required by the GPL or the LGPL. If you do not delete
  38  * the provisions above, a recipient may use your version of this file under
  39  * the terms of any one of the MPL, the GPL or the LGPL.
  40  *
  41  * ***** END LICENSE BLOCK ***** */
  42 #include "nsISupports.idl"
  43 #include "nsIAccessible.idl"
  44 #include "nsIArray.idl"
  45
  46 /**
  47  * An interface for the accessibility module and in-process accessibility clients
  48  * for dealing with getting and changing the selection of accessible nodes.
  49  */
  50 [scriptable, uuid(34d268d6-1dd2-11b2-9d63-83a5e0ada290)]
  51 interface nsIAccessibleSelectable : nsISupports
  52 {
  53     const unsigned long eSelection_Add = 0;
  54     const unsigned long eSelection_Remove = 1;
  55     const unsigned long eSelection_GetState = 2;
  56
  57     /**
  58      * Return an nsIArray of selected nsIAccessible children
  59      */
  60     nsIArray GetSelectedChildren();
  61
  62     /**
  63      * Returns the number of accessible children currently selected.
  64      */
  65     readonly attribute long selectionCount;
  66
  67     /**
  68      * Adds the specified accessible child of the object to the
  69      * object's selection.
  70      * If the specified object is already selected, then it does nothing.
  71      * @throws NS_ERROR_FAILURE if the specified object is not selectable.
  72      */
  73     void addChildToSelection(in long index);
  74
  75     /**
  76      * Removes the specified child of the object from the object's selection.
  77      * If the specified object was not selected, then it does nothing.
  78      * @throws NS_ERROR_FAILURE if the specified object is not selectable.
  79      */
  80     void removeChildFromSelection(in long index);
  81
  82     /**
  83      * Clears the selection in the object so that no children in the object
  84      * are selected.
  85      */
  86     void clearSelection();
  87
  88     /**
  89      * Returns a reference to the accessible object representing the specified
  90      * selected child of the object.
  91      * @param index Zero-based selected accessible child index
  92      * @return The nth selected accessible child
  93      */
  94     nsIAccessible refSelection(in long index);
  95
  96     /**
  97       * Determines if the current child of this object is selected
  98       * @param The zero-based accessible child index
  99       * @return Returns true if the child is selected, false if not.
 100       */
 101     boolean isChildSelected(in long index);
 102
 103     /**
 104      * Select all children
 105      * @return If the object does not accept multiple selection, return false.
 106      *         Otherwise, returns true.
 107      */
 108     boolean selectAllSelection();
 109 };