gi-atk
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

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

Exported types

newtype Relation Source #

Memory-managed wrapper type.

Constructors

Relation (ManagedPtr Relation) 

Instances

Instances details
Eq Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

GObject Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

ManagedPtrNewtype Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

TypedObject Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

Methods

glibType :: IO GType #

HasParentTypes Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

HasAttributeList Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

(info ~ ResolveRelationMethod t Relation, OverloadedMethod info Relation p, HasField t Relation p) => HasField (t :: Symbol) Relation (p :: Type) Source # 
Instance details

Defined in GI.Atk.Objects.Relation

Methods

getField :: Relation -> p #

(info ~ ResolveRelationMethod t Relation, OverloadedMethodInfo info Relation) => IsLabel t (MethodProxy info Relation) Source # 
Instance details

Defined in GI.Atk.Objects.Relation

(info ~ ResolveRelationMethod t Relation, OverloadedMethod info Relation p) => IsLabel t (Relation -> p) Source # 
Instance details

Defined in GI.Atk.Objects.Relation

Methods

fromLabel :: Relation -> p #

IsGValue (Maybe Relation) Source #

Convert Relation to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Atk.Objects.Relation

type AttributeList Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type ParentTypes Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type SignalList Relation Source # 
Instance details

Defined in GI.Atk.Objects.Relation

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

Instances details
(GObject o, IsDescendantOf Relation o) => IsRelation o Source # 
Instance details

Defined in GI.Atk.Objects.Relation

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

Cast to Relation, for types for which this is known to be safe. For general casts, use castTo.

Methods

type family ResolveRelationMethod (t :: Symbol) o where ... Source #

Equations

ResolveRelationMethod "addTarget" o = RelationAddTargetMethodInfo 
ResolveRelationMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolveRelationMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolveRelationMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolveRelationMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolveRelationMethod "getv" o = ObjectGetvMethodInfo 
ResolveRelationMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolveRelationMethod "notify" o = ObjectNotifyMethodInfo 
ResolveRelationMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolveRelationMethod "ref" o = ObjectRefMethodInfo 
ResolveRelationMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolveRelationMethod "removeTarget" o = RelationRemoveTargetMethodInfo 
ResolveRelationMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolveRelationMethod "stealData" o = ObjectStealDataMethodInfo 
ResolveRelationMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolveRelationMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolveRelationMethod "unref" o = ObjectUnrefMethodInfo 
ResolveRelationMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolveRelationMethod "getData" o = ObjectGetDataMethodInfo 
ResolveRelationMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolveRelationMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolveRelationMethod "getRelationType" o = RelationGetRelationTypeMethodInfo 
ResolveRelationMethod "getTarget" o = RelationGetTargetMethodInfo 
ResolveRelationMethod "setData" o = ObjectSetDataMethodInfo 
ResolveRelationMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolveRelationMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolveRelationMethod l o = MethodResolutionFailed l o :: Type 

addTarget

data RelationAddTargetMethodInfo Source #

Instances

Instances details
(signature ~ (b -> m ()), MonadIO m, IsRelation a, IsObject b) => OverloadedMethod RelationAddTargetMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Objects.Relation

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo RelationAddTargetMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Atk.Objects.Relation

relationAddTarget Source #

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

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

Instances

Instances details
(signature ~ m [Object], MonadIO m, IsRelation a) => OverloadedMethod RelationGetTargetMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Objects.Relation

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo RelationGetTargetMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Atk.Objects.Relation

relationGetTarget Source #

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

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

Instances

Instances details
(signature ~ (b -> m Bool), MonadIO m, IsRelation a, IsObject b) => OverloadedMethod RelationRemoveTargetMethodInfo a signature Source # 
Instance details

Defined in GI.Atk.Objects.Relation

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo RelationRemoveTargetMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Atk.Objects.Relation

relationRemoveTarget Source #

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

No description available in the introspection data.

data RelationRelationTypePropertyInfo Source #

Instances

Instances details
AttrInfo RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrAllowedOps RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrBaseTypeConstraint RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrGetType RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrLabel RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrOrigin RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrSetTypeConstraint RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrTransferType RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrTransferTypeConstraint RelationRelationTypePropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

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

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

set relation [ #relationType := value ]

target

No description available in the introspection data.

data RelationTargetPropertyInfo Source #

Instances

Instances details
AttrInfo RelationTargetPropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrAllowedOps RelationTargetPropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrBaseTypeConstraint RelationTargetPropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrGetType RelationTargetPropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrLabel RelationTargetPropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrOrigin RelationTargetPropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrSetTypeConstraint RelationTargetPropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrTransferType RelationTargetPropertyInfo Source # 
Instance details

Defined in GI.Atk.Objects.Relation

type AttrTransferTypeConstraint RelationTargetPropertyInfo Source # 
Instance details

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

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

Set the value of the “target” property. When overloading is enabled, this is equivalent to

set relation [ #target := value ]