nsIAccessibleSelectable.idl

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-/* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 2003 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Marc Mulcahy (marc.mulcahy@sun.com) * Paul Sandoz (paul.sandoz@sun.com) * Bill Haneman (bill.haneman@sun.com) * Kyle Yuan (kyle.yuan@sun.com) * Aaron Leventhal (aaronl@netscape.com) * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */#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. * * @status UNDER_REVIEW */
[scriptable, uuid(34d268d6-1dd2-11b2-9d63-83a5e0ada290)]
00053 interface nsIAccessibleSelectable : nsISupports
{
constunsignedlong eSelection_Add = 0;
constunsignedlong eSelection_Remove = 1;
constunsignedlong eSelection_GetState = 2;
/** * Return an nsIArray of selected nsIAccessible children */nsIArray GetSelectedChildren();
/** * Returns the number of accessible children currently selected. */00067 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();
};