Back to index

lightning-sunbird  0.9+nobinonly
Public Types | Public Member Functions | Public Attributes
nsIAccessibleSelectable Interface Reference

An interface for the accessibility module and in-process accessibility clients for dealing with getting and changing the selection of accessible nodes. More...

import "nsIAccessibleSelectable.idl";

Inheritance diagram for nsIAccessibleSelectable:
Inheritance graph
[legend]
Collaboration diagram for nsIAccessibleSelectable:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { eSelection_Add = 0U, eSelection_Remove = 1U, eSelection_GetState = 2U }

Public Member Functions

nsIArray GetSelectedChildren ()
 Return an nsIArray of selected nsIAccessible children.
void addChildToSelection (in long index)
 Adds the specified accessible child of the object to the object's selection.
void removeChildFromSelection (in long index)
 Removes the specified child of the object from the object's selection.
void clearSelection ()
 Clears the selection in the object so that no children in the object are selected.
nsIAccessible refSelection (in long index)
 Returns a reference to the accessible object representing the specified selected child of the object.
boolean isChildSelected (in long index)
 Determines if the current child of this object is selected.
boolean selectAllSelection ()
 Select all children.

Public Attributes

readonly attribute long selectionCount
 Returns the number of accessible children currently selected.

Detailed Description

An interface for the accessibility module and in-process accessibility clients for dealing with getting and changing the selection of accessible nodes.

UNDER_REVIEW

Definition at line 53 of file nsIAccessibleSelectable.idl.


Member Enumeration Documentation

anonymous enum
Enumerator:
eSelection_Add 
eSelection_Remove 
eSelection_GetState 

Definition at line 56 of file nsIAccessibleSelectable.idl.


Member Function Documentation

Adds the specified accessible child of the object to the object's selection.

If the specified object is already selected, then it does nothing.

Exceptions:
NS_ERROR_FAILUREif the specified object is not selectable.

Clears the selection in the object so that no children in the object are selected.

Return an nsIArray of selected nsIAccessible children.

Determines if the current child of this object is selected.

Parameters:
Thezero-based accessible child index
Returns:
Returns true if the child is selected, false if not.

Returns a reference to the accessible object representing the specified selected child of the object.

Parameters:
indexZero-based selected accessible child index
Returns:
The nth selected accessible child

Removes the specified child of the object from the object's selection.

If the specified object was not selected, then it does nothing.

Exceptions:
NS_ERROR_FAILUREif the specified object is not selectable.

Select all children.

Returns:
If the object does not accept multiple selection, return false. Otherwise, returns true.

Member Data Documentation

Returns the number of accessible children currently selected.

Definition at line 66 of file nsIAccessibleSelectable.idl.


The documentation for this interface was generated from the following file: