nsIAccessibleSelectable

From MDC

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

Contents 1 Method overview 2 Attributes 3 Constants 4 Methods 4.1 GetSelectedChildren() 4.2 addChildToSelection() 4.2.1 Parameters 4.3 removeChildFromSelection() 4.3.1 Parameters 4.4 clearSelection() 4.5 refSelection() 4.5.1 Parameters 4.6 isChildSelected() 4.6.1 Parameters 4.6.2 Return value 4.7 selectAllSelection() 4.7.1 Return value

nsIAccessibleSelectable is defined in accessible/public/nsIAccessibleSelectable.idl. It is scriptable and is currently under review.

Inherits from: nsISupports

[edit] Method overview

nsIArray GetSelectedChildren();

void addChildToSelection(in long index);

void removeChildFromSelection(in long index);

void clearSelection();

nsIAccessible refSelection(in long index);

boolean isChildSelected(in long index);

boolean selectAllSelection();

[edit] Attributes

Attribute	Type	Description
selectionCount	long	Returns the number of accessible children currently selected.

[edit] Constants

Constant	Value	Description
eSelection_Add	0	unsigned long data type.
eSelection_Remove	1	unsigned long data type.
eSelection_GetState	2	unsigned long data type.

[edit] Methods

[edit] GetSelectedChildren()

Return an nsIArray of selected nsIAccessible children

  nsIArray GetSelectedChildren();

[edit] addChildToSelection()

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

[edit] Parameters

index

[edit] removeChildFromSelection()

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

[edit] Parameters

index

[edit] clearSelection()

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

  void clearSelection();

[edit] refSelection()

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

  nsIAccessible refSelection(
     in long index
  );

[edit] Parameters

index

Zero-based selected accessible child index

[edit] isChildSelected()

Determines if the current child of this object is selected

  boolean isChildSelected(
     in long index
  );

[edit] Parameters

index

The zero-based accessible child index

[edit] Return value

Returns true if the child is selected, false if not.

[edit] selectAllSelection()

Select all children.

  boolean selectAllSelection();

[edit] Return value

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