other-licenses/ia2/AccessibleApplication.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleApplication.idl)
   4  *
   5  *  IAccessible2 IDL Specification
   6  *
   7  *  Copyright (c) Linux Foundation 2007, 2008
   8  *  Copyright (c) IBM Corp. 2006
   9  *  Copyright (c) Sun Microsystems, Inc. 2000, 2006
  10  *
  11  *  This library is free software; you can redistribute it and/or
  12  *  modify it under the terms of the GNU Lesser General Public
  13  *  License version 2.1, as published by the Free Software Foundation; either
  14  *  version 2.1 of the License, or (at your option) any later version.
  15  *
  16  *  This library is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  *  Lesser General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU Lesser General Public
  22  *  License along with this library; if not, write to the Free Software
  23  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02110-1301  USA
  24  *
  25  ************************************************************************/
  26
  27 import "objidl.idl";
  28 import "oaidl.idl";
  29 import "oleacc.idl";
  30
  31 /** @brief This interface gives access to the application's name and version information.
  32
  33  This interface provides the AT with the information it needs to differentiate
  34  this application from other applications, from other versions of this
  35  application, or from other versions of this application running on different
  36  versions of an accessibility bridge or accessibility toolkit.
  37
  38  Servers implementing IAccessible2 should provide access to the %IAccessibleApplication
  39  interface via QueryService from any object so that ATs can easily determine specific
  40  information about the application such as its name or version.
  41 */
  42 [object, uuid(D49DED83-5B25-43F4-9B95-93B44595979E)]
  43 interface IAccessibleApplication : IUnknown
  44 {
  45
  46   /** @brief Returns the application name.
  47    @param [out] name
  48    @retval S_OK
  49    @retval S_FALSE if there is nothing to return, [out] value is NULL
  50   */
  51   [propget] HRESULT appName
  52     (
  53      [out, retval] BSTR *name
  54     );
  55
  56   /** @brief Returns the application version.
  57    @param [out] version
  58    @retval S_OK
  59    @retval S_FALSE if there is nothing to return, [out] value is NULL
  60   */
  61   [propget] HRESULT appVersion
  62     (
  63      [out, retval] BSTR *version
  64     );
  65
  66   /** @brief Returns the toolkit/bridge name.
  67    @param [out] name
  68    @retval S_OK
  69    @retval S_FALSE if there is nothing to return, [out] value is NULL
  70   */
  71   [propget] HRESULT toolkitName
  72     (
  73      [out, retval] BSTR *name
  74     );
  75
  76   /** @brief Returns the toolkit/bridge version.
  77    @param [out] version
  78    @retval S_OK
  79    @retval S_FALSE if there is nothing to return, [out] value is NULL
  80   */
  81   [propget] HRESULT toolkitVersion
  82     (
  83      [out, retval] BSTR *version
  84     );
  85
  86 }
  87