docs/tmpl/atkrelation.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkRelation
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An object used 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 an 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 The AtkRelation structure should not be accessed directly.
  25
  26 </para>
  27
  28
  29 <!-- ##### ENUM AtkRelationType ##### -->
  30 <para>
  31
  32 </para>
  33
  34 @ATK_RELATION_NULL:
  35 @ATK_RELATION_CONTROLLED_BY:
  36 @ATK_RELATION_CONTROLLER_FOR:
  37 @ATK_RELATION_LABEL_FOR:
  38 @ATK_RELATION_LABELLED_BY:
  39 @ATK_RELATION_MEMBER_OF:
  40 @ATK_RELATION_NODE_CHILD_OF:
  41 @ATK_RELATION_FLOWS_TO:
  42 @ATK_RELATION_FLOWS_FROM:
  43 @ATK_RELATION_SUBWINDOW_OF:
  44 @ATK_RELATION_EMBEDS:
  45 @ATK_RELATION_EMBEDDED_BY:
  46 @ATK_RELATION_LAST_DEFINED:
  47
  48 <!-- ##### FUNCTION atk_relation_type_register ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @name:
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION atk_relation_type_get_name ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @type:
  63 @Returns:
  64
  65
  66 <!-- ##### FUNCTION atk_relation_type_for_name ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @name:
  72 @Returns:
  73
  74
  75 <!-- ##### FUNCTION atk_relation_new ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @targets:
  81 @n_targets:
  82 @relationship:
  83 @Returns:
  84
  85
  86 <!-- ##### FUNCTION atk_relation_get_relation_type ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @relation:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION atk_relation_get_target ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @relation:
 101 @Returns:
 102
 103
 104 <!-- ##### ARG AtkRelation:relation-type ##### -->
 105 <para>
 106
 107 </para>
 108
 109 <!-- ##### ARG AtkRelation:target ##### -->
 110 <para>
 111
 112 </para>
 113