AtkRelationSet

Name

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

Synopsis



AtkRelationSet* atk_relation_set_new        (void);
gboolean    atk_relation_set_contains       (AtkRelationSet *set,
                                             AtkRelationType relationship);
void        atk_relation_set_remove         (AtkRelationSet *set,
                                             AtkRelation *relation);
void        atk_relation_set_add            (AtkRelationSet *set,
                                             AtkRelation *relation);
gint        atk_relation_set_get_n_relations
                                            (AtkRelationSet *set);
AtkRelation* atk_relation_set_get_relation  (AtkRelationSet *set,
                                             gint i);
AtkRelation* atk_relation_set_get_relation_by_type
                                            (AtkRelationSet *set,
                                             AtkRelationType relationship);

Description

Details

atk_relation_set_new ()

AtkRelationSet* atk_relation_set_new        (void);

Creates a new empty relation set.


atk_relation_set_contains ()

gboolean    atk_relation_set_contains       (AtkRelationSet *set,
                                             AtkRelationType relationship);

Determines whether the relation set contains a relation that matches the specified type.


atk_relation_set_remove ()

void        atk_relation_set_remove         (AtkRelationSet *set,
                                             AtkRelation *relation);

Removes a relation from the relation set. This function unref's the AtkRelation so it will be deleted unless there is another reference to it.


atk_relation_set_add ()

void        atk_relation_set_add            (AtkRelationSet *set,
                                             AtkRelation *relation);

Add 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 when the AtkRelationSet is destroyed.


atk_relation_set_get_n_relations ()

gint        atk_relation_set_get_n_relations
                                            (AtkRelationSet *set);

Determines the number of relations in a relation set.


atk_relation_set_get_relation ()

AtkRelation* atk_relation_set_get_relation  (AtkRelationSet *set,
                                             gint i);

Determines the relation at the specified position in the relation set.


atk_relation_set_get_relation_by_type ()

AtkRelation* atk_relation_set_get_relation_by_type
                                            (AtkRelationSet *set,
                                             AtkRelationType relationship);

Finds a relation that matches the specified type.