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