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_LAST_DEFINED:
  62
  63 <!-- ##### FUNCTION atk_relation_type_register ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @name:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION atk_relation_type_get_name ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @type:
  78 @Returns:
  79
  80
  81 <!-- ##### FUNCTION atk_relation_type_for_name ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @name:
  87 @Returns:
  88
  89
  90 <!-- ##### FUNCTION atk_relation_new ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @targets:
  96 @n_targets:
  97 @relationship:
  98 @Returns:
  99
 100
 101 <!-- ##### FUNCTION atk_relation_get_relation_type ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @relation:
 107 @Returns:
 108
 109
 110 <!-- ##### FUNCTION atk_relation_get_target ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @relation:
 116 @Returns:
 117
 118
 119 <!-- ##### FUNCTION atk_relation_add_target ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @relation:
 125 @target:
 126
 127