other-licenses/ia2/AccessibleComponent.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleComponent.idl)
   4  *
   5  *  IAccessible2 IDL Specification
   6  *
   7  *  Copyright (c) IBM Corp. 2007
   8  *  Copyright (c) Sun Microsystems, Inc. 2000, 2006
   9  *
  10  *  This library is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU Lesser General Public
  12  *  License version 2.1, as published by the Free Software Foundation; either
  13  *  version 2.1 of the License, or (at your option) any later version.
  14  *
  15  *  This library is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  *  Lesser General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU Lesser General Public
  21  *  License along with this library; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02110-1301  USA
  23  *
  24  ************************************************************************/
  25
  26 import "objidl.idl";
  27 import "oaidl.idl";
  28 import "oleacc.idl";
  29
  30 typedef long IA2Color;
  31
  32 /** @brief This interface is implemented by any object that can be rendered
  33  on the screen.
  34
  35  This interface provides the standard mechanism for an assistive technology
  36   to retrieve information concerning the graphical representation of an object.
  37   Coordinates used by the functions of this interface are specified in
  38   different coordinate systems.  Their scale is the same and is equal to
  39   that of the screen coordiante system.  In other words all coordinates
  40   are measured in pixels.  They differ in their respective origin:
  41   <ul>
  42    <li>The screen coordinate system has its origin in the upper left
  43     corner of the current screen.</li>
  44    <li>The origin of the parent coordinate system is the upper left corner
  45     of the parent's bounding box.  With no parent the screen coordinate
  46     system is used instead.</li>
  47   </ul>
  48 */
  49 [object, uuid(1546D4B0-4C98-4bda-89AE-9A64748BDDE4)]
  50 interface IAccessibleComponent : IUnknown
  51 {
  52
  53   /** @brief Returns the location of the upper left corner of the object's
  54     bounding box relative to the immediate parent object.
  55
  56         The coordinates of the bounding box are given relative to the parent's
  57         coordinate system. The coordinates of the returned position are relative
  58         to this object's parent or relative to the screen on which this object
  59     is rendered if it has no parent. If the object is not on any screen
  60     the returned position is (0,0).
  61
  62    @param [out] x
  63    @param [out] y
  64   */
  65   [propget] HRESULT locationInParent
  66     (
  67          [out] long *x,
  68      [out, retval] long *y
  69     );
  70
  71   /** @brief Returns the foreground color of this object.
  72    @param [out] foreground
  73     The returned color is the foreground color of this object or, if
  74     that is not supported, the default foreground color.
  75   */
  76   [propget] HRESULT foreground
  77     (
  78      [out, retval] IA2Color *foreground
  79     );
  80
  81    /** @brief Returns the background color of this object.
  82     @param [out] background
  83      The returned color is the background color of this object or, if
  84      that is not supported, the default background color.
  85    */
  86   [propget] HRESULT background
  87     (
  88      [out, retval] IA2Color *background
  89     );
  90 }