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