Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

Accessibility::StateSet Interface Reference

The StateSet interface encapsulates a collection of state information. More...

import "Accessibility_State.idl";

List of all members.

Public Member Functions

boolean contains (in StateType state)
 Query a StateSet for a specific StateType.
void add (in StateType state)
 Add a StateType to an existing StateSet, if not already present.
void remove (in StateType state)
 Remove a StateType to an existing StateSet, if it is present.
boolean equals (in StateSet stateSet)
 Compare two statesets for equivalence.
StateSet compare (in StateSet compareState)
 Compare two StateSet instances and obtain their differences.
boolean isEmpty ()


Detailed Description

The StateSet interface encapsulates a collection of state information.

It allows comparison of state information between object instances, and comparisons of an object's state with some hypothetical collection of states.

Definition at line 227 of file Accessibility_State.idl.


Member Function Documentation

boolean Accessibility::StateSet::contains in StateType  state  ) 
 

Query a StateSet for a specific StateType.

Parameters:
state the StateType being queried for.
Returns:
TRUE if the StateSet contains StateType state.

void Accessibility::StateSet::add in StateType  state  ) 
 

Add a StateType to an existing StateSet, if not already present.

void Accessibility::StateSet::remove in StateType  state  ) 
 

Remove a StateType to an existing StateSet, if it is present.

boolean Accessibility::StateSet::equals in StateSet  stateSet  ) 
 

Compare two statesets for equivalence.

Parameters:
stateSet the StateSet to be compared with this one.
Returns:
TRUE if the two StateSet objects are composed of the same StateTypes.

StateSet Accessibility::StateSet::compare in StateSet  compareState  ) 
 

Compare two StateSet instances and obtain their differences.

Returns:
a 'difference set', i.e. a StateSet consisting of those states not shared by the two sets being compared.

boolean Accessibility::StateSet::isEmpty  ) 
 

Returns:
TRUE if the StateSet contains no states.


The documentation for this interface was generated from the following file:
Generated on Fri Dec 2 15:20:47 2005 for AT_SPI_IDL by  doxygen 1.4.3