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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_AccessibleParagraphView_idl__
  20 #define __com_sun_star_text_AccessibleParagraphView_idl__
  21
  22 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  23 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  24 #include <com/sun/star/accessibility/XAccessibleEditableText.idl>
  25 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  26 #include <com/sun/star/accessibility/XAccessibleTextAttributes.idl>
  27
  28
  29 module com {  module sun {  module star {  module text {
  30
  31
  32 /** The accessible view of a paragraph fragment.
  33
  34
  35      @since OOo 1.1.2
  36  */
  37 service AccessibleParagraphView
  38 {
  39     /** This interface gives access to a paragraph fragment that is at least
  40           partially visible on the screen. A paragraph fragment is the portion
  41         of a paragraph that is displayed on a single page or a in a single
  42         column.
  43
  44         <ul>
  45             <li>The parent returned by
  46                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  47                 is the accessible view of a text document (in this case the
  48                 paragraph is contained in a page body) or the accessible
  49                 view of a header, footer, footnote, endnote, table cell,
  50                 text frame, page or shape.</li>
  51             <li>The children returned by
  52                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  53                 are the graphics, text boxes and OLE objects that are bound
  54                 <em>as</em> character within the paragraph. Graphics, text
  55                 boxes and OLE objects that are bound to the paragraph or
  56                 <em>to</em> a character within the paragraph are not
  57                 children of the paragraph fragment but of the document view
  58                 itself.</li>
  59             <li>The role is either
  60                 ::com::sun::star::accessibility::AccessibleRole::PARAGRAPH or
  61                 ::com::sun::star::accessibility::AccessibleRole::HEADING.
  62                 The later one is returned
  63                 if the paragraph's style is contained in the chapter
  64                 numbering of a text document.
  65             <li>The name is "paragraph" or "heading" (or the equivalent term
  66                 in application's language) with a number appended.
  67             <li>The description contains the term "paragraph" (or the equivalent
  68                 term in application's language) and the first sentence of
  69                 the paragraph.
  70             <li>There are no relations.
  71             <li>The following states are supported by the
  72                 ::com::sun::star::accessibility::XAccessibleStateSet returned by
  73                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet().
  74                 <ul>
  75                     <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  76                         (indicates that
  77                         the document window has been closed or the paragraph
  78                         fragment is not existing any longer).
  79                     <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  80                     <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  81                         (always contained)
  82                     <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
  83                         (always contained)
  84                     <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
  85                         (always contained)
  86                     <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  87                     <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
  88                     <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
  89                     <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED
  90                 </ul>
  91             <li>Depending of the application's region setting, the locale is
  92                 the western, Asian or complex language of the paragraph.
  93         </ul>
  94
  95      */
  96     interface ::com::sun::star::accessibility::XAccessibleContext;
  97
  98     /** This interface describes the graphical representation of a paragraph
  99           fragment.
 100      */
 101     interface ::com::sun::star::accessibility::XAccessibleComponent;
 102
 103     /** This interface gives access to a paragraph fragment's text. The text
 104           contains the paragraph's editable text as well as generated text,
 105         like chapter numbers, hyphens or fields. Characters of generated
 106         text contribute to the text's character indexing. However, it is not
 107         possible to set the caret or start a selection within generated text.
 108         <p>For text frames, graphics, etc. that are bound as character some
 109         text is generated that contains the objects description.
 110         <p>The attributes (or properties) returned by
 111         ::com::sun::star::accessibility::XAccessibleText::getCharacterAttributes()
 112         are a sub set of the properties described by the service
 113         ::com::sun::star::style::CharacterProperties. For
 114         properties that have Asian and complex counterparts, the value that
 115         is visible is returned. This can be in fact the western, Asian or
 116         complex value.  Its not possible to change the value of any property
 117         by using
 118         ::com::sun::star::accessibility::XAccessibleEditableText::setAttributes().
 119         <p><em>TODO: If there is a demand, some attributes might be added that
 120         tells whether the character at a certain index is editable or generated.
 121         </em>
 122
 123      */
 124     [optional] interface ::com::sun::star::accessibility::XAccessibleEditableText;
 125
 126     /** This interface is a subset of
 127         ::com::sun::star::accessibility::XAccessibleEditableText
 128         and gives access to a paragraph
 129         fragment's text in a read-only mode.  The text contains the
 130         paragraph's text (changeable as well as generated text, like chapter
 131         numbers, hyphens or fields). Characters of generated text contribute
 132         to the text's character indexing.
 133         <p>For text frames, graphics, etc. that are bound as character
 134         some text is generated that contains the objects description.
 135         <p>The attributes (or properties) returned by
 136         ::com::sun::star::accessibility::XAccessibleText::getCharacterAttributes()
 137         are a sub set of the properties described by the service
 138         ::com::sun::star::style::CharacterProperties. For
 139         properties that have Asian and complex counterparts, the value that
 140         is visible is returned. This can be in fact the western, Asian or
 141         complex value.
 142         <p><em>TODO: If there is a demand, some attributes might be added
 143         that tells whether the character at a certain index is changeable or
 144         generated.
 145         </em>
 146      */
 147     interface ::com::sun::star::accessibility::XAccessibleText;
 148
 149     /** This interface is for selecting the paragraph's children. Multi
 150         selection is supported only for children that are multi selectable
 151         in the GUI, too.
 152     */
 153     [optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
 154
 155     /** This is the interface for listeners.
 156     */
 157     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 158
 159         /** This interface gives access to the default attributes of a paragraph
 160             and to the run attributes of a certain character in a paragraph
 161
 162             @since OOo 2.0.4
 163         */
 164         [optional] interface ::com::sun::star::accessibility::XAccessibleTextAttributes;
 165
 166 };
 167
 168
 169 }; }; }; };
 170
 171 #endif
 172
 173 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */