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