2 using org.freestandards.atspi.Accessible.Reference = Reference;
5 The Component interface is implemented by objects which occupy on-screen space, e.g. objects
6 which have onscreen visual representations. The methods in Component allow clients to identify
7 where the objects lie in the onscreen coordinate system, their relative size, stacking order, and
8 position. It also provides a mechanism whereby keyboard focus may be transferred to specific
9 user interface elements programmatically. This is a 2D API, coordinates of 3D objects are projected into the
10 2-dimensional screen view for purposes of this interface.
12 interface org.freestandards.atspi.Component {
15 Used by Component, Image and Text interfaces to specify whether coordinates are
16 relative to the window or screen.
18 enum <uint32> CoordType {
19 COORD_TYPE_SCREEN = 0,
24 Used by Component and Text interfaces, a struct defining a bounding rectange.
25 The coordinate system is determined by the context of the API call.
35 Indicates the relative stacking order with respect to the onscreen visual representation.
37 The order of layers, from bottom to top is:
46 enum <uint32> ComponentLayer {
59 Describes where the object should be placed on the window.
61 enum uint32 ScrollType {
72 Specifies whether the coordinates are relative to the screen, to the
73 window, or to the parent object.
75 enum uint32 CoordType {
76 COORD_TYPE_SCREEN = 0,
82 True if the specified point lies within the components bounding box.
93 Return the accessible child whose bounding box contains the specified point.
95 method GetAccessibleAtPoint {
104 Obtain the components bounding box, in pixels, relative to the specified coordinate system.
113 Obtain the position of the current component in the specified coordinate system.
116 CoordType coord_type;
123 Obtain the size in the specified coordinate system.
124 Fully contains teh object's visual representation without accounting for viewport clipping.
126 method GetSize reply {
132 The component layer in which this object resides.
134 method GetLayer reply {
135 ComponentLayer layer;
139 Obtain the relative stacking order (i.e 'Z' order) of an object.
140 Larger values indicate that an object is on 'top' of the stack.
141 Only relevenat for objects in LAYER_MDI or LAYER_WINDOW.
143 method GetMDIZOrder reply {
148 Request that an object obtain keyboard focus.
150 method GrabFocus reply {
155 Obtain the alpha value of the component.
156 Alpha values are used with Z-Order to determine whether an obeject obscures
157 anothers visual representation.
159 method GetAlpha reply {
164 Scroll this object so it becomes visible on the screen.
171 Scroll this object so it becomes visible on the screen at a given position.
173 method ScrollToPoint {