offapi/com/sun/star/text/AccessibleParagraphView.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: AccessibleParagraphView.idl,v $
  10  * $Revision: 1.9 $
  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_AccessibleParagraphView_idl__
  31 #define __com_sun_star_text_AccessibleParagraphView_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_XAccessibleEditableText_idl__
  42 #include <com/sun/star/accessibility/XAccessibleEditableText.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  46 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_accessibility_XAccessibleTextAttributes_idl__
  50 #include <com/sun/star/accessibility/XAccessibleTextAttributes.idl>
  51 #endif
  52
  53 //=============================================================================
  54
  55 module com {  module sun {  module star {  module text {
  56
  57 //=============================================================================
  58
  59 /** The accessible view of a paragraph fragment.
  60
  61
  62      @since OOo 1.1.2
  63  */
  64 published service AccessibleParagraphView
  65 {
  66     /** This interface gives access to a paragraph fragment that is at least
  67           partially visible on the screen. A paragraph fragment is the portion
  68         of a paragraph that is displayed on a single page or a in a single
  69         column.
  70
  71         <ul>
  72             <li>The parent returned by
  73                 <method scope="::com::sun::star::accessibility"
  74                 >XAccessibleContext::getAccessibleParent</method> is the
  75                 accessible view of a text document (in this case the
  76                 paragraph is contained in a page body) or the accessible
  77                 view of a header, footer, footnote, endnote, table cell,
  78                 text frame, page or shape.</li>
  79             <li>The children returned by
  80                 <method scope="::com::sun::star::accessibility"
  81                 >XAccessibleContext::getAccessibleChild</method> are the
  82                 graphics, text boxes and OLE objects that are bound
  83                 <em>as</em> character within the paragraph. Graphics, text
  84                 boxes and OLE objects that are bound to the paragraph or
  85                 <em>to</em> a character within the paragraph are not
  86                 children of the paragraph fragment but of the document view
  87                 itself.</li>
  88             <li>The role is either
  89                 <const scope="::com::sun::star::accessibility"
  90                 >AccessibleRole::PARAGRAPH</const> or
  91                 <const scope="::com::sun::star::accessibility"
  92                 >AccessibleRole::HEADING</const>. The later one is returned
  93                 if the paragraph's style is contained in the chapter
  94                 numbering of a text document.
  95             <li>The name is "paragraph" or "heading" (or the equivalent term
  96                 in application's language) with a number appended.
  97             <li>The description contains the term "paragraph" (or the equivalent
  98                 term in application's language) and the first sentence of
  99                 the paragraph.
 100             <li>There are no relations.
 101             <li>The following states are supported by the
 102                 <type scope="::com::sun::star::accessibility"
 103                 >XAccessibleStateSet</type> returned by
 104                 <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 paragraph
 110                         fragment 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::MULTILINE</const> (always
 118                         contained)
 119                     <li><const scope="::com::sun::star::accessibility"
 120                         >AccessibleStateType::MULTISELECTABLE</const>
 121                         (always contained)
 122                     <li><const scope="::com::sun::star::accessibility"
 123                         >AccessibleStateType::OPAQUE</const>
 124                     <li><const scope="::com::sun::star::accessibility"
 125                         >AccessibleStateType::SHOWING</const>
 126                     <li><const scope="::com::sun::star::accessibility"
 127                         >AccessibleStateType::VISIBLE</const>
 128                     <li><const scope="::com::sun::star::accessibility"
 129                         >AccessibleStateType::FOCUSED</const>
 130                 </ul>
 131             <li>Depending of the application's region setting, the locale is
 132                 the western, asian or complex language of the paragraph.
 133         </ul>
 134
 135      */
 136     interface ::com::sun::star::accessibility::XAccessibleContext;
 137
 138     /** This interface describes the graphical representation of a paragraph
 139           fragment.
 140      */
 141     interface ::com::sun::star::accessibility::XAccessibleComponent;
 142
 143     /** This interface gives access to a paragraph fragment's text. The text
 144           contains the paragraph's editable text as well as generated text,
 145         like chapter numbers, hyphens or fields. Characters of generated
 146         text contribute to the text's character indexing. However, it is not
 147         possible to set the caret or start a selection within generated text.
 148         <p>For text frames, graphics, etc. that are bound as character some
 149         text is generated that contains the objects description.
 150         <p>The attributes (or properties) returned by
 151         <method scope="::com::sun::star::accessibility"
 152         >XAccessibleText::getCharacterAttributes</method>
 153         are a sub set of the properties described by the service
 154         <type scope="::com::sun::star::style">CharacterProperties</type>. For
 155         properties that have asian and complex counterparts, the value that
 156         is visible is returned. This can be in fact the western, asian or
 157         complex value.  Its not possible to change the value of any property
 158         by using
 159         <method scope="::com::sun::star::accessibility"
 160         >XAccessibleEditableText::setAttributes</method>.
 161         <p><em>TODO: If there is a demand, some attributes might be added that
 162         tells whether the character at a certain index is editable or generated.
 163         </em>
 164
 165      */
 166     [optional] interface ::com::sun::star::accessibility::XAccessibleEditableText;
 167
 168     /** This interface is a subset of
 169         <type scope="::com::sun::star::accessibility"
 170         >XAccessibleEditableText</type> and gives access to a paragraph
 171         fragment's text in a read-only mode.  The text contains the
 172         paragraph's text (changeable as well as generated text, like chapter
 173         numbers, hyphens or fields). Characters of generated text contribute
 174         to the text's character indexing.
 175         <p>For text frames, graphics, etc. that are bound as character
 176         some text is generated that contains the objects description.
 177         <p>The attributes (or properties) returned by
 178         <method scope="::com::sun::star::accessibility"
 179         >XAccessibleText::getCharacterAttributes</method> are a sub set of the properties
 180         described by the service
 181         <type scope="::com::sun::star::style">CharacterProperties</type>. For
 182         properties that have asian and complex counterparts, the value that
 183         is visible is returned. This can be in fact the western, asian or
 184         complex value.
 185         <p><em>TODO: If there is a demand, some attributes might be added
 186         that tells whether the character at a certain index is changeable or
 187         generated.
 188         </em>
 189      */
 190     interface ::com::sun::star::accessibility::XAccessibleText;
 191
 192     /** This interface is for selecting the paragraph's children. Multi
 193         selection is supported only for children that are multi selectable
 194         in the GUI, too.
 195     */
 196     [optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
 197
 198     /** This is the interface for listeners.
 199     */
 200     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 201
 202         /** This interface gives access to the default attributes of a paragraph
 203             and to the run attributes of a certain character in a paragraph
 204
 205             @since OOo 2.0.4
 206         */
 207         [optional] interface ::com::sun::star::accessibility::XAccessibleTextAttributes;
 208
 209 };
 210
 211 //=============================================================================
 212
 213 }; }; }; };
 214
 215 #endif