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_POPUP_FOR:
  47 @ATK_RELATION_LAST_DEFINED:
  48
  49 <!-- ##### FUNCTION atk_relation_type_register ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @name:
  55 @Returns:
  56
  57
  58 <!-- ##### FUNCTION atk_relation_type_get_name ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @type:
  64 @Returns:
  65
  66
  67 <!-- ##### FUNCTION atk_relation_type_for_name ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @name:
  73 @Returns:
  74
  75
  76 <!-- ##### FUNCTION atk_relation_new ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @targets:
  82 @n_targets:
  83 @relationship:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION atk_relation_get_relation_type ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @relation:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION atk_relation_get_target ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @relation:
 102 @Returns:
 103
 104
 105 <!-- ##### ARG AtkRelation:relation-type ##### -->
 106 <para>
 107
 108 </para>
 109
 110 <!-- ##### ARG AtkRelation:target ##### -->
 111 <para>
 112
 113 </para>
 114