other-licenses/ia2/AccessibleImage.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleImage)
   4  *
   5  *  IAccessible2 IDL Specification
   6  *
   7  *  Copyright (c) IBM Corp. 2006
   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 import "IA2CommonTypes.idl";
  30
  31 /** @brief This interface represents images and icons.
  32
  33  This interface is used for a representation of images like icons on buttons.
  34   IAccessibleImage only needs to be implemented in certain situations.  Some
  35   examples are:
  36   <ol>
  37    <li>The accessible name and description are not enough to fully
  38     describe the image, e.g. when the accessible description is used to define the
  39     behavior of an actionable image and the image itself conveys semantically
  40     significant information.
  41    <li>The user can edit the content that includes an
  42     image and therefore the user needs to be able to review the image's position.
  43   </ol>
  44 */
  45 [object, uuid(FE5ABB3D-615E-4f7b-909F-5F0EDA9E8DDE)]
  46 interface IAccessibleImage : IUnknown
  47 {
  48   /** @brief Returns the localized description of the image.
  49    @param [out] description
  50   */
  51   [propget] HRESULT description
  52     (
  53      [out, retval] BSTR *description
  54     );
  55
  56   /** @brief Returns the coordinates of the image.
  57    @param [in] coordinateType
  58     Specifies whether the returned coordinates should be relative to the screen or the parent object.
  59    @param [out] x
  60    @param [out] y
  61   */
  62   [propget] HRESULT imagePosition
  63     (
  64          [in] enum IA2CoordinateType coordinateType,
  65          [out] long *x,
  66      [out, retval] long *y
  67     );
  68
  69   /** @brief Returns the size of the image in units specified by parent's coordinate system.
  70    @param [out] height
  71    @param [out] width
  72   */
  73
  74   [propget] HRESULT imageSize
  75     (
  76      [out] long *height,
  77          [out, retval] long *width
  78     );
  79 }