other-licenses/ia2/AccessibleHypertext.idl@6474c204b198 (annotated)
other-licenses/ia2/AccessibleHypertext.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 (AccessibleHypertext.idl) |
| michael@0 | 4 | * |
| michael@0 | 5 | * IAccessible2 IDL Specification |
| michael@0 | 6 | * |
| michael@0 | 7 | * Copyright (c) 2007, 2010 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 "AccessibleText.idl"; |
| michael@0 | 58 | import "AccessibleHyperlink.idl"; |
| michael@0 | 59 | |
| michael@0 | 60 | /** @brief This interface exposes information about hypertext in a document. |
| michael@0 | 61 | |
| michael@0 | 62 | The %IAccessibleHypertext interface is the main interface to expose |
| michael@0 | 63 | hyperlinks in a document, typically a text document, that are used |
| michael@0 | 64 | to reference other documents. A typical implementation is to implement |
| michael@0 | 65 | this interface on the smallest text object such as a paragraph of text. |
| michael@0 | 66 | */ |
| michael@0 | 67 | [object, uuid(6B4F8BBF-F1F2-418a-B35E-A195BC4103B9)] |
| michael@0 | 68 | interface IAccessibleHypertext : IAccessibleText |
| michael@0 | 69 | { |
| michael@0 | 70 | |
| michael@0 | 71 | /** @brief Returns the number of links and link groups contained within this hypertext |
| michael@0 | 72 | paragraph. |
| michael@0 | 73 | @param [out] hyperlinkCount |
| michael@0 | 74 | The number of links and link groups within this hypertext paragraph. |
| michael@0 | 75 | Returns 0 if there is no link. |
| michael@0 | 76 | @retval S_OK |
| michael@0 | 77 | */ |
| michael@0 | 78 | [propget] HRESULT nHyperlinks |
| michael@0 | 79 | ( |
| michael@0 | 80 | [out, retval] long *hyperlinkCount |
| michael@0 | 81 | ); |
| michael@0 | 82 | |
| michael@0 | 83 | /** @brief Returns the specified link. |
| michael@0 | 84 | |
| michael@0 | 85 | The returned IAccessibleHyperlink object encapsulates the hyperlink and |
| michael@0 | 86 | provides several kinds of information describing it. |
| michael@0 | 87 | @param [in] index |
| michael@0 | 88 | This 0 based index specifies the hyperlink to return. |
| michael@0 | 89 | @param [out] hyperlink |
| michael@0 | 90 | If the given index is valid, i.e. lies in the interval from 0 to the number |
| michael@0 | 91 | of links minus one, a reference to the specified hyperlink object is returned. |
| michael@0 | 92 | If the index is invalid then a NULL pointer is returned. |
| michael@0 | 93 | @retval S_OK |
| michael@0 | 94 | @retval E_INVALIDARG if bad [in] passed |
| michael@0 | 95 | */ |
| michael@0 | 96 | [propget] HRESULT hyperlink |
| michael@0 | 97 | ( |
| michael@0 | 98 | [in] long index, |
| michael@0 | 99 | [out, retval] IAccessibleHyperlink **hyperlink |
| michael@0 | 100 | ); |
| michael@0 | 101 | |
| michael@0 | 102 | /** @brief Returns the index of the hyperlink that is associated with this character index. |
| michael@0 | 103 | |
| michael@0 | 104 | This is the case when a link spans the given character index. |
| michael@0 | 105 | @param [in] charIndex |
| michael@0 | 106 | A 0 based index of the character for which to return the link index. If |
| michael@0 | 107 | IAccessibleText is used to represent the text containing the link, then the |
| michael@0 | 108 | character index is only valid if it is greater than or equal to zero and |
| michael@0 | 109 | lower than the number of characters in the text. |
| michael@0 | 110 | @param [out] hyperlinkIndex |
| michael@0 | 111 | Returns the 0 based index of the hyperlink that is associated with this |
| michael@0 | 112 | character index, or -1 if charIndex is not on a link. |
| michael@0 | 113 | @retval S_OK |
| michael@0 | 114 | @retval S_FALSE if there is nothing to return, [out] value is -1 |
| michael@0 | 115 | @retval E_INVALIDARG if bad [in] passed |
| michael@0 | 116 | */ |
| michael@0 | 117 | [propget] HRESULT hyperlinkIndex |
| michael@0 | 118 | ( |
| michael@0 | 119 | [in] long charIndex, |
| michael@0 | 120 | [out, retval] long *hyperlinkIndex |
| michael@0 | 121 | ); |
| michael@0 | 122 | |
| michael@0 | 123 | } |
