AtkRelation

Name

AtkRelation -- An object usaed to describe a relation between a object and one or more other objects.

Synopsis



struct      AtkRelation;
enum        AtkRelationType;
AtkRelationType atk_relation_type_register  (const gchar *name);
G_CONST_RETURN gchar* atk_relation_type_get_name
                                            (AtkRelationType type);
AtkRelationType atk_relation_type_for_name  (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

An AtkRelation describes a relation between the 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.

Details

struct AtkRelation

struct AtkRelation
{
  GObject parent;

  GPtrArray       *target;
  AtkRelationType relationship;
};


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_NODE_CHILD_OF,
  ATK_RELATION_LAST_DEFINED
} AtkRelationType;

Describes the type of the relation


atk_relation_type_register ()

AtkRelationType atk_relation_type_register  (const gchar *name);

Associate name with a new AtkRelationType


atk_relation_type_get_name ()

G_CONST_RETURN gchar* atk_relation_type_get_name
                                            (AtkRelationType type);

Gets the description string describing the AtkRelationType type.


atk_relation_type_for_name ()

AtkRelationType atk_relation_type_for_name  (const gchar *name);

Get the AtkRelationType type corresponding to a relation 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.


atk_relation_get_relation_type ()

AtkRelationType atk_relation_get_relation_type
                                            (AtkRelation *relation);

Gets the type of relation


atk_relation_get_target ()

GPtrArray*  atk_relation_get_target         (AtkRelation *relation);

Gets the target list of relation