1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org 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
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_accessibility_XAccessibleImage_idl__
29#define __com_sun_star_accessibility_XAccessibleImage_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35module com { module sun { module star { module accessibility {
36
37/** Implement this interface to represent images and icons.
38
39    <p>This interface is used for a representation of images like icons of
40    buttons.  The corresponding interface of the Java Accessibility API is
41    AccessibleIcon.  This interface lets you retrieve an image's size and
42    description.</p>
43
44    @since OOo 1.1.2
45*/
46published interface XAccessibleImage : ::com::sun::star::uno::XInterface
47{
48    /** Returns the localized description of the image.
49
50        <p>It depends on the usage of an image whether the description
51        should express the image's function (e.g. for icons) or the actual
52        content of the image (e.g. for image maps or non-iconic images
53        embedded into a document.)</p>
54
55        @return
56            Returns a localized string that describes the images's function
57            or content.
58    */
59    string getAccessibleImageDescription ();
60
61    /** Returns the height of the image.
62
63        <p>The height is returned in units specified by the parents
64        coordinate system.</p>
65
66        @return
67            Returns the image's height with respect to the parent's
68            coordinate system.
69    */
70    long getAccessibleImageHeight ();
71
72    /** Returns the width of the image.
73
74        <p>The width is returned in units specified by the parents
75        coordinate system.</p>
76
77        @return
78            Returns the image's width with respect to the parent's
79            coordinate system.
80    */
81    long getAccessibleImageWidth ();
82};
83
84}; }; }; };
85
86#endif
87