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.RelationSet
Contents
Description
The AtkRelationSet held by an object establishes its relationships with objects beyond the normal "parent/child" hierarchical relationships that all user interface objects have. AtkRelationSets establish whether objects are labelled or controlled by other components, share group membership with other components (for instance within a radio-button group), or share content which "flows" between them, among other types of possible relationships.
- newtype RelationSet = RelationSet (ManagedPtr RelationSet)
- class GObject o => IsRelationSet o
- toRelationSet :: (MonadIO m, IsRelationSet o) => o -> m RelationSet
- noRelationSet :: Maybe RelationSet
- data RelationSetAddMethodInfo
- relationSetAdd :: (HasCallStack, MonadIO m, IsRelationSet a, IsRelation b) => a -> b -> m ()
- data RelationSetAddRelationByTypeMethodInfo
- relationSetAddRelationByType :: (HasCallStack, MonadIO m, IsRelationSet a, IsObject b) => a -> RelationType -> b -> m ()
- data RelationSetContainsMethodInfo
- relationSetContains :: (HasCallStack, MonadIO m, IsRelationSet a) => a -> RelationType -> m Bool
- data RelationSetContainsTargetMethodInfo
- relationSetContainsTarget :: (HasCallStack, MonadIO m, IsRelationSet a, IsObject b) => a -> RelationType -> b -> m Bool
- data RelationSetGetNRelationsMethodInfo
- relationSetGetNRelations :: (HasCallStack, MonadIO m, IsRelationSet a) => a -> m Int32
- data RelationSetGetRelationMethodInfo
- relationSetGetRelation :: (HasCallStack, MonadIO m, IsRelationSet a) => a -> Int32 -> m Relation
- data RelationSetGetRelationByTypeMethodInfo
- relationSetGetRelationByType :: (HasCallStack, MonadIO m, IsRelationSet a) => a -> RelationType -> m Relation
- relationSetNew :: (HasCallStack, MonadIO m) => m RelationSet
- data RelationSetRemoveMethodInfo
- relationSetRemove :: (HasCallStack, MonadIO m, IsRelationSet a, IsRelation b) => a -> b -> m ()
Exported types
newtype RelationSet #
Constructors
RelationSet (ManagedPtr RelationSet) |
Instances
GObject RelationSet # | |
IsObject RelationSet # | |
IsRelationSet RelationSet # | |
((~) * info (ResolveRelationSetMethod t RelationSet), MethodInfo * info RelationSet p) => IsLabel t (RelationSet -> p) # | |
((~) * info (ResolveRelationSetMethod t RelationSet), MethodInfo * info RelationSet p) => IsLabelProxy t (RelationSet -> p) # | |
HasAttributeList * RelationSet # | |
type AttributeList RelationSet # | |
type SignalList RelationSet # | |
class GObject o => IsRelationSet o #
Instances
toRelationSet :: (MonadIO m, IsRelationSet o) => o -> m RelationSet #
Methods
add
data RelationSetAddMethodInfo #
Instances
((~) * signature (b -> m ()), MonadIO m, IsRelationSet a, IsRelation b) => MethodInfo * RelationSetAddMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsRelationSet a, IsRelation b) | |
=> a |
|
-> b |
|
-> m () |
Add a new relation to the current relation set if it is not already present. This function ref's the AtkRelation so the caller of this function should unref it to ensure that it will be destroyed when the AtkRelationSet is destroyed.
addRelationByType
data RelationSetAddRelationByTypeMethodInfo #
Instances
((~) * signature (RelationType -> b -> m ()), MonadIO m, IsRelationSet a, IsObject b) => MethodInfo * RelationSetAddRelationByTypeMethodInfo a signature # | |
relationSetAddRelationByType #
Arguments
:: (HasCallStack, MonadIO m, IsRelationSet a, IsObject b) | |
=> a |
|
-> RelationType |
|
-> b |
|
-> m () |
Add a new relation of the specified type with the specified target to the current relation set if the relation set does not contain a relation of that type. If it is does contain a relation of that typea the target is added to the relation.
Since: 1.9
contains
data RelationSetContainsMethodInfo #
Instances
((~) * signature (RelationType -> m Bool), MonadIO m, IsRelationSet a) => MethodInfo * RelationSetContainsMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsRelationSet a) | |
=> a |
|
-> RelationType |
|
-> m Bool | Returns: |
Determines whether the relation set contains a relation that matches the specified type.
containsTarget
data RelationSetContainsTargetMethodInfo #
Instances
((~) * signature (RelationType -> b -> m Bool), MonadIO m, IsRelationSet a, IsObject b) => MethodInfo * RelationSetContainsTargetMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsRelationSet a, IsObject b) | |
=> a |
|
-> RelationType |
|
-> b |
|
-> m Bool | Returns: |
Determines whether the relation set contains a relation that
matches the specified pair formed by type relationship
and object
target
.
getNRelations
data RelationSetGetNRelationsMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m, IsRelationSet a) => MethodInfo * RelationSetGetNRelationsMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsRelationSet a) | |
=> a |
|
-> m Int32 | Returns: an integer representing the number of relations in the set. |
Determines the number of relations in a relation set.
getRelation
data RelationSetGetRelationMethodInfo #
Instances
((~) * signature (Int32 -> m Relation), MonadIO m, IsRelationSet a) => MethodInfo * RelationSetGetRelationMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsRelationSet a) | |
=> a |
|
-> Int32 |
|
-> m Relation | Returns: a |
Determines the relation at the specified position in the relation set.
getRelationByType
data RelationSetGetRelationByTypeMethodInfo #
Instances
((~) * signature (RelationType -> m Relation), MonadIO m, IsRelationSet a) => MethodInfo * RelationSetGetRelationByTypeMethodInfo a signature # | |
relationSetGetRelationByType #
Arguments
:: (HasCallStack, MonadIO m, IsRelationSet a) | |
=> a |
|
-> RelationType |
|
-> m Relation | Returns: an |
Finds a relation that matches the specified type.
new
Arguments
:: (HasCallStack, MonadIO m) | |
=> m RelationSet | Returns: a new |
Creates a new empty relation set.
remove
data RelationSetRemoveMethodInfo #
Instances
((~) * signature (b -> m ()), MonadIO m, IsRelationSet a, IsRelation b) => MethodInfo * RelationSetRemoveMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsRelationSet a, IsRelation b) | |
=> a |
|
-> b |
|
-> m () |
Removes a relation from the relation set.
This function unref's the Relation
so it will be deleted unless there
is another reference to it.