AtkRelation

Name

AtkRelation -- defines the functional relationship between two AtkObjects

Synopsis



enum        AtkRelationType;
AtkRelationType atk_relation_type_register  (const gchar *name);
AtkRelation* atk_relation_new               (AtkObject **targets,
                                             gint n_targets,
                                             AtkRelationType relationship);
AtkRelationType atk_relation_get_relation_type
                                            (AtkRelation *relation);
GPtrArray*  atk_relation_get_target         (AtkRelation *relation);

Description

Defines the functional relationship between two AtkObjects.

Details

enum AtkRelationType

typedef enum
{
  ATK_RELATION_NULL = 0,
  ATK_RELATION_CONTROLLED_BY,
  ATK_RELATION_CONTROLLER_FOR,
  ATK_RELATION_LABEL_FOR,
  ATK_RELATION_LABELLED_BY,
  ATK_RELATION_MEMBER_OF,
  ATK_RELATION_LAST_DEFINED
} AtkRelationType;

The possible types of an AtkRelation


atk_relation_type_register ()

AtkRelationType atk_relation_type_register  (const gchar *name);

Associate name with a new AtkRelationType

name : a name string
Returns : an AtkRelationType associated with name


atk_relation_new ()

AtkRelation* atk_relation_new               (AtkObject **targets,
                                             gint n_targets,
                                             AtkRelationType relationship);

Create a new relation for the specified key and the specified list of targets.

targets : an array of pointers to AtkObjects
n_targets : number of AtkObjects pointed to by targets
relationship : an AtkRelationType with which to create the new AtkRelation
Returns : a pointer to a new AtkRelation


atk_relation_get_relation_type ()

AtkRelationType atk_relation_get_relation_type
                                            (AtkRelation *relation);

Gets the type of relation

relation : an AtkRelation
Returns : the type of relation


atk_relation_get_target ()

GPtrArray*  atk_relation_get_target         (AtkRelation *relation);

Gets the target list of relation

relation : an AtkRelation
Returns : the target list of relation