author Ehsan Akhgari <>
Thu, 27 Sep 2012 10:24:08 -0400
changeset 115169 d3d022bd1443dc4a370f8c7add006b0aff2b00bc
parent 98983 f4157e8c410708d76703f19e4dfb61859bfe32d8
child 168813 0803bb0d11d04ec1315789edab3e7d98ab37bd1e
permissions -rw-r--r--
Backout changeset 24f4f77fba76 (bug 793408) because of broken builds on a CLOSED TREE

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */
#include "nsISupports.idl"
#include "nsIAccessible.idl"
#include "nsIArray.idl"

 * An interface for the accessibility module and in-process accessibility clients
 * for dealing with getting and changing the selection of accessible nodes.
[scriptable, uuid(34d268d6-1dd2-11b2-9d63-83a5e0ada290)]
interface nsIAccessibleSelectable : nsISupports
    const unsigned long eSelection_Add = 0;
    const unsigned long eSelection_Remove = 1;
    const unsigned long eSelection_GetState = 2;

     * Return an nsIArray of selected nsIAccessible children 
    nsIArray GetSelectedChildren();
     * Returns the number of accessible children currently selected.
    readonly attribute long selectionCount;

     * Adds the specified accessible child of the object to the
     * object's selection.
     * If the specified object is already selected, then it does nothing.
     * @throws NS_ERROR_FAILURE if the specified object is not selectable.
    void addChildToSelection(in long index);

     * Removes the specified child of the object from the object's selection.
     * If the specified object was not selected, then it does nothing.
     * @throws NS_ERROR_FAILURE if the specified object is not selectable.
    void removeChildFromSelection(in long index);

     * Clears the selection in the object so that no children in the object
     * are selected.
    void clearSelection();

     * Returns a reference to the accessible object representing the specified
     * selected child of the object.
     * @param index Zero-based selected accessible child index 
     * @return The nth selected accessible child
    nsIAccessible refSelection(in long index);

      * Determines if the current child of this object is selected
      * @param The zero-based accessible child index
      * @return Returns true if the child is selected, false if not.
    boolean isChildSelected(in long index);

     * Select all children
     * @return If the object does not accept multiple selection, return false.
     *         Otherwise, returns true.
    boolean selectAllSelection();