offapi/com/sun/star/accessibility/XAccessibleImage.idl

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