atk.state_set

Module for [StateSet] class

Types 3

An AtkStateSet contains the states of an object.

An AtkStateSet is a read-only representation of the full set of #AtkStates that apply to an object at a given time. This set is not meant to be modified, but rather created when #atk.object.ObjectWrap.refStateSet is called.

Methods
GType _getGType() static nothrow
GType _gType() @property nothrow
StateSet self() nothrowReturns `this`, for use in `with` statements.
StateSetGidBuilder builder() static nothrowGet builder for [atk.state_set.StateSet] Returns: New builder object
bool addState(atk.types.StateType type) nothrowAdds the state of the specified type to the state set if it is not already present.
void addStates(atk.types.StateType[] types) nothrowAdds the states of the specified types to the state set.
atk.state_set.StateSet andSets(atk.state_set.StateSet compareSet) nothrowConstructs the intersection of the two sets, returning null if the intersection is empty.
void clearStates() nothrowRemoves all states from the state set.
bool containsState(atk.types.StateType type) nothrowChecks whether the state for the specified type is in the specified set.
bool containsStates(atk.types.StateType[] types) nothrowChecks whether the states for all the specified types are in the specified set.
bool isEmpty() nothrowChecks whether the state set is empty, i.e. has no states set. Returns: true if set has no states set, otherwise false
atk.state_set.StateSet orSets(atk.state_set.StateSet compareSet) nothrowConstructs the union of the two sets.
bool removeState(atk.types.StateType type) nothrowRemoves the state for the specified type from the state set.
atk.state_set.StateSet xorSets(atk.state_set.StateSet compareSet) nothrowConstructs the exclusive-or of the two sets, returning null is empty. The set returned by this operation contains the states in exactly one of the two sets.
Constructors
this(void * ptr, Flag!"Take" take)
this()Creates a new empty state set. Returns: a new #AtkStateSet

Fluent builder implementation template for atk.state_set.StateSet

Fluent builder for atk.state_set.StateSet

Methods
StateSet build() nothrowCreate object from builder. Returns: New object