gi-atk-2.0.12: Atk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Atk.Objects.Relation

Contents

Description

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

Exported types

newtype Relation #

Constructors

Relation (ManagedPtr Relation) 

Instances

GObject Relation # 
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 SignalList Relation # 

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

Methods

addTarget

data RelationAddTargetMethodInfo #

Instances

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

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

data RelationGetTargetMethodInfo #

Instances

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

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 # 

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 # 
type AttrOrigin RelationRelationTypePropertyInfo # 
type AttrLabel RelationRelationTypePropertyInfo # 
type AttrGetType RelationRelationTypePropertyInfo # 
type AttrBaseTypeConstraint RelationRelationTypePropertyInfo # 
type AttrSetTypeConstraint RelationRelationTypePropertyInfo # 
type AttrAllowedOps RelationRelationTypePropertyInfo # 

target

data RelationTargetPropertyInfo #

Instances

AttrInfo RelationTargetPropertyInfo # 
type AttrOrigin RelationTargetPropertyInfo # 
type AttrLabel RelationTargetPropertyInfo # 
type AttrGetType RelationTargetPropertyInfo # 
type AttrBaseTypeConstraint RelationTargetPropertyInfo # 
type AttrSetTypeConstraint RelationTargetPropertyInfo # 
type AttrAllowedOps RelationTargetPropertyInfo # 

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

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