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

class GObject o => IsRelation o

Instances

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

IsRelation Relation

toRelation :: (MonadIO m, IsRelation o) => o -> m Relation

noRelation :: Maybe Relation

Methods

addTarget

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

relationGetRelationType

Arguments

:: (HasCallStack, MonadIO m, IsRelation a)

=> a

relation: an Relation

-> m RelationType

Returns: the type of relation

Gets the type of relation

getTarget

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

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

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

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

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

target

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

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

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

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