accessible/public/nsIAccessibleSelectable.idl@6474c204b198 (annotated)
accessible/public/nsIAccessibleSelectable.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | interface nsIAccessible; |
| michael@0 | 9 | interface nsIArray; |
| michael@0 | 10 | |
| michael@0 | 11 | /** |
| michael@0 | 12 | * An accessibility interface for selectable widgets. |
| michael@0 | 13 | */ |
| michael@0 | 14 | [scriptable, uuid(3e507fc4-4fcc-4223-a674-a095f591eba1)] |
| michael@0 | 15 | interface nsIAccessibleSelectable : nsISupports |
| michael@0 | 16 | { |
| michael@0 | 17 | /** |
| michael@0 | 18 | * Return an nsIArray of selected items within the widget. |
| michael@0 | 19 | */ |
| michael@0 | 20 | readonly attribute nsIArray selectedItems; |
| michael@0 | 21 | |
| michael@0 | 22 | /** |
| michael@0 | 23 | * Return the number of currently selected items. |
| michael@0 | 24 | */ |
| michael@0 | 25 | readonly attribute unsigned long selectedItemCount; |
| michael@0 | 26 | |
| michael@0 | 27 | /** |
| michael@0 | 28 | * Return a nth selected item within the widget. |
| michael@0 | 29 | */ |
| michael@0 | 30 | nsIAccessible getSelectedItemAt(in unsigned long index); |
| michael@0 | 31 | |
| michael@0 | 32 | /** |
| michael@0 | 33 | * Return true if the given item is selected. |
| michael@0 | 34 | */ |
| michael@0 | 35 | [binaryname(ScriptableIsItemSelected)] |
| michael@0 | 36 | boolean isItemSelected(in unsigned long index); |
| michael@0 | 37 | |
| michael@0 | 38 | /** |
| michael@0 | 39 | * Adds the specified item to the widget's selection. |
| michael@0 | 40 | */ |
| michael@0 | 41 | [binaryname(ScriptableAddItemToSelection)] |
| michael@0 | 42 | void addItemToSelection(in unsigned long index); |
| michael@0 | 43 | |
| michael@0 | 44 | /** |
| michael@0 | 45 | * Removes the specified item from the widget's selection. |
| michael@0 | 46 | */ |
| michael@0 | 47 | [binaryname(ScriptableRemoveItemFromSelection)] |
| michael@0 | 48 | void removeItemFromSelection(in unsigned long index); |
| michael@0 | 49 | |
| michael@0 | 50 | /** |
| michael@0 | 51 | * Select all items. |
| michael@0 | 52 | * |
| michael@0 | 53 | * @return false if the object does not accept multiple selection, |
| michael@0 | 54 | * otherwise true. |
| michael@0 | 55 | */ |
| michael@0 | 56 | [binaryname(ScriptableSelectAll)] |
| michael@0 | 57 | boolean selectAll(); |
| michael@0 | 58 | |
| michael@0 | 59 | /** |
| michael@0 | 60 | * Unselect all items. |
| michael@0 | 61 | */ |
| michael@0 | 62 | [binaryname(ScriptableUnselectAll)] |
| michael@0 | 63 | void unselectAll(); |
| michael@0 | 64 | }; |
