other-licenses/ia2/AccessibleHypertext2.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleHypertext2.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 "AccessibleHypertext.idl";
  58 import "AccessibleHyperlink.idl";
  59
  60 /** @brief This interface exposes information about hypertext in a document.
  61
  62  The %IAccessibleHypertext2 interface extends the functinality of the
  63  %IAccessibleHypertext inteface.
  64 */
  65 [object, uuid(CF64D89F-8287-4B44-8501-A827453A6077)]
  66 interface IAccessibleHypertext2 : IAccessibleHypertext
  67 {
  68
  69  /** @brief Returns the links for this object.
  70
  71    The returned IAccessibleHyperlink objects encapsulate the hyperlink and
  72     provides several kinds of information describing it.
  73
  74    @param [out] hyperlinks
  75     This array is allocated by the server.  The client must free it with CoTaskMemFree.
  76    @param [out] nHyperlinks
  77     The number of links returned; the size of the returned array.
  78    @retval S_OK
  79    @retval S_FALSE if there are no links, [out] values are NULL and 0 respectively
  80   */
  81   [propget] HRESULT hyperlinks
  82     (
  83      [out, size_is(,*nHyperlinks)] IAccessibleHyperlink ***hyperlinks,
  84      [out, retval] long *nHyperlinks
  85     );
  86
  87 }