|
1 /************************************************************************* |
|
2 * |
|
3 * File Name (AccessibleComponent.idl) |
|
4 * |
|
5 * IAccessible2 IDL Specification |
|
6 * |
|
7 * Copyright (c) 2007, 2010 Linux Foundation |
|
8 * Copyright (c) 2006 IBM Corporation |
|
9 * Copyright (c) 2000, 2006 Sun Microsystems, Inc. |
|
10 * All rights reserved. |
|
11 * |
|
12 * |
|
13 * Redistribution and use in source and binary forms, with or without |
|
14 * modification, are permitted provided that the following conditions |
|
15 * are met: |
|
16 * |
|
17 * 1. Redistributions of source code must retain the above copyright |
|
18 * notice, this list of conditions and the following disclaimer. |
|
19 * |
|
20 * 2. Redistributions in binary form must reproduce the above |
|
21 * copyright notice, this list of conditions and the following |
|
22 * disclaimer in the documentation and/or other materials |
|
23 * provided with the distribution. |
|
24 * |
|
25 * 3. Neither the name of the Linux Foundation nor the names of its |
|
26 * contributors may be used to endorse or promote products |
|
27 * derived from this software without specific prior written |
|
28 * permission. |
|
29 * |
|
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
|
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
|
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
|
33 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
34 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR |
|
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
|
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
|
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
40 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
|
41 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |
|
42 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
43 * |
|
44 * This BSD License conforms to the Open Source Initiative "Simplified |
|
45 * BSD License" as published at: |
|
46 * http://www.opensource.org/licenses/bsd-license.php |
|
47 * |
|
48 * IAccessible2 is a trademark of the Linux Foundation. The IAccessible2 |
|
49 * mark may be used in accordance with the Linux Foundation Trademark |
|
50 * Policy to indicate compliance with the IAccessible2 specification. |
|
51 * |
|
52 ************************************************************************/ |
|
53 |
|
54 import "objidl.idl"; |
|
55 import "oaidl.idl"; |
|
56 import "oleacc.idl"; |
|
57 |
|
58 /** A value specifying a color in ARGB format, where each 8 bit color component |
|
59 specifies alpha, red, green, and blue respectively. The alpha value is optional. |
|
60 */ |
|
61 typedef long IA2Color; |
|
62 |
|
63 /** @brief This interface is implemented by any object that can be rendered |
|
64 on the screen. |
|
65 |
|
66 This interface provides the standard mechanism for an assistive technology |
|
67 to retrieve information concerning the graphical representation of an object. |
|
68 Coordinates used by the functions of this interface are specified in |
|
69 different coordinate systems. Their scale is the same and is equal to |
|
70 that of the screen coordinate system. In other words all coordinates |
|
71 are measured in pixels. They differ in their respective origin: |
|
72 <ul> |
|
73 <li>The screen coordinate system has its origin in the upper left |
|
74 corner of the current screen.</li> |
|
75 <li>The origin of the parent coordinate system is the upper left corner |
|
76 of the parent's bounding box. With no parent the screen coordinate |
|
77 system is used instead.</li> |
|
78 </ul> |
|
79 */ |
|
80 [object, uuid(1546D4B0-4C98-4bda-89AE-9A64748BDDE4)] |
|
81 interface IAccessibleComponent : IUnknown |
|
82 { |
|
83 |
|
84 /** @brief Returns the location of the upper left corner of the object's |
|
85 bounding box relative to the immediate parent object. |
|
86 |
|
87 The coordinates of the bounding box are given relative to the parent's |
|
88 coordinate system. The coordinates of the returned position are relative |
|
89 to this object's parent or relative to the screen on which this object |
|
90 is rendered if it has no parent. If the object is not on any screen |
|
91 the returned position is (0,0). |
|
92 |
|
93 @param [out] x |
|
94 @param [out] y |
|
95 @retval S_OK |
|
96 */ |
|
97 [propget] HRESULT locationInParent |
|
98 ( |
|
99 [out] long *x, |
|
100 [out, retval] long *y |
|
101 ); |
|
102 |
|
103 /** @brief Returns the foreground color of this object. |
|
104 @param [out] foreground |
|
105 The returned color is the foreground color of this object or, if |
|
106 that is not supported, the default foreground color. |
|
107 @retval S_OK |
|
108 */ |
|
109 [propget] HRESULT foreground |
|
110 ( |
|
111 [out, retval] IA2Color *foreground |
|
112 ); |
|
113 |
|
114 /** @brief Returns the background color of this object. |
|
115 @param [out] background |
|
116 The returned color is the background color of this object or, if |
|
117 that is not supported, the default background color. |
|
118 @retval S_OK |
|
119 */ |
|
120 [propget] HRESULT background |
|
121 ( |
|
122 [out, retval] IA2Color *background |
|
123 ); |
|
124 } |