other-licenses/ia2/Accessible2_2.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (Accessible2_2.idl)
   4  *
   5  *  IAccessible2 IDL Specification
   6  *
   7  *  Copyright (c) 2007, 2013 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 "Accessible2.idl";
  58
  59 /** @brief This interface exposes the primary set of information about an
  60  IAccessible2 enabled accessible object.
  61
  62  This interface must always be provided for objects that support some
  63  portion of the collection of the %IAccessible2 interfaces.
  64
  65  Please refer to @ref _changingInterfaces "Changing between Accessible Interfaces"
  66  for special considerations related to use of the MSAA IAccessible interface and
  67  the set of %IAccessible2 interfaces.
  68  */
  69 [object, uuid(6C9430E9-299D-4E6F-BD01-A82A1E88D3FF)]
  70 interface IAccessible2_2 : IAccessible2
  71 {
  72   /** @brief Returns the attribute value of a specified attribute specific to this object.
  73    @param [in] name
  74    @param [out] attribute
  75    @retval S_OK
  76    @retval S_FALSE returned if there is nothing to return, [out] value is NULL.
  77    @retval E_INVALIDARG if bad [in] passed.
  78    @note The output value is a VARIANT.  Typically it will be a VT_BSTR, but there
  79      are some cases where it will be a VT_I4 or VT_BOOL.  Refer to the <a href=
  80      "http://www.linuxfoundation.org/collaborate/workgroups/accessibility/iaccessible2/objectattributesIAccessible2">
  81      Object Attributes specification</a> for more information.
  82   */
  83   [propget] HRESULT attribute
  84     (
  85      [in] BSTR name,
  86      [out, retval] VARIANT *attribute
  87     );
  88
  89   /** @brief Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it.
  90    @param [out] accessible
  91    @param [out] caretOffset
  92    @retval S_OK
  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.
  94   */
  95   [propget] HRESULT accessibleWithCaret
  96     (
  97      [out] IUnknown **accessible,
  98      [out, retval] long *caretOffset
  99     );
 100
 101   /** @brief Returns relation targets for a specified target type.
 102    @param [in] type
 103     The requested @ref grpRelations "relation type".
 104    @param [in] maxTargets
 105     The number of targets requested.  0 indicates that all targets should be returned.
 106    @param [out] targets
 107     This array is allocated by the server.  The client must free it with CoTaskMemFree.
 108    @param [out] nTargets
 109     The number of targets returned; the size of the returned array.
 110    @retval S_OK
 111    @retval S_FALSE if there are no targets, [out] values are NULL and 0 respectively.
 112    @retval E_INVALIDARG if bad [in] passed.
 113   */
 114   [propget] HRESULT relationTargetsOfType
 115     (
 116      [in] BSTR type,
 117      [in] long maxTargets,
 118      [out, size_is(,*nTargets)] IUnknown ***targets,
 119      [out, retval] long *nTargets
 120     );
 121
 122 }
 123