| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Atk.Objects.RelationSet
Description
A set of AtkRelations, normally the set of AtkRelations which an AtkObject has.
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.
Synopsis
- newtype RelationSet = RelationSet (ManagedPtr RelationSet)
- class (GObject o, IsDescendantOf RelationSet o) => IsRelationSet o
- toRelationSet :: (MonadIO m, IsRelationSet o) => o -> m RelationSet
- type family ResolveRelationSetMethod (t :: Symbol) o where ...
- 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 Source #
Memory-managed wrapper type.
Constructors
| RelationSet (ManagedPtr RelationSet) |
Instances
class (GObject o, IsDescendantOf RelationSet o) => IsRelationSet o Source #
Type class for types which can be safely cast to RelationSet, for instance with toRelationSet.
Instances
| (GObject o, IsDescendantOf RelationSet o) => IsRelationSet o Source # | |
Defined in GI.Atk.Objects.RelationSet | |
toRelationSet :: (MonadIO m, IsRelationSet o) => o -> m RelationSet Source #
Cast to RelationSet, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
add, addRelationByType, bindProperty, bindPropertyFull, contains, containsTarget, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, remove, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getNRelations, getProperty, getQdata, getRelation, getRelationByType.
Setters
type family ResolveRelationSetMethod (t :: Symbol) o where ... Source #
Equations
add
data RelationSetAddMethodInfo Source #
Instances
| (signature ~ (b -> m ()), MonadIO m, IsRelationSet a, IsRelation b) => OverloadedMethod RelationSetAddMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.RelationSet Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationSetAddMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.RelationSet Methods | |
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 Source #
Instances
| (signature ~ (RelationType -> b -> m ()), MonadIO m, IsRelationSet a, IsObject b) => OverloadedMethod RelationSetAddRelationByTypeMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.RelationSet Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationSetAddRelationByTypeMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.RelationSet Methods | |
relationSetAddRelationByType Source #
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 Source #
Instances
| (signature ~ (RelationType -> m Bool), MonadIO m, IsRelationSet a) => OverloadedMethod RelationSetContainsMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.RelationSet Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationSetContainsMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.RelationSet Methods | |
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 Source #
Instances
| (signature ~ (RelationType -> b -> m Bool), MonadIO m, IsRelationSet a, IsObject b) => OverloadedMethod RelationSetContainsTargetMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.RelationSet Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationSetContainsTargetMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.RelationSet Methods | |
relationSetContainsTarget Source #
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 Source #
Instances
| (signature ~ m Int32, MonadIO m, IsRelationSet a) => OverloadedMethod RelationSetGetNRelationsMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.RelationSet Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationSetGetNRelationsMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.RelationSet Methods | |
relationSetGetNRelations Source #
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 Source #
Instances
| (signature ~ (Int32 -> m Relation), MonadIO m, IsRelationSet a) => OverloadedMethod RelationSetGetRelationMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.RelationSet Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationSetGetRelationMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.RelationSet Methods | |
relationSetGetRelation Source #
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 Source #
Instances
| (signature ~ (RelationType -> m Relation), MonadIO m, IsRelationSet a) => OverloadedMethod RelationSetGetRelationByTypeMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.RelationSet Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationSetGetRelationByTypeMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.RelationSet Methods | |
relationSetGetRelationByType Source #
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 Source #
Instances
| (signature ~ (b -> m ()), MonadIO m, IsRelationSet a, IsRelation b) => OverloadedMethod RelationSetRemoveMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.RelationSet Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationSetRemoveMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.RelationSet Methods | |
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.