offapi/com/sun/star/text/AccessibleTextFrameView.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: AccessibleTextFrameView.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_AccessibleTextFrameView_idl__
  31 #define __com_sun_star_text_AccessibleTextFrameView_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
  42 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  43 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module text {
  49
  50 //=============================================================================
  51
  52 /** The accessible view of text frames.
  53
  54      @since OOo 1.1.2
  55  */
  56 published service AccessibleTextFrameView
  57 {
  58     /** This interface gives access to any paragraph fragment and table
  59         fragment that is contained in a text frame and at least
  60         partially visible on the screen.
  61
  62         <ul>
  63             <li>The parent returned by
  64                 <method scope="::com::sun::star::accessibility"
  65                 >XAccessibleContext::getAccessibleParent</type> is the
  66                 accessible view of a paragraph if the text frame is bound as
  67                 character, and the accessible view (or of a page in the page
  68                 preview) of the document in any other case.
  69             <li>The children returned by
  70                 <method scope="::com::sun::star::accessibility"
  71                 >XAccessibleContext::getAccessibleChild</type> all support the
  72                 interface XAccessible. Calling
  73                 <method scope="::com::sun::star::accessibility"
  74                 >XAccessible::getAccessibleContext</type> for these children
  75                 returns an object that supports one of the following
  76                 services.
  77                 <ul>
  78                     <li><type scope="::com::sun::star::text"
  79                         >AccessibleParagraphView</type>: A child of this
  80                         kind is returned for every paragraph fragment that
  81                         is contained in the document body and is at least
  82                         partially visible. A paragraph fragment is the part
  83                         of a paragraph that is displayed on a certain page
  84                         or a certain column.
  85                     <li><type scope="::com::sun::star::table"
  86                         >AccessibleTableView</type>: A child of this kind is
  87                         returned for every table fragment that is contained
  88                         in the document body and is at least partially
  89                         visible. A table fragment is the part of a table
  90                         that is displayed on a certain page or a certain
  91                         column.
  92                 </ul>
  93                 <p>The logical order of paragraph and table fragments is never
  94                    changed.
  95             <li>The role is <const scope="::com::sun::star::accessibility"
  96                 >AccessibleRole::TEXT_FRAME</const>
  97             <li>The name is the one assigned to the text frame in the text
  98                 document. This means that it is not internationalized.
  99             <li>The description is the one assigned to the text frame in the
 100                 text document. This means that it is not internationalized. If
 101                 no description has been set, the description equals the name.
 102             <li>There are no relations.
 103             <li>The following states might be contained in the state set
 104                 returned by <method scope="::com::sun::star::accessibility"
 105                 >XAccessibleContext::getAccessibleStateSet</method>:
 106                 <ul>
 107                     <li><const scope="::com::sun::star::accessibility"
 108                         >AccessibleStateType::DEFUNC</const> (indicates that
 109                         the document window has been closed or the graphic
 110                         is not existing any longer)
 111                     <li><const scope="::com::sun::star::accessibility"
 112                         >AccessibleStateType::EDITABLE</const>
 113                     <li><const scope="::com::sun::star::accessibility"
 114                         >AccessibleStateType::ENABLED</const> (always
 115                         contained)
 116                     <li><const scope="::com::sun::star::accessibility"
 117                         >AccessibleStateType::OPAQUE</const>
 118                     <li><const scope="::com::sun::star::accessibility"
 119                         >AccessibleStateType::SELECTABLE</const>
 120                     <li><const scope="::com::sun::star::accessibility"
 121                         >AccessibleStateType::SELECTED</const>
 122                     <li><const scope="::com::sun::star::accessibility"
 123                         >AccessibleStateType::FOCUSABLE</const>
 124                     <li><const scope="::com::sun::star::accessibility"
 125                         >AccessibleStateType::FOCUSED</const>
 126                     <li><const scope="::com::sun::star::accessibility"
 127                         >AccessibleStateType::SHOWING</const>
 128                     <li><const scope="::com::sun::star::accessibility"
 129                         >AccessibleStateType::VISIBLE</const>
 130                 </ul>
 131             <li>The locale is the one the text document itself.
 132             <li>There are the two relations CONTENT_FLOWS_FROM and
 133                 CONTENT_FLOWS_TO supported.
 134         </ul>
 135
 136      */
 137     interface ::com::sun::star::accessibility::XAccessibleContext;
 138
 139     /** This interface describes the graphical representation of a
 140           text frame.
 141      */
 142     interface ::com::sun::star::accessibility::XAccessibleComponent;
 143
 144     /** This is the interface for listeners */
 145     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 146 };
 147
 148 //=============================================================================
 149
 150 }; }; }; };
 151
 152 #endif