atk.StateSet — an atk.StateSet
determines a component's state set.
class atk.StateSet( |
Functionsdef atk.state_type_register(
name
)def atk.state_type_get_name(
type
)def atk.state_type_for_name(
name
)
An atk.StateSet
determines a component's state set. It is composed of a set of ATK
states specified using the Atk State Type Constants.
def is_empty()
Returns : | True if the set has no
states set, otherwise
False |
Checks whether the state set is empty, i.e. has no states set.
def add_state(type
)
| one of the Atk State Type Constants |
Returns : | True if the state for
type is not already in the
set. |
Add a new state for the specified type to the current state set if it is not already present.
def add_states(types
)
| a sequence of Atk State Type Constants. |
Add the states for the specified types to the current state set.
def contains_state(type
)
| one of the Atk State Type Constants. |
Returns : | True if
type is the state type is in the
set. |
Checks whether the state for the specified type is in the specified set.
def contains_states(types
)
| a sequence of Atk State Type Constants |
Returns : | True if all the states in
types are in the set. |
Checks whether the states for all the specified types are in the specified set.
def remove_state(type
)
| one of the Atk State Type Constants |
Returns : | True if
type was in the set. |
Removes the state for the specified type from the state set.
def and_sets(compare_set
)
| another atk.StateSet |
Returns : | a new atk.StateSet
which is the intersection of the two sets. |
Constructs the intersection of the two sets, returning
None
if the intersection is empty.
def or_sets(compare_set
)
| another atk.StateSet |
Returns : | a new atk.StateSet
which is the union of the two sets, returning
None is empty. |
Constructs the union of the two sets.
def xor_sets(compare_set
)
| another atk.StateSet |
Returns : | a new atk.StateSet
which contains the states which are in exactly one of the two
sets. |
Constructs the exclusive-or of the two sets, returning
None
is empty. The set returned by this operation
contains the states in exactly one of the two sets.
def atk.state_type_register(name
)
| a character string describing the new state. |
Returns : | a new state type value for the new state. |
Registers a new object state and adds it to the Atk State Type Constants.
def atk.state_type_get_name(type
)
| one of the Atk State Type Constants. |
Returns : | the string describing the state type |
Gets the description string describing the state type specified
bytype
.
def atk.state_type_for_name(name
)
| a character string state name |
Returns : | one of the Atk State Type Constants. |
Gets the state type corresponding to the description string
name
.