other-licenses/ia2/AccessibleDocument.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleDocument.idl)
   4  *
   5  *  IAccessible2 IDL Specification
   6  *
   7  *  Copyright (c) 2013 Linux Foundation
   8  *  All rights reserved.
   9  *
  10  *
  11  *  Redistribution and use in source and binary forms, with or without
  12  *  modification, are permitted provided that the following conditions
  13  *  are met:
  14  *
  15  *   1. Redistributions of source code must retain the above copyright
  16  *      notice, this list of conditions and the following disclaimer.
  17  *
  18  *   2. Redistributions in binary form must reproduce the above
  19  *      copyright notice, this list of conditions and the following
  20  *      disclaimer in the documentation and/or other materials
  21  *      provided with the distribution.
  22  *
  23  *   3. Neither the name of the Linux Foundation nor the names of its
  24  *      contributors may be used to endorse or promote products
  25  *      derived from this software without specific prior written
  26  *      permission.
  27  *
  28  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  29  *  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  30  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  31  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  32  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  33  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  34  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  35  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  36  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  38  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  39  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  40  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  41  *
  42  *  This BSD License conforms to the Open Source Initiative "Simplified
  43  *  BSD License" as published at:
  44  *  http://www.opensource.org/licenses/bsd-license.php
  45  *
  46  *  IAccessible2 is a trademark of the Linux Foundation. The IAccessible2
  47  *  mark may be used in accordance with the Linux Foundation Trademark
  48  *  Policy to indicate compliance with the IAccessible2 specification.
  49  *
  50  ************************************************************************/
  51
  52 import "objidl.idl";
  53 import "oaidl.idl";
  54 import "oleacc.idl";
  55
  56 /** @brief This interface represents documents.
  57
  58  This interface is used for a representation of documents.
  59 */
  60 [object, uuid(C48C7FCF-4AB5-4056-AFA6-902D6E1D1149)]
  61 interface IAccessibleDocument : IUnknown
  62 {
  63   /** @brief Returns the most recently used anchor target within a document.
  64
  65    A document's most recently targeted in-page anchor is returned.  A typical use
  66     of this method is to fetch the anchor target within an HTML document.  In this
  67     case anchor targets are those which has been defined with the <a> tag.
  68
  69    @param [out] accessible
  70    @retval S_OK
  71    @retval S_FALSE if there are no existing valid anchor targets, [out] value is NULL.
  72   */
  73   [propget] HRESULT anchorTarget
  74     (
  75      [out, retval] IUnknown **accessible
  76     );
  77
  78 }