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