other-licenses/ia2/AccessibleApplication.idl@925c144e1f1f (annotated)
other-licenses/ia2/AccessibleApplication.idl
Fri, 16 Jan 2015 18:13:44 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Fri, 16 Jan 2015 18:13:44 +0100
- branch
- TOR_BUG_9701
- changeset 14
- 925c144e1f1f
- permissions
- -rw-r--r--
Integrate suggestion from review to improve consistency with existing code.
| michael@0 | 1 | /************************************************************************* |
| michael@0 | 2 | * |
| michael@0 | 3 | * File Name (AccessibleApplication.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 | |
| michael@0 | 55 | import "objidl.idl"; |
| michael@0 | 56 | import "oaidl.idl"; |
| michael@0 | 57 | import "oleacc.idl"; |
| michael@0 | 58 | |
| michael@0 | 59 | /** @brief This interface gives access to the application's name and version information. |
| michael@0 | 60 | |
| michael@0 | 61 | This interface provides the AT with the information it needs to differentiate |
| michael@0 | 62 | this application from other applications, from other versions of this |
| michael@0 | 63 | application, or from other versions of this application running on different |
| michael@0 | 64 | versions of an accessibility bridge or accessibility toolkit. |
| michael@0 | 65 | |
| michael@0 | 66 | Servers implementing IAccessible2 should provide access to the %IAccessibleApplication |
| michael@0 | 67 | interface via QueryService from any object so that ATs can easily determine specific |
| michael@0 | 68 | information about the application such as its name or version. |
| michael@0 | 69 | */ |
| michael@0 | 70 | [object, uuid(D49DED83-5B25-43F4-9B95-93B44595979E)] |
| michael@0 | 71 | interface IAccessibleApplication : IUnknown |
| michael@0 | 72 | { |
| michael@0 | 73 | |
| michael@0 | 74 | /** @brief Returns the application name. |
| michael@0 | 75 | @param [out] name |
| michael@0 | 76 | @retval S_OK |
| michael@0 | 77 | @retval S_FALSE if there is nothing to return, [out] value is NULL |
| michael@0 | 78 | */ |
| michael@0 | 79 | [propget] HRESULT appName |
| michael@0 | 80 | ( |
| michael@0 | 81 | [out, retval] BSTR *name |
| michael@0 | 82 | ); |
| michael@0 | 83 | |
| michael@0 | 84 | /** @brief Returns the application version. |
| michael@0 | 85 | @param [out] version |
| michael@0 | 86 | The version string must not contain levels when it is know beforehand that |
| michael@0 | 87 | this information will never require a change in a client's behavior. |
| michael@0 | 88 | For example, use "3.6.0" rather than "3.6.0.v201005131500". |
| michael@0 | 89 | @retval S_OK |
| michael@0 | 90 | @retval S_FALSE if there is nothing to return, [out] value is NULL |
| michael@0 | 91 | */ |
| michael@0 | 92 | [propget] HRESULT appVersion |
| michael@0 | 93 | ( |
| michael@0 | 94 | [out, retval] BSTR *version |
| michael@0 | 95 | ); |
| michael@0 | 96 | |
| michael@0 | 97 | /** @brief Returns the toolkit/bridge name. |
| michael@0 | 98 | @param [out] name |
| michael@0 | 99 | @retval S_OK |
| michael@0 | 100 | @retval S_FALSE if there is nothing to return, [out] value is NULL |
| michael@0 | 101 | */ |
| michael@0 | 102 | [propget] HRESULT toolkitName |
| michael@0 | 103 | ( |
| michael@0 | 104 | [out, retval] BSTR *name |
| michael@0 | 105 | ); |
| michael@0 | 106 | |
| michael@0 | 107 | /** @brief Returns the toolkit/bridge version. |
| michael@0 | 108 | @param [out] version |
| michael@0 | 109 | The version string must not contain levels when it is know beforehand that |
| michael@0 | 110 | this information will never require a change in a client's behavior. |
| michael@0 | 111 | For example, use "3.6.0" rather than "3.6.0.v201005131500". |
| michael@0 | 112 | @retval S_OK |
| michael@0 | 113 | @retval S_FALSE if there is nothing to return, [out] value is NULL |
| michael@0 | 114 | */ |
| michael@0 | 115 | [propget] HRESULT toolkitVersion |
| michael@0 | 116 | ( |
| michael@0 | 117 | [out, retval] BSTR *version |
| michael@0 | 118 | ); |
| michael@0 | 119 | |
| michael@0 | 120 | } |
| michael@0 | 121 |
