michael@0: /************************************************************************* michael@0: * michael@0: * File Name (Accessible2_2.idl) michael@0: * michael@0: * IAccessible2 IDL Specification michael@0: * michael@0: * Copyright (c) 2007, 2013 Linux Foundation michael@0: * Copyright (c) 2006 IBM Corporation michael@0: * Copyright (c) 2000, 2006 Sun Microsystems, Inc. michael@0: * All rights reserved. michael@0: * michael@0: * michael@0: * Redistribution and use in source and binary forms, with or without michael@0: * modification, are permitted provided that the following conditions michael@0: * are met: michael@0: * michael@0: * 1. Redistributions of source code must retain the above copyright michael@0: * notice, this list of conditions and the following disclaimer. michael@0: * michael@0: * 2. Redistributions in binary form must reproduce the above michael@0: * copyright notice, this list of conditions and the following michael@0: * disclaimer in the documentation and/or other materials michael@0: * provided with the distribution. michael@0: * michael@0: * 3. Neither the name of the Linux Foundation nor the names of its michael@0: * contributors may be used to endorse or promote products michael@0: * derived from this software without specific prior written michael@0: * permission. michael@0: * michael@0: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND michael@0: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, michael@0: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF michael@0: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE michael@0: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR michael@0: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, michael@0: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT michael@0: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; michael@0: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) michael@0: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN michael@0: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR michael@0: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, michael@0: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. michael@0: * michael@0: * This BSD License conforms to the Open Source Initiative "Simplified michael@0: * BSD License" as published at: michael@0: * http://www.opensource.org/licenses/bsd-license.php michael@0: * michael@0: * IAccessible2 is a trademark of the Linux Foundation. The IAccessible2 michael@0: * mark may be used in accordance with the Linux Foundation Trademark michael@0: * Policy to indicate compliance with the IAccessible2 specification. michael@0: * michael@0: ************************************************************************/ michael@0: michael@0: import "objidl.idl"; michael@0: import "oaidl.idl"; michael@0: import "oleacc.idl"; michael@0: import "Accessible2.idl"; michael@0: michael@0: /** @brief This interface exposes the primary set of information about an michael@0: IAccessible2 enabled accessible object. michael@0: michael@0: This interface must always be provided for objects that support some michael@0: portion of the collection of the %IAccessible2 interfaces. michael@0: michael@0: Please refer to @ref _changingInterfaces "Changing between Accessible Interfaces" michael@0: for special considerations related to use of the MSAA IAccessible interface and michael@0: the set of %IAccessible2 interfaces. michael@0: */ michael@0: [object, uuid(6C9430E9-299D-4E6F-BD01-A82A1E88D3FF)] michael@0: interface IAccessible2_2 : IAccessible2 michael@0: { michael@0: /** @brief Returns the attribute value of a specified attribute specific to this object. michael@0: @param [in] name michael@0: @param [out] attribute michael@0: @retval S_OK michael@0: @retval S_FALSE returned if there is nothing to return, [out] value is NULL. michael@0: @retval E_INVALIDARG if bad [in] passed. michael@0: @note The output value is a VARIANT. Typically it will be a VT_BSTR, but there michael@0: are some cases where it will be a VT_I4 or VT_BOOL. Refer to the michael@0: Object Attributes specification for more information. michael@0: */ michael@0: [propget] HRESULT attribute michael@0: ( michael@0: [in] BSTR name, michael@0: [out, retval] VARIANT *attribute michael@0: ); michael@0: michael@0: /** @brief Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it. michael@0: @param [out] accessible michael@0: @param [out] caretOffset michael@0: @retval S_OK michael@0: @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: */ michael@0: [propget] HRESULT accessibleWithCaret michael@0: ( michael@0: [out] IUnknown **accessible, michael@0: [out, retval] long *caretOffset michael@0: ); michael@0: michael@0: /** @brief Returns relation targets for a specified target type. michael@0: @param [in] type michael@0: The requested @ref grpRelations "relation type". michael@0: @param [in] maxTargets michael@0: The number of targets requested. 0 indicates that all targets should be returned. michael@0: @param [out] targets michael@0: This array is allocated by the server. The client must free it with CoTaskMemFree. michael@0: @param [out] nTargets michael@0: The number of targets returned; the size of the returned array. michael@0: @retval S_OK michael@0: @retval S_FALSE if there are no targets, [out] values are NULL and 0 respectively. michael@0: @retval E_INVALIDARG if bad [in] passed. michael@0: */ michael@0: [propget] HRESULT relationTargetsOfType michael@0: ( michael@0: [in] BSTR type, michael@0: [in] long maxTargets, michael@0: [out, size_is(,*nTargets)] IUnknown ***targets, michael@0: [out, retval] long *nTargets michael@0: ); michael@0: michael@0: } michael@0: