LibreOffice
LibreOffice 7.4 SDK API Reference
|
Implement this interface to represent a set of states. More...
import"XAccessibleStateSet.idl";
Public Member Functions | |
boolean | isEmpty () |
Checks whether the current state set is empty. More... | |
boolean | contains ([in] short aState) |
Checks if the given state is a member of the state set of the called object. More... | |
boolean | containsAll ([in] sequence< short > aStateSet) |
Checks if all of the given states are in the state set of the called object. More... | |
sequence< short > | getStates () |
Get all currently set states as a sequence of state ids. More... | |
Public Member Functions inherited from XInterface | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. More... | |
void | acquire () |
increases the reference counter by one. More... | |
void | release () |
decreases the reference counter by one. More... | |
Implement this interface to represent a set of states.
The interface XAccessibleStateSet represents a set of states of an accessible object. It can hold any combination of states defined by the constants collection AccessibleStateType.
boolean contains | ( | [in] short | aState | ) |
Checks if the given state is a member of the state set of the called object.
aState | The state for which to check membership. This has to be one of the constants of AccessibleStateType. |
TRUE
if the given state is a member of this object's state set and FALSE
otherwise. boolean containsAll | ( | [in] sequence< short > | aStateSet | ) |
Checks if all of the given states are in the state set of the called object.
aStateSet | This sequence of states is interpreted as set and every of its members, duplicates are ignored, is checked for membership in this object's state set. Each state has to be one of the constants of AccessibleStateType. |
TRUE
if all states of the given state set are members of this object's state set. FALSE
is returned if at least one of the states in the given state is not a member of this object's state set. sequence<short> getStates | ( | ) |
Get all currently set states as a sequence of state ids.
The purpose of this function is to reduce the communication between accessibility objects and AT. Without this function an AT-Tool had to call contains() for every state type. Now a single call is sufficient.
boolean isEmpty | ( | ) |
Checks whether the current state set is empty.
TRUE
if there is no state in this state set and FALSE
if there is at least one set state in it.