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
  28 <!-- ##### ENUM AtkRelationType ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @ATK_RELATION_NULL:
  34 @ATK_RELATION_CONTROLLED_BY:
  35 @ATK_RELATION_CONTROLLER_FOR:
  36 @ATK_RELATION_LABEL_FOR:
  37 @ATK_RELATION_LABELLED_BY:
  38 @ATK_RELATION_MEMBER_OF:
  39 @ATK_RELATION_NODE_CHILD_OF:
  40 @ATK_RELATION_LAST_DEFINED:
  41
  42 <!-- ##### FUNCTION atk_relation_type_register ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @name:
  48 @Returns:
  49
  50
  51 <!-- ##### FUNCTION atk_relation_type_get_name ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @type:
  57 @Returns:
  58
  59
  60 <!-- ##### FUNCTION atk_relation_type_for_name ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @name:
  66 @Returns:
  67
  68
  69 <!-- ##### FUNCTION atk_relation_new ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @targets:
  75 @n_targets:
  76 @relationship:
  77 @Returns:
  78
  79
  80 <!-- ##### FUNCTION atk_relation_get_relation_type ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @relation:
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION atk_relation_get_target ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @relation:
  95 @Returns:
  96
  97