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 <!-- ##### SECTION Stability_Level ##### -->
  23
  24
  25 <!-- ##### SECTION Image ##### -->
  26
  27
  28 <!-- ##### STRUCT AtkRelation ##### -->
  29 <para>
  30 The AtkRelation structure should not be accessed directly.
  31
  32 </para>
  33
  34
  35 <!-- ##### ARG AtkRelation:relation-type ##### -->
  36 <para>
  37
  38 </para>
  39
  40 <!-- ##### ARG AtkRelation:target ##### -->
  41 <para>
  42
  43 </para>
  44
  45 <!-- ##### ENUM AtkRelationType ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @ATK_RELATION_NULL:
  51 @ATK_RELATION_CONTROLLED_BY:
  52 @ATK_RELATION_CONTROLLER_FOR:
  53 @ATK_RELATION_LABEL_FOR:
  54 @ATK_RELATION_LABELLED_BY:
  55 @ATK_RELATION_MEMBER_OF:
  56 @ATK_RELATION_NODE_CHILD_OF:
  57 @ATK_RELATION_FLOWS_TO:
  58 @ATK_RELATION_FLOWS_FROM:
  59 @ATK_RELATION_SUBWINDOW_OF:
  60 @ATK_RELATION_EMBEDS:
  61 @ATK_RELATION_EMBEDDED_BY:
  62 @ATK_RELATION_POPUP_FOR:
  63 @ATK_RELATION_PARENT_WINDOW_OF:
  64 @ATK_RELATION_DESCRIBED_BY:
  65 @ATK_RELATION_DESCRIPTION_FOR:
  66 @ATK_RELATION_NODE_PARENT_OF:
  67 @ATK_RELATION_LAST_DEFINED:
  68
  69 <!-- ##### FUNCTION atk_relation_type_register ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @name:
  75 @Returns:
  76
  77
  78 <!-- ##### FUNCTION atk_relation_type_get_name ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @type:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION atk_relation_type_for_name ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @name:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION atk_relation_new ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @targets:
 102 @n_targets:
 103 @relationship:
 104 @Returns:
 105
 106
 107 <!-- ##### FUNCTION atk_relation_get_relation_type ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @relation:
 113 @Returns:
 114
 115
 116 <!-- ##### FUNCTION atk_relation_get_target ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @relation:
 122 @Returns:
 123
 124
 125 <!-- ##### FUNCTION atk_relation_add_target ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @relation:
 131 @target:
 132
 133