IAccessibleImage Interface Reference

This interface represents images and icons. More...

import "AccessibleImage.idl";

List of all members.


Public Member Functions

HRESULT description ([out, retval] BSTR *description)
 Returns the localized description of the image.
HRESULT imagePosition ([in] enum IA2CoordinateType coordinateType,[out] long *x,[out, retval] long *y)
 Returns the coordinates of the image.
HRESULT imageSize ([out] long *height,[out, retval] long *width)
 Returns the size of the image in units specified by parent's coordinate system.

Detailed Description

This interface represents images and icons.

This interface is used for a representation of images like icons on buttons. IAccessibleImage only needs to be implemented in certain situations. Some examples are:

  1. The accessible name and description are not enough to fully describe the image, e.g. when the accessible description is used to define the behavior of an actionable image and the image itself conveys semantically significant information.
  2. The user can edit the content that includes an image and therefore the user needs to be able to review the image's position.

Member Function Documentation

HRESULT IAccessibleImage::description ( [out, retval] BSTR *  description  )  [get]

Returns the localized description of the image.

Parameters:
[out] description 
Return values:
S_OK 
S_FALSE if there is nothing to return, [out] value is NULL

HRESULT IAccessibleImage::imagePosition ( [in] enum IA2CoordinateType  coordinateType,
[out] long *  x,
[out, retval] long *  y 
) [get]

Returns the coordinates of the image.

Parameters:
[in] coordinateType Specifies whether the returned coordinates should be relative to the screen or the parent object.
[out] x 
[out] y 
Return values:
S_OK 

HRESULT IAccessibleImage::imageSize ( [out] long *  height,
[out, retval] long *  width 
) [get]

Returns the size of the image in units specified by parent's coordinate system.

Parameters:
[out] height 
[out] width 
Return values:
S_OK 


The documentation for this interface was generated from the following file:

To submit feedback on IAccessible2 API Version 1.2, please use the Bugzilla interface located at: http://bugs.linuxfoundation.org/. When using Bugzilla please be sure to select IAccessible2 from the list of components. Bugzilla is the preferred method for receiving feedback because it automatically logs one's feedback in the IAccessible2 tracking system without additional human intervention. One may also, however, send email to accessibility-rfc@a11y.org, a publicly archived emailing list. Please address any technical problems you encounter with this document or the resources to which it links, to the Open A11y Webmaster <webmaster@a11y.org>

A stable online reference version of the documentation for IAccessible2 API Version 1.2, is available at: http://a11y.org/ia2-spec. A list of known and reported errors in the documentation for IAccessible2 API Version 1.2 can be found at: http://a11y.org/ia2-errata


Generated on Mon Jun 21 10:42:52 2010 for IAccessible2 API Version 1.2 by  doxygen 1.5.6