Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Atk.Objects.StateSet
Contents
Description
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_ref_state_set
() is called.
- newtype StateSet = StateSet (ManagedPtr StateSet)
- class GObject o => IsStateSet o
- toStateSet :: (MonadIO m, IsStateSet o) => o -> m StateSet
- noStateSet :: Maybe StateSet
- data StateSetAddStateMethodInfo
- stateSetAddState :: (HasCallStack, MonadIO m, IsStateSet a) => a -> StateType -> m Bool
- data StateSetAddStatesMethodInfo
- stateSetAddStates :: (HasCallStack, MonadIO m, IsStateSet a) => a -> [StateType] -> m ()
- data StateSetAndSetsMethodInfo
- stateSetAndSets :: (HasCallStack, MonadIO m, IsStateSet a, IsStateSet b) => a -> b -> m StateSet
- data StateSetClearStatesMethodInfo
- stateSetClearStates :: (HasCallStack, MonadIO m, IsStateSet a) => a -> m ()
- data StateSetContainsStateMethodInfo
- stateSetContainsState :: (HasCallStack, MonadIO m, IsStateSet a) => a -> StateType -> m Bool
- data StateSetContainsStatesMethodInfo
- stateSetContainsStates :: (HasCallStack, MonadIO m, IsStateSet a) => a -> [StateType] -> m Bool
- data StateSetIsEmptyMethodInfo
- stateSetIsEmpty :: (HasCallStack, MonadIO m, IsStateSet a) => a -> m Bool
- stateSetNew :: (HasCallStack, MonadIO m) => m StateSet
- data StateSetOrSetsMethodInfo
- stateSetOrSets :: (HasCallStack, MonadIO m, IsStateSet a, IsStateSet b) => a -> b -> m (Maybe StateSet)
- data StateSetRemoveStateMethodInfo
- stateSetRemoveState :: (HasCallStack, MonadIO m, IsStateSet a) => a -> StateType -> m Bool
- data StateSetXorSetsMethodInfo
- stateSetXorSets :: (HasCallStack, MonadIO m, IsStateSet a, IsStateSet b) => a -> b -> m StateSet
Exported types
Constructors
StateSet (ManagedPtr StateSet) |
Instances
GObject StateSet # | |
IsObject StateSet # | |
IsStateSet StateSet # | |
((~) * info (ResolveStateSetMethod t StateSet), MethodInfo * info StateSet p) => IsLabel t (StateSet -> p) # | |
((~) * info (ResolveStateSetMethod t StateSet), MethodInfo * info StateSet p) => IsLabelProxy t (StateSet -> p) # | |
HasAttributeList * StateSet # | |
type AttributeList StateSet # | |
type SignalList StateSet # | |
class GObject o => IsStateSet o #
Instances
(GObject a, UnknownAncestorError Constraint StateSet a) => IsStateSet a # | |
IsStateSet StateSet # | |
toStateSet :: (MonadIO m, IsStateSet o) => o -> m StateSet #
noStateSet :: Maybe StateSet #
Methods
addState
data StateSetAddStateMethodInfo #
Instances
((~) * signature (StateType -> m Bool), MonadIO m, IsStateSet a) => MethodInfo * StateSetAddStateMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a) | |
=> a |
|
-> StateType |
|
-> m Bool | Returns: |
Adds the state of the specified type to the state set if it is not already present.
Note that because an StateSet
is a read-only object, this method should
be used to add a state to a newly-created set which will then be returned by
atk_object_ref_state_set
. It should not be used to modify the existing state
of an object. See also atk_object_notify_state_change
.
addStates
data StateSetAddStatesMethodInfo #
Instances
((~) * signature ([StateType] -> m ()), MonadIO m, IsStateSet a) => MethodInfo * StateSetAddStatesMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a) | |
=> a |
|
-> [StateType] |
|
-> m () |
Adds the states of the specified types to the state set.
Note that because an StateSet
is a read-only object, this method should
be used to add states to a newly-created set which will then be returned by
atk_object_ref_state_set
. It should not be used to modify the existing state
of an object. See also atk_object_notify_state_change
.
andSets
data StateSetAndSetsMethodInfo #
Instances
((~) * signature (b -> m StateSet), MonadIO m, IsStateSet a, IsStateSet b) => MethodInfo * StateSetAndSetsMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a, IsStateSet b) | |
=> a |
|
-> b |
|
-> m StateSet | Returns: a new |
Constructs the intersection of the two sets, returning Nothing
if the
intersection is empty.
clearStates
data StateSetClearStatesMethodInfo #
Instances
((~) * signature (m ()), MonadIO m, IsStateSet a) => MethodInfo * StateSetClearStatesMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a) | |
=> a |
|
-> m () |
Removes all states from the state set.
containsState
data StateSetContainsStateMethodInfo #
Instances
((~) * signature (StateType -> m Bool), MonadIO m, IsStateSet a) => MethodInfo * StateSetContainsStateMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a) | |
=> a |
|
-> StateType |
|
-> m Bool | Returns: |
Checks whether the state for the specified type is in the specified set.
containsStates
data StateSetContainsStatesMethodInfo #
Instances
((~) * signature ([StateType] -> m Bool), MonadIO m, IsStateSet a) => MethodInfo * StateSetContainsStatesMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a) | |
=> a |
|
-> [StateType] |
|
-> m Bool | Returns: |
Checks whether the states for all the specified types are in the specified set.
isEmpty
data StateSetIsEmptyMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m, IsStateSet a) => MethodInfo * StateSetIsEmptyMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a) | |
=> a |
|
-> m Bool |
Checks whether the state set is empty, i.e. has no states set.
new
Arguments
:: (HasCallStack, MonadIO m) | |
=> m StateSet | Returns: a new |
Creates a new empty state set.
orSets
data StateSetOrSetsMethodInfo #
Instances
((~) * signature (b -> m (Maybe StateSet)), MonadIO m, IsStateSet a, IsStateSet b) => MethodInfo * StateSetOrSetsMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a, IsStateSet b) | |
=> a |
|
-> b |
|
-> m (Maybe StateSet) | Returns: a new |
Constructs the union of the two sets.
removeState
data StateSetRemoveStateMethodInfo #
Instances
((~) * signature (StateType -> m Bool), MonadIO m, IsStateSet a) => MethodInfo * StateSetRemoveStateMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a) | |
=> a |
|
-> StateType |
|
-> m Bool | Returns: |
Removes the state for the specified type from the state set.
Note that because an StateSet
is a read-only object, this method should
be used to remove a state to a newly-created set which will then be returned
by atk_object_ref_state_set
. It should not be used to modify the existing
state of an object. See also atk_object_notify_state_change
.
xorSets
data StateSetXorSetsMethodInfo #
Instances
((~) * signature (b -> m StateSet), MonadIO m, IsStateSet a, IsStateSet b) => MethodInfo * StateSetXorSetsMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsStateSet a, IsStateSet b) | |
=> a |
|
-> b |
|
-> m StateSet | Returns: a new |
Constructs the exclusive-or of the two sets, returning Nothing
is empty.
The set returned by this operation contains the states in exactly
one of the two sets.