atk.relation_set

Module for [RelationSet] class

class RelationSet RelationSetGidBuilder RelationSetGidBuilderImpl

Types 3

classRelationSet : gobject.object.ObjectWrap

A set of AtkRelations, normally the set of AtkRelations which an AtkObject has.

The AtkRelationSet held by an object establishes its relationships with objects beyond the normal "parent/child" hierarchical relationships that all user interface objects have. AtkRelationSets establish whether objects are labelled or controlled by other components, share group membership with other components (for instance within a radio-button group), or share content which "flows" between them, among other types of possible relationships.

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

RelationSet self() nothrowReturns `this`, for use in `with` statements.

RelationSetGidBuilder builder() static nothrowGet builder for [atk.relation_set.RelationSet] Returns: New builder object

void add(atk.relation.Relation relation) nothrowAdd a new relation to the current relation set if it is not already present. This function ref's the AtkRelation so the caller of this function should unref it to ensure that it will be destroyed w...

void addRelationByType(atk.types.RelationType relationship, atk.object.ObjectWrap target) nothrowAdd a new relation of the specified type with the specified target to the current relation set if the relation set does not contain a relation of that type. If it is does contain a relation of that...

bool contains(atk.types.RelationType relationship) nothrowDetermines whether the relation set contains a relation that matches the specified type.

bool containsTarget(atk.types.RelationType relationship, atk.object.ObjectWrap target) nothrowDetermines whether the relation set contains a relation that matches the specified pair formed by type relationship and object target.

int getNRelations() nothrowDetermines the number of relations in a relation set. Returns: an integer representing the number of relations in the set.

atk.relation.Relation getRelation(int i) nothrowDetermines the relation at the specified position in the relation set.

atk.relation.Relation getRelationByType(atk.types.RelationType relationship) nothrowFinds a relation that matches the specified type.

void remove(atk.relation.Relation relation) nothrowRemoves a relation from the relation set. This function unref's the #AtkRelation so it will be deleted unless there is another reference to it.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new empty relation set. Returns: a new #AtkRelationSet

classRelationSetGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

Fluent builder implementation template for atk.relation_set.RelationSet

classRelationSetGidBuilder : RelationSetGidBuilderImpl!RelationSetGidBuilder

Fluent builder for atk.relation_set.RelationSet

Methods

RelationSet build() nothrowCreate object from builder. Returns: New object