|
1 /************************************************************************* |
|
2 * |
|
3 * File Name (AccessibleImage.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 import "IA2CommonTypes.idl"; |
|
58 |
|
59 /** @brief This interface represents images and icons. |
|
60 |
|
61 This interface is used for a representation of images like icons on buttons. |
|
62 %IAccessibleImage only needs to be implemented in certain situations. Some |
|
63 examples are: |
|
64 <ol> |
|
65 <li>The accessible name and description are not enough to fully |
|
66 describe the image, e.g. when the accessible description is used to define the |
|
67 behavior of an actionable image and the image itself conveys semantically |
|
68 significant information. |
|
69 <li>The user can edit the content that includes an |
|
70 image and therefore the user needs to be able to review the image's position. |
|
71 </ol> |
|
72 */ |
|
73 [object, uuid(FE5ABB3D-615E-4f7b-909F-5F0EDA9E8DDE)] |
|
74 interface IAccessibleImage : IUnknown |
|
75 { |
|
76 /** @brief Returns the localized description of the image. |
|
77 @param [out] description |
|
78 @retval S_OK |
|
79 @retval S_FALSE if there is nothing to return, [out] value is NULL |
|
80 */ |
|
81 [propget] HRESULT description |
|
82 ( |
|
83 [out, retval] BSTR *description |
|
84 ); |
|
85 |
|
86 /** @brief Returns the coordinates of the image. |
|
87 @param [in] coordinateType |
|
88 Specifies whether the returned coordinates should be relative to the screen or the parent object. |
|
89 @param [out] x |
|
90 @param [out] y |
|
91 @retval S_OK |
|
92 */ |
|
93 [propget] HRESULT imagePosition |
|
94 ( |
|
95 [in] enum IA2CoordinateType coordinateType, |
|
96 [out] long *x, |
|
97 [out, retval] long *y |
|
98 ); |
|
99 |
|
100 /** @brief Returns the size of the image in units specified by parent's coordinate system. |
|
101 @param [out] height |
|
102 @param [out] width |
|
103 @retval S_OK |
|
104 */ |
|
105 |
|
106 [propget] HRESULT imageSize |
|
107 ( |
|
108 [out] long *height, |
|
109 [out, retval] long *width |
|
110 ); |
|
111 } |