offapi/com/sun/star/text/AccessibleTextGraphicObject.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: AccessibleTextGraphicObject.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 #ifndef __com_sun_star_text_AccessibleTextGraphicObjectView_idl__
  31 #define __com_sun_star_text_AccessibleTextGraphicObjectView_idl__
  32
  33 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  34 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  38 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_accessibility_XAccessibleImage_idl__
  42 #include <com/sun/star/accessibility/XAccessibleImage.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  46 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module text {
  53
  54 //=============================================================================
  55
  56 /** The accessible view of graphics.
  57
  58      @since OOo 1.1.2
  59  */
  60 published service AccessibleTextGraphicObject
  61 {
  62     /** This interface comprises the basic accessibility of text graphics.
  63
  64         <ul>
  65             <li>The parent returned by
  66                 <method scope="::com::sun::star::accessibility"
  67                 >XAccessibleContext::getAccessibleParent</method> is the
  68                 accessible view of a paragraph if the graphic is bound as
  69                 character, and the accessible view of the document (or of a
  70                 page in the page preview) in any other case.
  71             <li>There are no chidren returned by
  72                 <method scope="::com::sun::star::accessibility"
  73                 >XAccessibleContext::getAccessibleChild</method>.
  74             <li>The role is <const scope="::com::sun::star::accessibility"
  75                 >AccessibleRole::GRAPHIC</const>
  76             <li>The name is the one assigned to the graphic in the text
  77                 document. This means that it is not internationalized.
  78             <li>The description is the one assigned to the graphic in the text
  79                 document. This means that it is not internationalized. If no
  80                 description has been set, the description equals the name.
  81             <li>There are no relations.
  82             <li>The following states might be contained in the state set
  83                 returned by <method scope="::com::sun::star::accessibility
  84                 ">XAccessibleContext::getAccessibleStateSet</type>:
  85                 <ul>
  86                     <li><const scope="::com::sun::star::accessibility"
  87                         >AccessibleStateType::DEFUNC</const> (indicates that
  88                         the document window has been closed or the graphic
  89                         is not existing any longer)
  90                     <li><const scope="::com::sun::star::accessibility"
  91                         >AccessibleStateType::EDITABLE</const>
  92                     <li><const scope="::com::sun::star::accessibility"
  93                         >AccessibleStateType::ENABLED</const> (always
  94                         contained)
  95                     <li><const scope="::com::sun::star::accessibility"
  96                         >AccessibleStateType::OPAQUE</const>
  97                     <li><const scope="::com::sun::star::accessibility"
  98                         >AccessibleStateType::SELECTABLE</const>
  99                     <li><const scope="::com::sun::star::accessibility"
 100                         >AccessibleStateType::SELECTED</const>
 101                     <li><const scope="::com::sun::star::accessibility"
 102                         >AccessibleStateType::FOCUSABLE</const>
 103                     <li><const scope="::com::sun::star::accessibility"
 104                         >AccessibleStateType::FOCUSED</const>
 105                     <li><const scope="::com::sun::star::accessibility"
 106                         >AccessibleStateType::SHOWING</const>
 107                     <li><const scope="::com::sun::star::accessibility"
 108                         >AccessibleStateType::VISIBLE</const>
 109                 </ul>
 110             <li>The locale is the one the text document itself.
 111         </ul>
 112
 113      */
 114     interface ::com::sun::star::accessibility::XAccessibleContext;
 115
 116     /** This interface describes the graphical representation of a
 117           graphic.
 118      */
 119     interface ::com::sun::star::accessibility::XAccessibleComponent;
 120
 121     /** This interface gives access to the image size and its description.
 122      */
 123     interface ::com::sun::star::accessibility::XAccessibleImage;
 124
 125     /** This is the interface for listeners */
 126     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 127 };
 128
 129 //=============================================================================
 130
 131 }; }; }; };
 132
 133 #endif