| 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.Relation
Description
An object used to describe a relation between a object and one or more other objects.
An AtkRelation describes a relation between an object and one or more other objects. The actual relations that an object has with other objects are defined as an AtkRelationSet, which is a set of AtkRelations.
Synopsis
- newtype Relation = Relation (ManagedPtr Relation)
- class (GObject o, IsDescendantOf Relation o) => IsRelation o
- toRelation :: (MonadIO m, IsRelation o) => o -> m Relation
- type family ResolveRelationMethod (t :: Symbol) o where ...
- data RelationAddTargetMethodInfo
- relationAddTarget :: (HasCallStack, MonadIO m, IsRelation a, IsObject b) => a -> b -> m ()
- data RelationGetRelationTypeMethodInfo
- relationGetRelationType :: (HasCallStack, MonadIO m, IsRelation a) => a -> m RelationType
- data RelationGetTargetMethodInfo
- relationGetTarget :: (HasCallStack, MonadIO m, IsRelation a) => a -> m [Object]
- relationNew :: (HasCallStack, MonadIO m) => [Object] -> RelationType -> m Relation
- data RelationRemoveTargetMethodInfo
- relationRemoveTarget :: (HasCallStack, MonadIO m, IsRelation a, IsObject b) => a -> b -> m Bool
- data RelationRelationTypePropertyInfo
- constructRelationRelationType :: (IsRelation o, MonadIO m) => RelationType -> m (GValueConstruct o)
- getRelationRelationType :: (MonadIO m, IsRelation o) => o -> m RelationType
- relationRelationType :: AttrLabelProxy "relationType"
- setRelationRelationType :: (MonadIO m, IsRelation o) => o -> RelationType -> m ()
- data RelationTargetPropertyInfo
- clearRelationTarget :: (MonadIO m, IsRelation o) => o -> m ()
- constructRelationTarget :: (IsRelation o, MonadIO m) => ValueArray -> m (GValueConstruct o)
- getRelationTarget :: (MonadIO m, IsRelation o) => o -> m (Maybe ValueArray)
- relationTarget :: AttrLabelProxy "target"
- setRelationTarget :: (MonadIO m, IsRelation o) => o -> ValueArray -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| Relation (ManagedPtr Relation) |
Instances
class (GObject o, IsDescendantOf Relation o) => IsRelation o Source #
Type class for types which can be safely cast to Relation, for instance with toRelation.
Instances
| (GObject o, IsDescendantOf Relation o) => IsRelation o Source # | |
Defined in GI.Atk.Objects.Relation | |
toRelation :: (MonadIO m, IsRelation o) => o -> m Relation Source #
Methods
Click to display all available methods, including inherited ones
Methods
addTarget, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, removeTarget, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getProperty, getQdata, getRelationType, getTarget.
Setters
type family ResolveRelationMethod (t :: Symbol) o where ... Source #
Equations
addTarget
data RelationAddTargetMethodInfo Source #
Instances
| (signature ~ (b -> m ()), MonadIO m, IsRelation a, IsObject b) => OverloadedMethod RelationAddTargetMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Relation Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationAddTargetMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Relation Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsRelation a, IsObject b) | |
| => a |
|
| -> b |
|
| -> m () |
Adds the specified AtkObject to the target for the relation, if it is
not already present. See also objectAddRelationship.
Since: 1.9
getRelationType
data RelationGetRelationTypeMethodInfo Source #
Instances
| (signature ~ m RelationType, MonadIO m, IsRelation a) => OverloadedMethod RelationGetRelationTypeMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Relation Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationGetRelationTypeMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Relation Methods | |
relationGetRelationType Source #
Arguments
| :: (HasCallStack, MonadIO m, IsRelation a) | |
| => a |
|
| -> m RelationType | Returns: the type of |
Gets the type of relation
getTarget
data RelationGetTargetMethodInfo Source #
Instances
| (signature ~ m [Object], MonadIO m, IsRelation a) => OverloadedMethod RelationGetTargetMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Relation Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationGetTargetMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Relation Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsRelation a) | |
| => a |
|
| -> m [Object] | Returns: the target list of |
Gets the target list of relation
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => [Object] |
|
| -> RelationType |
|
| -> m Relation | Returns: a pointer to a new |
Create a new relation for the specified key and the specified list
of targets. See also objectAddRelationship.
removeTarget
data RelationRemoveTargetMethodInfo Source #
Instances
| (signature ~ (b -> m Bool), MonadIO m, IsRelation a, IsObject b) => OverloadedMethod RelationRemoveTargetMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Relation Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo RelationRemoveTargetMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Relation Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsRelation a, IsObject b) | |
| => a |
|
| -> b |
|
| -> m Bool | Returns: TRUE if the removal is successful. |
Remove the specified AtkObject from the target for the relation.
Properties
relationType
No description available in the introspection data.
data RelationRelationTypePropertyInfo Source #
Instances
constructRelationRelationType :: (IsRelation o, MonadIO m) => RelationType -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “relation-type” property. This is rarely needed directly, but it is used by new.
getRelationRelationType :: (MonadIO m, IsRelation o) => o -> m RelationType Source #
Get the value of the “relation-type” property.
When overloading is enabled, this is equivalent to
get relation #relationType
relationRelationType :: AttrLabelProxy "relationType" Source #
setRelationRelationType :: (MonadIO m, IsRelation o) => o -> RelationType -> m () Source #
Set the value of the “relation-type” property.
When overloading is enabled, this is equivalent to
setrelation [ #relationType:=value ]
target
No description available in the introspection data.
data RelationTargetPropertyInfo Source #
Instances
| AttrInfo RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation Associated Types
Methods attrGet :: AttrBaseTypeConstraint RelationTargetPropertyInfo o => o -> IO (AttrGetType RelationTargetPropertyInfo) # attrSet :: (AttrBaseTypeConstraint RelationTargetPropertyInfo o, AttrSetTypeConstraint RelationTargetPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint RelationTargetPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint RelationTargetPropertyInfo o, AttrSetTypeConstraint RelationTargetPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint RelationTargetPropertyInfo o, AttrTransferTypeConstraint RelationTargetPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType RelationTargetPropertyInfo) # attrPut :: AttrBaseTypeConstraint RelationTargetPropertyInfo o => o -> AttrGetType RelationTargetPropertyInfo -> IO () # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation | |||||||||||||||||||||||||||||||||
| type AttrGetType RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation | |||||||||||||||||||||||||||||||||
| type AttrLabel RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation | |||||||||||||||||||||||||||||||||
| type AttrOrigin RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation | |||||||||||||||||||||||||||||||||
| type AttrTransferType RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint RelationTargetPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Relation | |||||||||||||||||||||||||||||||||
clearRelationTarget :: (MonadIO m, IsRelation o) => o -> m () Source #
Set the value of the “target” property to Nothing.
When overloading is enabled, this is equivalent to
clear #target
constructRelationTarget :: (IsRelation o, MonadIO m) => ValueArray -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “target” property. This is rarely needed directly, but it is used by new.
getRelationTarget :: (MonadIO m, IsRelation o) => o -> m (Maybe ValueArray) Source #
Get the value of the “target” property.
When overloading is enabled, this is equivalent to
get relation #target
relationTarget :: AttrLabelProxy "target" Source #
setRelationTarget :: (MonadIO m, IsRelation o) => o -> ValueArray -> m () Source #
Set the value of the “target” property.
When overloading is enabled, this is equivalent to
setrelation [ #target:=value ]