GI.Atk.Objects.Relation

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.

Exported types

newtype Relation

Constructors

Relation (ManagedPtr Relation)

Instances

GObject Relation

Methods

gobjectType :: Relation -> IO GType

IsObject Relation

IsRelation Relation

((~) * info (ResolveRelationMethod t Relation), MethodInfo * info Relation p) => IsLabel t (Relation -> p)

Methods

fromLabel :: Proxy# Symbol t -> Relation -> p

((~) * info (ResolveRelationMethod t Relation), MethodInfo * info Relation p) => IsLabelProxy t (Relation -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Relation -> p

HasAttributeList * Relation

type AttributeList Relation

type AttributeList Relation

type SignalList Relation

type SignalList Relation

class GObject o => IsRelation o

Instances

(GObject a, UnknownAncestorError Constraint Relation a) => IsRelation a

IsRelation Relation

toRelation :: IsRelation o => o -> IO Relation

noRelation :: Maybe Relation

Methods

addTarget

data RelationAddTargetMethodInfo

Instances

((~) * signature (b -> m ()), MonadIO m, IsRelation a, IsObject b) => MethodInfo * RelationAddTargetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RelationAddTargetMethodInfo a -> signature -> s

relationAddTarget

Arguments

:: (HasCallStack, MonadIO m, IsRelation a, IsObject b)

=> a

relation: an Relation

-> b

target: an Object

-> 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

Instances

((~) * signature (m RelationType), MonadIO m, IsRelation a) => MethodInfo * RelationGetRelationTypeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RelationGetRelationTypeMethodInfo a -> signature -> s

relationGetRelationType

Arguments

:: (HasCallStack, MonadIO m, IsRelation a)

=> a

relation: an Relation

-> m RelationType

Returns: the type of relation

Gets the type of relation

getTarget

data RelationGetTargetMethodInfo

Instances

((~) * signature (m [Object]), MonadIO m, IsRelation a) => MethodInfo * RelationGetTargetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RelationGetTargetMethodInfo a -> signature -> s

relationGetTarget

Arguments

:: (HasCallStack, MonadIO m, IsRelation a)

=> a

relation: an Relation

-> m [Object]

Returns: the target list of relation

Gets the target list of relation

new

relationNew

Arguments

:: (HasCallStack, MonadIO m)

=> [Object]

targets: an array of pointers to AtkObjects

-> RelationType

relationship: an RelationType with which to create the new Relation

-> m Relation

Returns: a pointer to a new Relation

Create a new relation for the specified key and the specified list of targets. See also objectAddRelationship.

removeTarget

data RelationRemoveTargetMethodInfo

Instances

((~) * signature (b -> m Bool), MonadIO m, IsRelation a, IsObject b) => MethodInfo * RelationRemoveTargetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RelationRemoveTargetMethodInfo a -> signature -> s

relationRemoveTarget

Arguments

:: (HasCallStack, MonadIO m, IsRelation a, IsObject b)

=> a

relation: an Relation

-> b

target: an Object

-> m Bool

Returns: TRUE if the removal is successful.

Remove the specified AtkObject from the target for the relation.

Properties

relationType

data RelationRelationTypePropertyInfo

Instances

AttrInfo RelationRelationTypePropertyInfo

Associated Types

type AttrAllowedOps RelationRelationTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RelationRelationTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RelationRelationTypePropertyInfo :: * -> Constraint

type AttrGetType RelationRelationTypePropertyInfo :: *

type AttrLabel RelationRelationTypePropertyInfo :: Symbol

type AttrOrigin RelationRelationTypePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint RelationRelationTypePropertyInfo o => Proxy * RelationRelationTypePropertyInfo -> o -> IO (AttrGetType RelationRelationTypePropertyInfo)

attrSet :: (AttrBaseTypeConstraint RelationRelationTypePropertyInfo o, AttrSetTypeConstraint RelationRelationTypePropertyInfo b) => Proxy * RelationRelationTypePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint RelationRelationTypePropertyInfo o => Proxy * RelationRelationTypePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint RelationRelationTypePropertyInfo o, AttrSetTypeConstraint RelationRelationTypePropertyInfo b) => Proxy * RelationRelationTypePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin RelationRelationTypePropertyInfo

type AttrOrigin RelationRelationTypePropertyInfo = Relation

type AttrLabel RelationRelationTypePropertyInfo

type AttrLabel RelationRelationTypePropertyInfo = "relation-type"

type AttrGetType RelationRelationTypePropertyInfo

type AttrGetType RelationRelationTypePropertyInfo = RelationType

type AttrBaseTypeConstraint RelationRelationTypePropertyInfo

type AttrBaseTypeConstraint RelationRelationTypePropertyInfo = IsRelation

type AttrSetTypeConstraint RelationRelationTypePropertyInfo

type AttrSetTypeConstraint RelationRelationTypePropertyInfo = * ~ RelationType

type AttrAllowedOps RelationRelationTypePropertyInfo

type AttrAllowedOps RelationRelationTypePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructRelationRelationType :: IsRelation o => RelationType -> IO (GValueConstruct o)

getRelationRelationType :: (MonadIO m, IsRelation o) => o -> m RelationType

relationRelationType :: AttrLabelProxy "relationType"

setRelationRelationType :: (MonadIO m, IsRelation o) => o -> RelationType -> m ()

target

data RelationTargetPropertyInfo

Instances

AttrInfo RelationTargetPropertyInfo

Associated Types

type AttrAllowedOps RelationTargetPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RelationTargetPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RelationTargetPropertyInfo :: * -> Constraint

type AttrGetType RelationTargetPropertyInfo :: *

type AttrLabel RelationTargetPropertyInfo :: Symbol

type AttrOrigin RelationTargetPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint RelationTargetPropertyInfo o => Proxy * RelationTargetPropertyInfo -> o -> IO (AttrGetType RelationTargetPropertyInfo)

attrSet :: (AttrBaseTypeConstraint RelationTargetPropertyInfo o, AttrSetTypeConstraint RelationTargetPropertyInfo b) => Proxy * RelationTargetPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint RelationTargetPropertyInfo o => Proxy * RelationTargetPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint RelationTargetPropertyInfo o, AttrSetTypeConstraint RelationTargetPropertyInfo b) => Proxy * RelationTargetPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin RelationTargetPropertyInfo

type AttrOrigin RelationTargetPropertyInfo = Relation

type AttrLabel RelationTargetPropertyInfo

type AttrLabel RelationTargetPropertyInfo = "target"

type AttrGetType RelationTargetPropertyInfo

type AttrGetType RelationTargetPropertyInfo = Maybe ValueArray

type AttrBaseTypeConstraint RelationTargetPropertyInfo

type AttrBaseTypeConstraint RelationTargetPropertyInfo = IsRelation

type AttrSetTypeConstraint RelationTargetPropertyInfo

type AttrSetTypeConstraint RelationTargetPropertyInfo = * ~ ValueArray

type AttrAllowedOps RelationTargetPropertyInfo

type AttrAllowedOps RelationTargetPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

clearRelationTarget :: (MonadIO m, IsRelation o) => o -> m ()

constructRelationTarget :: IsRelation o => ValueArray -> IO (GValueConstruct o)

getRelationTarget :: (MonadIO m, IsRelation o) => o -> m (Maybe ValueArray)

relationTarget :: AttrLabelProxy "target"

setRelationTarget :: (MonadIO m, IsRelation o) => o -> ValueArray -> m ()