other-licenses/ia2/AccessibleImage.idlNot scriptable
This interface represents images and icons.
1.0
66
Introduced
Gecko 1.9
Inherits from: IUnknown Last changed in Gecko 1.9 (Firefox 3)

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, for example 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.

Method overview

[propget] HRESULT description([out] BSTR description );
[propget] HRESULT imagePosition([in] enum IA2CoordinateType coordinateType, [out] long x, [out] long y );
[propget] HRESULT imageSize([out] long height, [out] long width );

Methods

description()

Returns the localized description of the image.

[propget] HRESULT description(
  [out] BSTR description
);
Parameters
description
The localized description of the image.
Return value

S_FALSE if there is nothing to return, [out] value is null. S_OK.

imagePosition()

Returns the coordinates of the image.

[propget] HRESULT imagePosition(
  [in] enum IA2CoordinateType coordinateType,
  [out] long x,
  [out] long y
);
Parameters
coordinateType
Specifies whether the returned coordinates should be relative to the screen or the parent object.
x
The x coordinate.
y
The y coordinate.
Return value

S_OK.

imageSize()

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

[propget] HRESULT imageSize(
  [out] long height,
  [out] long width
);
Parameters
height
The height of the image.
width
The width of the image.
Return value

S_OK.