other-licenses/ia2/Accessible2_2.idl@6474c204b198 (annotated)
other-licenses/ia2/Accessible2_2.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /************************************************************************* |
| michael@0 | 2 | * |
| michael@0 | 3 | * File Name (Accessible2_2.idl) |
| michael@0 | 4 | * |
| michael@0 | 5 | * IAccessible2 IDL Specification |
| michael@0 | 6 | * |
| michael@0 | 7 | * Copyright (c) 2007, 2013 Linux Foundation |
| michael@0 | 8 | * Copyright (c) 2006 IBM Corporation |
| michael@0 | 9 | * Copyright (c) 2000, 2006 Sun Microsystems, Inc. |
| michael@0 | 10 | * All rights reserved. |
| michael@0 | 11 | * |
| michael@0 | 12 | * |
| michael@0 | 13 | * Redistribution and use in source and binary forms, with or without |
| michael@0 | 14 | * modification, are permitted provided that the following conditions |
| michael@0 | 15 | * are met: |
| michael@0 | 16 | * |
| michael@0 | 17 | * 1. Redistributions of source code must retain the above copyright |
| michael@0 | 18 | * notice, this list of conditions and the following disclaimer. |
| michael@0 | 19 | * |
| michael@0 | 20 | * 2. Redistributions in binary form must reproduce the above |
| michael@0 | 21 | * copyright notice, this list of conditions and the following |
| michael@0 | 22 | * disclaimer in the documentation and/or other materials |
| michael@0 | 23 | * provided with the distribution. |
| michael@0 | 24 | * |
| michael@0 | 25 | * 3. Neither the name of the Linux Foundation nor the names of its |
| michael@0 | 26 | * contributors may be used to endorse or promote products |
| michael@0 | 27 | * derived from this software without specific prior written |
| michael@0 | 28 | * permission. |
| michael@0 | 29 | * |
| michael@0 | 30 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
| michael@0 | 31 | * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
| michael@0 | 32 | * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| michael@0 | 33 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| michael@0 | 34 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR |
| michael@0 | 35 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@0 | 36 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| michael@0 | 37 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| michael@0 | 38 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| michael@0 | 39 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| michael@0 | 40 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| michael@0 | 41 | * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |
| michael@0 | 42 | * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 43 | * |
| michael@0 | 44 | * This BSD License conforms to the Open Source Initiative "Simplified |
| michael@0 | 45 | * BSD License" as published at: |
| michael@0 | 46 | * http://www.opensource.org/licenses/bsd-license.php |
| michael@0 | 47 | * |
| michael@0 | 48 | * IAccessible2 is a trademark of the Linux Foundation. The IAccessible2 |
| michael@0 | 49 | * mark may be used in accordance with the Linux Foundation Trademark |
| michael@0 | 50 | * Policy to indicate compliance with the IAccessible2 specification. |
| michael@0 | 51 | * |
| michael@0 | 52 | ************************************************************************/ |
| michael@0 | 53 | |
| michael@0 | 54 | import "objidl.idl"; |
| michael@0 | 55 | import "oaidl.idl"; |
| michael@0 | 56 | import "oleacc.idl"; |
| michael@0 | 57 | import "Accessible2.idl"; |
| michael@0 | 58 | |
| michael@0 | 59 | /** @brief This interface exposes the primary set of information about an |
| michael@0 | 60 | IAccessible2 enabled accessible object. |
| michael@0 | 61 | |
| michael@0 | 62 | This interface must always be provided for objects that support some |
| michael@0 | 63 | portion of the collection of the %IAccessible2 interfaces. |
| michael@0 | 64 | |
| michael@0 | 65 | Please refer to @ref _changingInterfaces "Changing between Accessible Interfaces" |
| michael@0 | 66 | for special considerations related to use of the MSAA IAccessible interface and |
| michael@0 | 67 | the set of %IAccessible2 interfaces. |
| michael@0 | 68 | */ |
| michael@0 | 69 | [object, uuid(6C9430E9-299D-4E6F-BD01-A82A1E88D3FF)] |
| michael@0 | 70 | interface IAccessible2_2 : IAccessible2 |
| michael@0 | 71 | { |
| michael@0 | 72 | /** @brief Returns the attribute value of a specified attribute specific to this object. |
| michael@0 | 73 | @param [in] name |
| michael@0 | 74 | @param [out] attribute |
| michael@0 | 75 | @retval S_OK |
| michael@0 | 76 | @retval S_FALSE returned if there is nothing to return, [out] value is NULL. |
| michael@0 | 77 | @retval E_INVALIDARG if bad [in] passed. |
| michael@0 | 78 | @note The output value is a VARIANT. Typically it will be a VT_BSTR, but there |
| michael@0 | 79 | are some cases where it will be a VT_I4 or VT_BOOL. Refer to the <a href= |
| michael@0 | 80 | "http://www.linuxfoundation.org/collaborate/workgroups/accessibility/iaccessible2/objectattributesIAccessible2"> |
| michael@0 | 81 | Object Attributes specification</a> for more information. |
| michael@0 | 82 | */ |
| michael@0 | 83 | [propget] HRESULT attribute |
| michael@0 | 84 | ( |
| michael@0 | 85 | [in] BSTR name, |
| michael@0 | 86 | [out, retval] VARIANT *attribute |
| michael@0 | 87 | ); |
| michael@0 | 88 | |
| michael@0 | 89 | /** @brief Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it. |
| michael@0 | 90 | @param [out] accessible |
| michael@0 | 91 | @param [out] caretOffset |
| michael@0 | 92 | @retval S_OK |
| michael@0 | 93 | @retval S_FALSE returned if there is no caret in any of the objects in the subtree, [out] accessible is NULL and [out] caretOffset is -1. |
| michael@0 | 94 | */ |
| michael@0 | 95 | [propget] HRESULT accessibleWithCaret |
| michael@0 | 96 | ( |
| michael@0 | 97 | [out] IUnknown **accessible, |
| michael@0 | 98 | [out, retval] long *caretOffset |
| michael@0 | 99 | ); |
| michael@0 | 100 | |
| michael@0 | 101 | /** @brief Returns relation targets for a specified target type. |
| michael@0 | 102 | @param [in] type |
| michael@0 | 103 | The requested @ref grpRelations "relation type". |
| michael@0 | 104 | @param [in] maxTargets |
| michael@0 | 105 | The number of targets requested. 0 indicates that all targets should be returned. |
| michael@0 | 106 | @param [out] targets |
| michael@0 | 107 | This array is allocated by the server. The client must free it with CoTaskMemFree. |
| michael@0 | 108 | @param [out] nTargets |
| michael@0 | 109 | The number of targets returned; the size of the returned array. |
| michael@0 | 110 | @retval S_OK |
| michael@0 | 111 | @retval S_FALSE if there are no targets, [out] values are NULL and 0 respectively. |
| michael@0 | 112 | @retval E_INVALIDARG if bad [in] passed. |
| michael@0 | 113 | */ |
| michael@0 | 114 | [propget] HRESULT relationTargetsOfType |
| michael@0 | 115 | ( |
| michael@0 | 116 | [in] BSTR type, |
| michael@0 | 117 | [in] long maxTargets, |
| michael@0 | 118 | [out, size_is(,*nTargets)] IUnknown ***targets, |
| michael@0 | 119 | [out, retval] long *nTargets |
| michael@0 | 120 | ); |
| michael@0 | 121 | |
| michael@0 | 122 | } |
| michael@0 | 123 |
