xref: /trunk/main/offapi/com/sun/star/accessibility/XAccessibleImage.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleImage_idl__
25cdf0e10cSrcweir#define __com_sun_star_accessibility_XAccessibleImage_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweirmodule com { module sun { module star { module accessibility {
32cdf0e10cSrcweir
33cdf0e10cSrcweir/** Implement this interface to represent images and icons.
34cdf0e10cSrcweir
35cdf0e10cSrcweir    <p>This interface is used for a representation of images like icons of
36cdf0e10cSrcweir    buttons.  The corresponding interface of the Java Accessibility API is
37cdf0e10cSrcweir    AccessibleIcon.  This interface lets you retrieve an image's size and
38cdf0e10cSrcweir    description.</p>
39cdf0e10cSrcweir
40*0d3a54ffSJürgen Schmidt    @since OpenOffice 1.1.2
41cdf0e10cSrcweir*/
42cdf0e10cSrcweirpublished interface XAccessibleImage : ::com::sun::star::uno::XInterface
43cdf0e10cSrcweir{
44cdf0e10cSrcweir    /** Returns the localized description of the image.
45cdf0e10cSrcweir
46cdf0e10cSrcweir        <p>It depends on the usage of an image whether the description
47cdf0e10cSrcweir        should express the image's function (e.g. for icons) or the actual
48cdf0e10cSrcweir        content of the image (e.g. for image maps or non-iconic images
49cdf0e10cSrcweir        embedded into a document.)</p>
50cdf0e10cSrcweir
51cdf0e10cSrcweir        @return
52cdf0e10cSrcweir            Returns a localized string that describes the images's function
53cdf0e10cSrcweir            or content.
54cdf0e10cSrcweir    */
55cdf0e10cSrcweir    string getAccessibleImageDescription ();
56cdf0e10cSrcweir
57cdf0e10cSrcweir    /** Returns the height of the image.
58cdf0e10cSrcweir
59cdf0e10cSrcweir        <p>The height is returned in units specified by the parents
60cdf0e10cSrcweir        coordinate system.</p>
61cdf0e10cSrcweir
62cdf0e10cSrcweir        @return
63cdf0e10cSrcweir            Returns the image's height with respect to the parent's
64cdf0e10cSrcweir            coordinate system.
65cdf0e10cSrcweir    */
66cdf0e10cSrcweir    long getAccessibleImageHeight ();
67cdf0e10cSrcweir
68cdf0e10cSrcweir    /** Returns the width of the image.
69cdf0e10cSrcweir
70cdf0e10cSrcweir        <p>The width is returned in units specified by the parents
71cdf0e10cSrcweir        coordinate system.</p>
72cdf0e10cSrcweir
73cdf0e10cSrcweir        @return
74cdf0e10cSrcweir            Returns the image's width with respect to the parent's
75cdf0e10cSrcweir            coordinate system.
76cdf0e10cSrcweir    */
77cdf0e10cSrcweir    long getAccessibleImageWidth ();
78cdf0e10cSrcweir};
79cdf0e10cSrcweir
80cdf0e10cSrcweir}; }; }; };
81cdf0e10cSrcweir
82cdf0e10cSrcweir#endif
83