:: drafts :: com :: sun :: star :: accessibility ::
|
interface XAccessibleSelection |
- Base Hierarchy
::com::sun::star::uno::XInterface
|
+-XAccessibleSelection
|
- Description
- Implement this interface to represent a selection of accessible objects.
This interface is the standard mechanism to obtain and modify the
currently selected children. Every object that has children that can be
selected should support this interface.
The XAccessibleSelection interface has to be implemented
in conjunction with the XAccessibleContext interface that
provides the children on which the first operates.
It depends on the class implementing this interface, whether it
supports single or multi selection.
|
Methods' Details |
selectAccessibleChild
void
selectAccessibleChild( |
[in] long
raises(
|
nChildIndex )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Selects the specified Accessible child of the
object.
Depending on the implementing class the child is added to the
current set a selected children (multi selection) or a previously
selected child is deselected first (single selection).
- Parameter nChildIndex
-
Index of the child which is to add to the selection. This index
referes to all the the children of this object.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the given index does not lie in the valid range of 0 up to
the result of
XAccessibleContext::getAccessibleChildCount() -1.
|
|
isAccessibleChildSelected
boolean
isAccessibleChildSelected( |
[in] long
raises(
|
nChildIndex )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Determines if the specified child of this object is selected.
- Parameter nChildIndex
-
Index of the child for which to detect whether it is selected.
This index referes to all the children of this object.
- Returns
-
Returns true if the specified child is selected and false
if it is not selected.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the given index does not lie in the valid range of 0 up to
the result of
XAccessibleContext::getAccessibleChildCount() -1.
|
|
clearAccessibleSelection
[oneway] void
clearAccessibleSelection(); |
|
|
- Description
- Clears the selection, so that no children of the
object are selected.
|
|
selectAllAccessible
[oneway] void
selectAllAccessible(); |
|
|
- Description
- Select all children.
Causes every child of the object to be selected if the object
supports multiple selections. If multiple selection is not
supported then the first child, if it exists, is selected and all
other children are deselected.
|
|
getSelectedAccessibleChildCount
long
getSelectedAccessibleChildCount(); |
|
|
- Description
- Returns the number of Accessible children that are currently
selected.
This number specifies the valid interval of indices that can be
used as arguments for the methods
XAccessibleSelection::getSelectedChild and
XAccessibleSelection::deselectSelectedChild .
- Returns
-
Returns the number of selected children of this object or 0 if
no child is selected.
|
|
getSelectedAccessibleChild
XAccessible
getSelectedAccessibleChild( |
[in] long
raises(
|
nSelectedChildIndex )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns the specified selected Accessible child.
- Parameter nSelectedChildIndex
-
This index refers only to the selected children, not to all the
children of this object. Even if all children are selected, the
indices enumerating the selected children need not be the same
as those enumerating all children. If only single selection is
supported the only valid value is 0.
- Returns
-
If the index is valid, i.e. not negative and lower than the
number of selected children, then a valid reference to the
corresponding XAccessible child is returned.
Otherwise an exception is thrown.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the given index does not lie in the valid range of 0 up to
the result of
XAccessibleRelationSet::getAccessibleChildCount() -1.
|
|
deselectSelectedAccessibleChild
void
deselectSelectedAccessibleChild( |
[in] long
raises(
|
nSelectedChildIndex )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Removes the specified child from the set of this object's
selected children. Note that not all applications support
deselection: calls to this method may be silently ignored.
- Parameter nSelectedChildIndex
-
This index refers to all children not just the selected ones.
If the specified child is not selected or it can not be
deselected for any reason then the method call is silently
ignored.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if the given index does not lie in the valid range of 0 up to,
but not including, the result of
getAccessibleChildCount() .
|
|
Top of Page
Copyright © 2003 Sun Microsystems, Inc.