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";

List of all members.

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

const unsigned long eSelection_Add = 0
const unsigned long eSelection_Remove = 1
const unsigned long eSelection_GetState = 2
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.

Status:
UNDER_REVIEW

Member Function Documentation

void nsIAccessibleSelectable::addChildToSelection ( in long  index  ) 

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_FAILURE if the specified object is not selectable.
void nsIAccessibleSelectable::clearSelection (  ) 

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

nsIArray nsIAccessibleSelectable::GetSelectedChildren (  ) 

Return an nsIArray of selected nsIAccessible children.

boolean nsIAccessibleSelectable::isChildSelected ( in long  index  ) 

Determines if the current child of this object is selected.

Parameters:
The zero-based accessible child index
Returns:
Returns true if the child is selected, false if not.
nsIAccessible nsIAccessibleSelectable::refSelection ( in long  index  ) 

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

Parameters:
index Zero-based selected accessible child index
Returns:
The nth selected accessible child
void nsIAccessibleSelectable::removeChildFromSelection ( 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.

Exceptions:
NS_ERROR_FAILURE if the specified object is not selectable.
boolean nsIAccessibleSelectable::selectAllSelection (  ) 

Select all children.

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

Member Data Documentation

const unsigned long nsIAccessibleSelectable::eSelection_Add = 0
readonly attribute long nsIAccessibleSelectable::selectionCount

Returns the number of accessible children currently selected.


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