docs/tmpl/atkrelation.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkRelation
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An object usaed to describe a relation between a object and one or more
   6 other objects.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 An AtkRelation describes a relation between the object and one or more
  11 other objects. The actual relations that an object has with other objects
  12 are defined as an AtkRelationSet, which is a set of AtkRelations.
  13
  14
  15 </para>
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18 <para>
  19
  20 </para>
  21
  22 <!-- ##### STRUCT AtkRelation ##### -->
  23 <para>
  24
  25 </para>
  26
  27 @parent:
  28 @target:
  29 @relationship:
  30
  31 <!-- ##### ENUM AtkRelationType ##### -->
  32 <para>
  33
  34 </para>
  35
  36 @ATK_RELATION_NULL:
  37 @ATK_RELATION_CONTROLLED_BY:
  38 @ATK_RELATION_CONTROLLER_FOR:
  39 @ATK_RELATION_LABEL_FOR:
  40 @ATK_RELATION_LABELLED_BY:
  41 @ATK_RELATION_MEMBER_OF:
  42 @ATK_RELATION_NODE_CHILD_OF:
  43 @ATK_RELATION_LAST_DEFINED:
  44
  45 <!-- ##### FUNCTION atk_relation_type_register ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @name:
  51 @Returns:
  52
  53
  54 <!-- ##### FUNCTION atk_relation_type_get_name ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @type:
  60 @Returns:
  61
  62
  63 <!-- ##### FUNCTION atk_relation_type_for_name ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @name:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION atk_relation_new ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @targets:
  78 @n_targets:
  79 @relationship:
  80 @Returns:
  81
  82
  83 <!-- ##### FUNCTION atk_relation_get_relation_type ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @relation:
  89 @Returns:
  90
  91
  92 <!-- ##### FUNCTION atk_relation_get_target ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @relation:
  98 @Returns:
  99
 100