1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
3 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
5 <tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
7 <p>This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.</p>
12 <p>This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.</p>
17 <p>You should have received a copy of the GNU Library General Public
18 License along with this library; if not, write to the
19 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.</p>
22 <tp:enum name="RelationType" type="u">
23 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
24 <p>RelationType specifies a relationship between objects (possibly one-to-many or many-to-one)
25 outside of the normal parent/child hierarchical relationship. It allows better semantic
26 identification of how objects are associated with one another.
27 For instance the RELATION_LABELLED_BY relationship may be used to identify labelling information
28 that should accompany the accessibleName property when presenting an object's content or identity
29 to the end user. Similarly, RELATION_CONTROLLER_FOR can be used to further specify the context
30 in which a valuator is useful, and/or the other UI components which are directly effected by
31 user interactions with the valuator. Common examples include association of scrollbars with
32 the viewport or panel which they control.</p>
34 <tp:enumvalue suffix="RELATION_NULL">
36 Not a meaningful relationship; clients should not normally encounter this RelationType value.
39 <tp:enumvalue suffix="RELATION_LABEL_FOR" value="1">
41 Object is a label for one or more other objects.
44 <tp:enumvalue suffix="RELATION_LABELLED_BY" value="2">
46 Object is labelled by one or more other objects.
49 <tp:enumvalue suffix="RELATION_CONTROLLER_FOR" value="3">
50 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
51 <p>Object is an interactive object which modifies the state, onscreen location, or other attributes
52 of one or more target objects. </p>
55 <tp:enumvalue suffix="RELATION_CONTROLLED_BY" value="4">
56 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
57 <p>Object state, position, etc. is modified/controlled by user interaction with one or
58 more other objects. For instance a viewport or scroll pane may be CONTROLLED_BY scrollbars. </p>
61 <tp:enumvalue suffix="RELATION_MEMBER_OF" value="5">
63 Object has a grouping relationship (e.g. ¨same group as¨) to one or more other objects.
66 <tp:enumvalue suffix="RELATION_TOOLTIP_FOR" value="6">
68 Object is a tooltip associated with another object.
71 <tp:enumvalue suffix="RELATION_NODE_CHILD_OF" value="7">
73 Reserved for future use.
76 <tp:enumvalue suffix="RELATION_EXTENDED" value="8">
77 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
78 <p>Used to indicate that a relationship exists, but its type is not specified in the enumeration
79 and must be obtained via a call to getRelationTypeName. </p>
82 <tp:enumvalue suffix="RELATION_FLOWS_TO" value="9">
83 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
84 <p>Object renders content which flows logically to another object.
85 For instance, text in a paragraph may flow to another object which is not the
86 ¨next sibling¨ in the accessibility hierarchy. </p>
89 <tp:enumvalue suffix="RELATION_FLOWS_FROM" value="10">
91 Reciprocal of RELATION_FLOWS_TO.
94 <tp:enumvalue suffix="RELATION_SUBWINDOW_OF" value="11">
95 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
96 <p>Object is visually and semantically considered a subwindow of another object, even though
97 it is not the object's child. Useful when dealing with embedded applications and other cases
98 where the widget hierarchy does not map cleanly to the onscreen presentation. </p>
101 <tp:enumvalue suffix="RELATION_EMBEDS" value="12">
103 Similar to SUBWINDOW_OF, but specifically used for cross-process embedding.
106 <tp:enumvalue suffix="RELATION_EMBEDDED_BY" value="13">
107 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
108 <p>Reciprocal of RELATION_EMBEDS; Used to denote content rendered by embedded renderers that
109 live in a separate process space from the embedding context. </p>
112 <tp:enumvalue suffix="RELATION_POPUP_FOR" value="14">
113 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
114 <p>Denotes that the object is a transient window or frame associated with another onscreen object.
115 Similar to TOOLTIP_FOR, but more general. Useful for windows which are technically
116 toplevels but which, for one or more reasons, do not explicitly cause their associated
117 window to lose ¨window focus¨. Creation of a ROLE_WINDOW object with the POPUP_FOR relation
118 usually requires some presentation action on the part of assistive technology clients, even though
119 the previous toplevel ROLE_FRAME object may still be the active window. </p>
122 <tp:enumvalue suffix="RELATION_PARENT_WINDOW_OF" value="15">
124 This is the reciprocal relation to RELATION_POPUP_FOR.
127 <tp:enumvalue suffix="RELATION_DESCRIPTION_FOR" value="16">
128 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
129 <p>Indicates that an object provides descriptive information
130 about another object; more verbose than RELATION_LABEL_FOR. </p>
133 <tp:enumvalue suffix="RELATION_DESCRIBED_BY" value="17">
134 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
135 <p>Indicates that another object provides descriptive information
136 about this object; more verbose than RELATION_LABELLED_BY. </p>
139 <tp:enumvalue suffix="RELATION_LAST_DEFINED" value="18">
141 Do not use as a parameter value, used to determine the size of the enumeration.