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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleGraphicShape.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_drawing_AccessibleGraphicShape_idl__
  32 #define __com_sun_star_drawing_AccessibleGraphicShape_idl__
  33
  34 #ifndef __com_sun_star_drawing_AccessibleShape_idl__
  35 #include <com/sun/star/drawing/AccessibleShape.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_accessibility_XAccessibleImage_idl__
  39 #include <com/sun/star/accessibility/XAccessibleImage.idl>
  40 #endif
  41
  42 module com {  module sun {  module star {  module drawing {
  43
  44 /** The <type>AccessibleGraphicShape</type> service is implemented by the
  45     graphic object shapes shapes com.sun.star.drawing.GraphicObjectShape and
  46     com.sun.star.presentation.GraphicObjectShape.
  47
  48     <p>It differs from the included <type>AccessibleShape</type> 'base'
  49     service by the additional support of the
  50     <type
  51     scope="::com::sun::star::accessibility">XAccessibleImage</type>
  52     interface.</p>
  53
  54      @since OOo 1.1.2
  55 */
  56 published service AccessibleGraphicShape
  57 {
  58     /** Give access to information of generic shapes.
  59
  60         <p>See <type>AccessibleShape</type> for documentation and support of
  61         the interfaces
  62         <type scope="::com::sun::star::accessibility">XAccessible</type>,
  63         <type scope="::com::sun::star::accessibility">XAccessibleContext</type>,
  64         and
  65         <type scope="::com::sun::star::accessibility">XAccessibleComponent</type>.</p>
  66
  67         @see AccessibleShape
  68     */
  69     service AccessibleShape;
  70
  71     /**  Give access to image specific information.
  72
  73         <p>The support of the <type
  74         scope="::com::sun::star::accessibility"
  75         >XAccessibleImage</type> interface
  76         requires the shape to provide a description of the displayed image
  77         and the image's size in the screen coordinate system (pixel).  At
  78         the time being this interface does not provide information that is
  79         not available through the <type>AccessibleShape</type> service:
  80         the size returned by the
  81         <member scope="::com::sun::star::accessibility"
  82         >XAccessibleImage::getWidth</member> and <member
  83         scope="::com::sun::star::accessibility"
  84         >XAccessibleImage::getHeight</member> functions is the same as that
  85         returned by the <member
  86         scope="::com::sun::star::accessibility"
  87         >XAccessibleComponent::getSize</member> function; the description
  88         returned by <member
  89         scope="::com::sun::star::accessibility"
  90         >XAccessibleImage::getAccessibleImageDescription</member> function
  91         is the same as the one returned by the <member
  92         scope="::com::sun::star::accessibility"
  93         >XAccessibleContext::getAccessibleDescription</member> function.
  94         This makes the additional interface for
  95         the time being basically an indicator of graphic shapes.  This may
  96         change in the future.</p>
  97     */
  98     interface ::com::sun::star::accessibility::XAccessibleImage;
  99 };
 100
 101 }; }; }; };
 102
 103 #endif