michael@0: /*************************************************************************
michael@0:  *
michael@0:  *  File Name (AccessibleApplication.idl)
michael@0:  * 
michael@0:  *  IAccessible2 IDL Specification 
michael@0:  * 
michael@0:  *  Copyright (c) 2007, 2010 Linux Foundation 
michael@0:  *  Copyright (c) 2006 IBM Corporation 
michael@0:  *  Copyright (c) 2000, 2006 Sun Microsystems, Inc. 
michael@0:  *  All rights reserved. 
michael@0:  *   
michael@0:  *   
michael@0:  *  Redistribution and use in source and binary forms, with or without 
michael@0:  *  modification, are permitted provided that the following conditions 
michael@0:  *  are met: 
michael@0:  *   
michael@0:  *   1. Redistributions of source code must retain the above copyright 
michael@0:  *      notice, this list of conditions and the following disclaimer. 
michael@0:  *   
michael@0:  *   2. Redistributions in binary form must reproduce the above 
michael@0:  *      copyright notice, this list of conditions and the following 
michael@0:  *      disclaimer in the documentation and/or other materials 
michael@0:  *      provided with the distribution. 
michael@0:  *
michael@0:  *   3. Neither the name of the Linux Foundation nor the names of its 
michael@0:  *      contributors may be used to endorse or promote products 
michael@0:  *      derived from this software without specific prior written 
michael@0:  *      permission. 
michael@0:  *   
michael@0:  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 
michael@0:  *  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
michael@0:  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
michael@0:  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
michael@0:  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
michael@0:  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
michael@0:  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
michael@0:  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
michael@0:  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
michael@0:  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
michael@0:  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
michael@0:  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
michael@0:  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
michael@0:  *   
michael@0:  *  This BSD License conforms to the Open Source Initiative "Simplified 
michael@0:  *  BSD License" as published at: 
michael@0:  *  http://www.opensource.org/licenses/bsd-license.php 
michael@0:  *   
michael@0:  *  IAccessible2 is a trademark of the Linux Foundation. The IAccessible2 
michael@0:  *  mark may be used in accordance with the Linux Foundation Trademark 
michael@0:  *  Policy to indicate compliance with the IAccessible2 specification. 
michael@0:  * 
michael@0:  ************************************************************************/ 
michael@0: 
michael@0: 
michael@0: import "objidl.idl";
michael@0: import "oaidl.idl";
michael@0: import "oleacc.idl";
michael@0: 
michael@0: /** @brief This interface gives access to the application's name and version information.
michael@0:         
michael@0:  This interface provides the AT with the information it needs to differentiate 
michael@0:  this application from other applications, from other versions of this 
michael@0:  application, or from other versions of this application running on different 
michael@0:  versions of an accessibility bridge or accessibility toolkit.
michael@0: 
michael@0:  Servers implementing IAccessible2 should provide access to the %IAccessibleApplication 
michael@0:  interface via QueryService from any object so that ATs can easily determine specific 
michael@0:  information about the application such as its name or version.
michael@0: */
michael@0: [object, uuid(D49DED83-5B25-43F4-9B95-93B44595979E)]
michael@0: interface IAccessibleApplication : IUnknown
michael@0: {
michael@0:   
michael@0:   /** @brief Returns the application name.
michael@0:    @param [out] name
michael@0:    @retval S_OK
michael@0:    @retval S_FALSE if there is nothing to return, [out] value is NULL
michael@0:   */
michael@0:   [propget] HRESULT appName
michael@0:     (
michael@0:      [out, retval] BSTR *name
michael@0:     );
michael@0: 
michael@0:   /** @brief Returns the application version.
michael@0:    @param [out] version
michael@0:     The version string must not contain levels when it is know beforehand that
michael@0:     this information will never require a change in a client's behavior.
michael@0:     For example, use "3.6.0" rather than "3.6.0.v201005131500".
michael@0:    @retval S_OK
michael@0:    @retval S_FALSE if there is nothing to return, [out] value is NULL
michael@0:   */
michael@0:   [propget] HRESULT appVersion
michael@0:     (
michael@0:      [out, retval] BSTR *version
michael@0:     );
michael@0: 
michael@0:   /** @brief Returns the toolkit/bridge name.
michael@0:    @param [out] name
michael@0:    @retval S_OK
michael@0:    @retval S_FALSE if there is nothing to return, [out] value is NULL
michael@0:   */
michael@0:   [propget] HRESULT toolkitName
michael@0:     (
michael@0:      [out, retval] BSTR *name
michael@0:     );
michael@0: 
michael@0:   /** @brief Returns the toolkit/bridge version.
michael@0:    @param [out] version
michael@0:     The version string must not contain levels when it is know beforehand that
michael@0:     this information will never require a change in a client's behavior.
michael@0:     For example, use "3.6.0" rather than "3.6.0.v201005131500".
michael@0:    @retval S_OK
michael@0:    @retval S_FALSE if there is nothing to return, [out] value is NULL
michael@0:   */
michael@0:   [propget] HRESULT toolkitVersion
michael@0:     (
michael@0:      [out, retval] BSTR *version
michael@0:     );  
michael@0: 
michael@0: }
michael@0: