offapi/com/sun/star/drawing/AccessibleGraphicShape.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_drawing_AccessibleGraphicShape_idl__
  21 #define __com_sun_star_drawing_AccessibleGraphicShape_idl__
  22
  23 #include <com/sun/star/drawing/AccessibleShape.idl>
  24 #include <com/sun/star/accessibility/XAccessibleImage.idl>
  25
  26 module com {  module sun {  module star {  module drawing {
  27
  28 /** The AccessibleGraphicShape service is implemented by the
  29     graphic object shapes shapes com.sun.star.drawing.GraphicObjectShape and
  30     com.sun.star.presentation.GraphicObjectShape.
  31
  32     <p>It differs from the included AccessibleShape "base"
  33     service by the additional support of the
  34     ::com::sun::star::accessibility::XAccessibleImage
  35     interface.</p>
  36
  37      @since OOo 1.1.2
  38 */
  39 service AccessibleGraphicShape
  40 {
  41     /** Give access to information of generic shapes.
  42
  43         <p>See AccessibleShape for documentation and support of
  44         the interfaces
  45         ::com::sun::star::accessibility::XAccessible,
  46         ::com::sun::star::accessibility::XAccessibleContext,
  47         and
  48         ::com::sun::star::accessibility::XAccessibleComponent.</p>
  49
  50         @see AccessibleShape
  51     */
  52     service AccessibleShape;
  53
  54     /**  Give access to image specific information.
  55
  56         <p>The support of the
  57         ::com::sun::star::accessibility::XAccessibleImage interface
  58         requires the shape to provide a description of the displayed image
  59         and the image's size in the screen coordinate system (pixel).  At
  60         the time being this interface does not provide information that is
  61         not available through the AccessibleShape service:
  62         the size returned by the
  63         ::com::sun::star::accessibility::XAccessibleImage::getAccessibleImageWidth() and
  64         ::com::sun::star::accessibility::XAccessibleImage::getAccessibleImageHeight()
  65         functions is the same as that returned by the
  66         ::com::sun::star::accessibility::XAccessibleComponent::getSize()
  67         function; the description returned by
  68         ::com::sun::star::accessibility::XAccessibleImage::getAccessibleImageDescription()
  69         function is the same as the one returned by the
  70         ::com::sun::star::accessibility::XAccessibleContext::getAccessibleDescription()
  71         function.
  72         This makes the additional interface for
  73         the time being basically an indicator of graphic shapes.  This may
  74         change in the future.</p>
  75     */
  76     interface ::com::sun::star::accessibility::XAccessibleImage;
  77 };
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */