docs/tmpl/atkrelationset.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkRelationSet
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A set of AtkRelations, normally the set of AtkRelations which an AtkObject has.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The AtkRelationSet held by an object establishes its relationships with
  10 objects beyond the normal "parent/child" hierarchical relationships that all
  11 user interface objects have.  AtkRelationSets establish whether objects are
  12 labelled or controlled by other components, share group membership with other
  13 components (for instance within a radio-button group), or share content which
  14 "flows" between them, among other types of possible relationships.
  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 AtkRelationSet ##### -->
  29 <para>
  30 The AtkRelationSet structure should not be accessed directly.
  31
  32 </para>
  33
  34
  35 <!-- ##### FUNCTION atk_relation_set_new ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @void:
  41 @Returns:
  42
  43
  44 <!-- ##### FUNCTION atk_relation_set_contains ##### -->
  45 <para>
  46
  47 </para>
  48
  49 @set:
  50 @relationship:
  51 @Returns:
  52
  53
  54 <!-- ##### FUNCTION atk_relation_set_remove ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @set:
  60 @relation:
  61
  62
  63 <!-- ##### FUNCTION atk_relation_set_add ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @set:
  69 @relation:
  70
  71
  72 <!-- ##### FUNCTION atk_relation_set_get_n_relations ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @set:
  78 @Returns:
  79
  80
  81 <!-- ##### FUNCTION atk_relation_set_get_relation ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @set:
  87 @i:
  88 @Returns:
  89
  90
  91 <!-- ##### FUNCTION atk_relation_set_get_relation_by_type ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @set:
  97 @relationship:
  98 @Returns:
  99
 100
 101 <!-- ##### FUNCTION atk_relation_set_add_relation_by_type ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @set:
 107 @relationship:
 108 @target:
 109
 110