offapi/com/sun/star/text/AccessibleTextEmbeddedObject.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: AccessibleTextEmbeddedObject.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_AccessibleTextEmbeddedObjectView_idl__
  31 #define __com_sun_star_text_AccessibleTextEmbeddedObjectView_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
  53 module com {  module sun {  module star {  module text {
  54
  55 //=============================================================================
  56
  57 /** The accessible view of an inactive embedded object. If an embedded
  58     object gets active, the active document gets an accessible object
  59     tree of its own. This tree is not a subtree of the object that supports
  60     this service but of the document service itself. The tree exist only
  61     until the ovject is deactivated.
  62
  63      @since OOo 1.1.2
  64  */
  65 published service AccessibleTextEmbeddedObject
  66 {
  67     /** This interface comprises the basic accessibility of embedded objects.
  68
  69         <ul>
  70             <li>The parent returned by
  71                 <method scope="::com::sun::star::accessibility"
  72                 >XAccessibleContext::getAccessibleParent</method> is the
  73                 accessible view of a paragraph if the embedded object is
  74                 bound as character, and the accessible view of the document
  75                 (or of a page in the page preview) in any other case.
  76             <li>There are no children returned by
  77                 <method scope="::com::sun::star::accessibility"
  78                 >XAccessibleContext::getAccessibleChild</method>. See above.
  79             <li>The role is <const scope="::com::sun::star::accessibility"
  80                 >AccessibleRole::EMBEDDED_OBJECT</const>
  81             <li>The name is the one assigned to the object in the text
  82                 document. This means that it is not internationalized.
  83             <li>The description is the one assigned to the object in the text
  84                 document. This means that it is not internationalized. If no
  85                 description has been set, the description equals the name.
  86             <li>There are no relations.
  87             <li>The following states might be contained in the state set
  88                 returned by <method scope="::com::sun::star::accessibility"
  89                 >XAccessibleContext::getAccessibleStateSet</method>:
  90                 <ul>
  91                     <li><const scope="::com::sun::star::accessibility"
  92                         >AccessibleStateType::DEFUNC</const> (indicates that
  93                         the document window has been closed or the graphic
  94                         is not existing any longer)
  95                     <li><const scope="::com::sun::star::accessibility"
  96                         >AccessibleStateType::EDITABLE</const>
  97                     <li><const scope="::com::sun::star::accessibility"
  98                         >AccessibleStateType::ENABLED</const> (always
  99                         contained)
 100                     <li><const scope="::com::sun::star::accessibility"
 101                         >AccessibleStateType::OPAQUE</const>
 102                     <li><const scope="::com::sun::star::accessibility"
 103                         >AccessibleStateType::SELECTABLE</const>
 104                     <li><const scope="::com::sun::star::accessibility"
 105                         >AccessibleStateType::SELECTED</const>
 106                     <li><const scope="::com::sun::star::accessibility"
 107                         >AccessibleStateType::FOCUSABLE</const>
 108                     <li><const scope="::com::sun::star::accessibility"
 109                         >AccessibleStateType::FOCUSED</const>
 110                     <li><const scope="::com::sun::star::accessibility"
 111                         >AccessibleStateType::SHOWING</const>
 112                     <li><const scope="::com::sun::star::accessibility"
 113                         >AccessibleStateType::VISIBLE</const>
 114                 </ul>
 115             <li>The locale is the one the text document itself.
 116         </ul>
 117
 118     */
 119     interface ::com::sun::star::accessibility::XAccessibleContext;
 120
 121     /** This interface describes the graphical representation of an
 122           embedded object.
 123     */
 124     interface ::com::sun::star::accessibility::XAccessibleComponent;
 125
 126     /** This interface gives access to the object's size and its description.
 127     */
 128     interface ::com::sun::star::accessibility::XAccessibleImage;
 129
 130     /** This is the interface for listeners
 131     */
 132     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 133 };
 134
 135 //=============================================================================
 136
 137 }; }; }; };
 138
 139 #endif