offapi/com/sun/star/text/AccessibleTextGraphicObject.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_AccessibleTextGraphicObjectView_idl__
  28 #define __com_sun_star_text_AccessibleTextGraphicObjectView_idl__
  29
  30 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  31 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  35 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_accessibility_XAccessibleImage_idl__
  39 #include <com/sun/star/accessibility/XAccessibleImage.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  43 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  44 #endif
  45
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module text {
  50
  51 //=============================================================================
  52
  53 /** The accessible view of graphics.
  54
  55      @since OOo 1.1.2
  56  */
  57 published service AccessibleTextGraphicObject
  58 {
  59     /** This interface comprises the basic accessibility of text graphics.
  60
  61         <ul>
  62             <li>The parent returned by
  63                 <method scope="::com::sun::star::accessibility"
  64                 >XAccessibleContext::getAccessibleParent</method> is the
  65                 accessible view of a paragraph if the graphic is bound as
  66                 character, and the accessible view of the document (or of a
  67                 page in the page preview) in any other case.
  68             <li>There are no chidren returned by
  69                 <method scope="::com::sun::star::accessibility"
  70                 >XAccessibleContext::getAccessibleChild</method>.
  71             <li>The role is <const scope="::com::sun::star::accessibility"
  72                 >AccessibleRole::GRAPHIC</const>
  73             <li>The name is the one assigned to the graphic in the text
  74                 document. This means that it is not internationalized.
  75             <li>The description is the one assigned to the graphic in the text
  76                 document. This means that it is not internationalized. If no
  77                 description has been set, the description equals the name.
  78             <li>There are no relations.
  79             <li>The following states might be contained in the state set
  80                 returned by <method scope="::com::sun::star::accessibility
  81                 ">XAccessibleContext::getAccessibleStateSet</type>:
  82                 <ul>
  83                     <li><const scope="::com::sun::star::accessibility"
  84                         >AccessibleStateType::DEFUNC</const> (indicates that
  85                         the document window has been closed or the graphic
  86                         is not existing any longer)
  87                     <li><const scope="::com::sun::star::accessibility"
  88                         >AccessibleStateType::EDITABLE</const>
  89                     <li><const scope="::com::sun::star::accessibility"
  90                         >AccessibleStateType::ENABLED</const> (always
  91                         contained)
  92                     <li><const scope="::com::sun::star::accessibility"
  93                         >AccessibleStateType::OPAQUE</const>
  94                     <li><const scope="::com::sun::star::accessibility"
  95                         >AccessibleStateType::SELECTABLE</const>
  96                     <li><const scope="::com::sun::star::accessibility"
  97                         >AccessibleStateType::SELECTED</const>
  98                     <li><const scope="::com::sun::star::accessibility"
  99                         >AccessibleStateType::FOCUSABLE</const>
 100                     <li><const scope="::com::sun::star::accessibility"
 101                         >AccessibleStateType::FOCUSED</const>
 102                     <li><const scope="::com::sun::star::accessibility"
 103                         >AccessibleStateType::SHOWING</const>
 104                     <li><const scope="::com::sun::star::accessibility"
 105                         >AccessibleStateType::VISIBLE</const>
 106                 </ul>
 107             <li>The locale is the one the text document itself.
 108         </ul>
 109
 110      */
 111     interface ::com::sun::star::accessibility::XAccessibleContext;
 112
 113     /** This interface describes the graphical representation of a
 114           graphic.
 115      */
 116     interface ::com::sun::star::accessibility::XAccessibleComponent;
 117
 118     /** This interface gives access to the image size and its description.
 119      */
 120     interface ::com::sun::star::accessibility::XAccessibleImage;
 121
 122     /** This is the interface for listeners */
 123     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 124 };
 125
 126 //=============================================================================
 127
 128 }; }; }; };
 129
 130 #endif