xml/org.freedesktop.atspi.Relation.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3 <tp:enum name="RelationType" type="u">
   4   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
   5     <p>RelationType specifies a relationship between objects (possibly one-to-many or many-to-one)
   6       outside of the normal parent/child hierarchical relationship.  It allows better semantic
   7       identification of how objects are associated with one another.
   8       For instance the RELATION_LABELLED_BY relationship may be used to identify labelling information
   9       that should accompany the accessibleName property when presenting an object's content or identity
  10       to the end user.  Similarly, RELATION_CONTROLLER_FOR can be used to further specify the context
  11       in which a valuator is useful, and/or the other UI components which are directly effected by
  12       user interactions with the valuator. Common examples include association of scrollbars with
  13       the viewport or panel which they control.</p>
  14   </tp:docstring>
  15   <tp:enumvalue suffix="RELATION_NULL">
  16   <tp:docstring>
  17     Not a meaningful relationship; clients should not normally encounter this RelationType value.
  18   </tp:docstring>
  19   </tp:enumvalue>
  20   <tp:enumvalue suffix="RELATION_LABEL_FOR" value="1">
  21   <tp:docstring>
  22     Object is a label for one or more other objects.
  23   </tp:docstring>
  24   </tp:enumvalue>
  25   <tp:enumvalue suffix="RELATION_LABELLED_BY" value="2">
  26   <tp:docstring>
  27     Object is labelled by one or more other objects.
  28   </tp:docstring>
  29   </tp:enumvalue>
  30   <tp:enumvalue suffix="RELATION_CONTROLLER_FOR" value="3">
  31   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  32     <p>Object is an interactive object which modifies the state, onscreen location, or other attributes
  33       of one or more target objects. </p>
  34   </tp:docstring>
  35   </tp:enumvalue>
  36   <tp:enumvalue suffix="RELATION_CONTROLLED_BY" value="4">
  37   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  38     <p>Object state, position, etc. is modified/controlled by user interaction with one or
  39       more other objects.   For instance a viewport or scroll pane may be CONTROLLED_BY scrollbars. </p>
  40   </tp:docstring>
  41   </tp:enumvalue>
  42   <tp:enumvalue suffix="RELATION_MEMBER_OF" value="5">
  43   <tp:docstring>
  44     Object has a grouping relationship (e.g. 'same group as') to one or more other objects.
  45   </tp:docstring>
  46   </tp:enumvalue>
  47   <tp:enumvalue suffix="RELATION_TOOLTIP_FOR" value="6">
  48   <tp:docstring>
  49     Object is a tooltip associated with another object.
  50   </tp:docstring>
  51   </tp:enumvalue>
  52   <tp:enumvalue suffix="RELATION_NODE_CHILD_OF" value="7">
  53   <tp:docstring>
  54     Reserved for future use.
  55   </tp:docstring>
  56   </tp:enumvalue>
  57   <tp:enumvalue suffix="RELATION_EXTENDED" value="8">
  58   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  59     <p>Used to indicate that a relationship exists, but its type is not specified in the enumeration
  60       and must be obtained via a call to getRelationTypeName.  </p>
  61   </tp:docstring>
  62   </tp:enumvalue>
  63   <tp:enumvalue suffix="RELATION_FLOWS_TO" value="9">
  64   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  65     <p>Object renders content which flows logically to another object.
  66       For instance, text in a paragraph may flow to another object which is not the
  67       'next sibling' in the accessibility hierarchy. </p>
  68   </tp:docstring>
  69   </tp:enumvalue>
  70   <tp:enumvalue suffix="RELATION_FLOWS_FROM" value="10">
  71   <tp:docstring>
  72     Reciprocal of RELATION_FLOWS_TO.
  73   </tp:docstring>
  74   </tp:enumvalue>
  75   <tp:enumvalue suffix="RELATION_SUBWINDOW_OF" value="11">
  76   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  77     <p>Object is visually and semantically considered a subwindow of another object, even though
  78       it is not the object's child.  Useful when dealing with embedded applications and other cases
  79       where the widget hierarchy does not map cleanly to the onscreen presentation.  </p>
  80   </tp:docstring>
  81   </tp:enumvalue>
  82   <tp:enumvalue suffix="RELATION_EMBEDS" value="12">
  83   <tp:docstring>
  84     Similar to SUBWINDOW_OF, but specifically used for cross-process embedding.
  85   </tp:docstring>
  86   </tp:enumvalue>
  87   <tp:enumvalue suffix="RELATION_EMBEDDED_BY" value="13">
  88   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  89     <p>Reciprocal of RELATION_EMBEDS; Used to denote content rendered by embedded renderers that
  90       live in a separate process space from the embedding context.  </p>
  91   </tp:docstring>
  92   </tp:enumvalue>
  93   <tp:enumvalue suffix="RELATION_POPUP_FOR" value="14">
  94   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  95     <p>Denotes that the object is a transient window or frame associated with another onscreen object.
  96       Similar to TOOLTIP_FOR, but more general.  Useful for windows which are technically
  97       toplevels but which, for one or more reasons, do not explicitly cause their associated
  98       window to lose 'window focus'. Creation of a ROLE_WINDOW object with the POPUP_FOR relation
  99       usually requires some presentation action on the part of assistive technology clients, even though
 100       the previous toplevel ROLE_FRAME object may still be the active window.  </p>
 101   </tp:docstring>
 102   </tp:enumvalue>
 103   <tp:enumvalue suffix="RELATION_PARENT_WINDOW_OF" value="15">
 104   <tp:docstring>
 105     This is the reciprocal relation to RELATION_POPUP_FOR.
 106   </tp:docstring>
 107   </tp:enumvalue>
 108   <tp:enumvalue suffix="RELATION_DESCRIPTION_FOR" value="16">
 109   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 110     <p>Indicates that an object provides descriptive information
 111       about another object; more verbose than RELATION_LABEL_FOR. </p>
 112   </tp:docstring>
 113   </tp:enumvalue>
 114   <tp:enumvalue suffix="RELATION_DESCRIBED_BY" value="17">
 115   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 116     <p>Indicates that another object provides descriptive information
 117       about this object; more verbose than RELATION_LABELLED_BY. </p>
 118   </tp:docstring>
 119   </tp:enumvalue>
 120   <tp:enumvalue suffix="RELATION_LAST_DEFINED" value="18">
 121   <tp:docstring>
 122     Do not use as a parameter value, used to determine the size of the enumeration.
 123   </tp:docstring>
 124   </tp:enumvalue>
 125 </tp:enum>
 126 </node>