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
  20
  21 module com {  module sun {  module star {  module text {
  22
  23
  24 /** The accessible view of a paragraph fragment.
  25
  26
  27      @since OOo 1.1.2
  28  */
  29 service AccessibleParagraphView
  30 {
  31     /** This interface gives access to a paragraph fragment that is at least
  32           partially visible on the screen. A paragraph fragment is the portion
  33         of a paragraph that is displayed on a single page or a in a single
  34         column.
  35
  36         <ul>
  37             <li>The parent returned by
  38                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  39                 is the accessible view of a text document (in this case the
  40                 paragraph is contained in a page body) or the accessible
  41                 view of a header, footer, footnote, endnote, table cell,
  42                 text frame, page or shape.</li>
  43             <li>The children returned by
  44                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  45                 are the graphics, text boxes and OLE objects that are bound
  46                 <em>as</em> character within the paragraph. Graphics, text
  47                 boxes and OLE objects that are bound to the paragraph or
  48                 <em>to</em> a character within the paragraph are not
  49                 children of the paragraph fragment but of the document view
  50                 itself.</li>
  51             <li>The role is either
  52                 ::com::sun::star::accessibility::AccessibleRole::PARAGRAPH,
  53                 ::com::sun::star::accessibility::AccessibleRole::BLOCK_QUOTE or
  54                 ::com::sun::star::accessibility::AccessibleRole::HEADING.
  55                 The latter is returned
  56                 if the paragraph's style is contained in the chapter
  57                 numbering of a text document.
  58             <li>The name is "paragraph" or "heading" (or the equivalent term
  59                 in application's language) with a number appended.
  60             <li>The description contains the term "paragraph" (or the equivalent
  61                 term in application's language) and the first sentence of
  62                 the paragraph.
  63             <li>There are no relations.
  64             <li>The following states are supported by the
  65                 accessible state bitset returned by
  66                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet().
  67                 <ul>
  68                     <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  69                         (indicates that
  70                         the document window has been closed or the paragraph
  71                         fragment is not existing any longer).
  72                     <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  73                     <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  74                         (always contained)
  75                     <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
  76                         (always contained)
  77                     <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
  78                         (always contained)
  79                     <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  80                     <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
  81                     <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
  82                     <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED
  83                 </ul>
  84             <li>Depending of the application's region setting, the locale is
  85                 the western, Asian or complex language of the paragraph.
  86         </ul>
  87
  88      */
  89     interface ::com::sun::star::accessibility::XAccessibleContext;
  90
  91     /** This interface describes the graphical representation of a paragraph
  92           fragment.
  93      */
  94     interface ::com::sun::star::accessibility::XAccessibleComponent;
  95
  96     /** This interface gives access to a paragraph fragment's text. The text
  97           contains the paragraph's editable text as well as generated text,
  98         like chapter numbers, hyphens or fields. Characters of generated
  99         text contribute to the text's character indexing. However, it is not
 100         possible to set the caret or start a selection within generated text.
 101         <p>For text frames, graphics, etc. that are bound as character some
 102         text is generated that contains the objects description.
 103         <p>The attributes (or properties) returned by
 104         ::com::sun::star::accessibility::XAccessibleText::getCharacterAttributes()
 105         are a sub set of the properties described by the service
 106         ::com::sun::star::style::CharacterProperties. For
 107         properties that have Asian and complex counterparts, the value that
 108         is visible is returned. This can be in fact the western, Asian or
 109         complex value. It's not possible to change the value of any property
 110         by using
 111         ::com::sun::star::accessibility::XAccessibleEditableText::setAttributes().
 112         <p><em>TODO: If there is a demand, some attributes might be added that
 113         tells whether the character at a certain index is editable or generated.
 114         </em>
 115
 116      */
 117     [optional] interface ::com::sun::star::accessibility::XAccessibleEditableText;
 118
 119     /** This interface is a subset of
 120         ::com::sun::star::accessibility::XAccessibleEditableText
 121         and gives access to a paragraph
 122         fragment's text in a read-only mode.  The text contains the
 123         paragraph's text (changeable as well as generated text, like chapter
 124         numbers, hyphens or fields). Characters of generated text contribute
 125         to the text's character indexing.
 126         <p>For text frames, graphics, etc. that are bound as character
 127         some text is generated that contains the objects description.
 128         <p>The attributes (or properties) returned by
 129         ::com::sun::star::accessibility::XAccessibleText::getCharacterAttributes()
 130         are a sub set of the properties described by the service
 131         ::com::sun::star::style::CharacterProperties. For
 132         properties that have Asian and complex counterparts, the value that
 133         is visible is returned. This can be in fact the western, Asian or
 134         complex value.
 135         <p><em>TODO: If there is a demand, some attributes might be added
 136         that tells whether the character at a certain index is changeable or
 137         generated.
 138         </em>
 139      */
 140     interface ::com::sun::star::accessibility::XAccessibleText;
 141
 142     /** This interface is for selecting the paragraph's children. Multi
 143         selection is supported only for children that are multi selectable
 144         in the GUI, too.
 145     */
 146     [optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
 147
 148     /** This is the interface for listeners.
 149     */
 150     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 151
 152         /** This interface gives access to the default attributes of a paragraph
 153             and to the run attributes of a certain character in a paragraph
 154
 155             @since OOo 2.0.4
 156         */
 157         [optional] interface ::com::sun::star::accessibility::XAccessibleTextAttributes;
 158
 159 };
 160
 161
 162 }; }; }; };
 163
 164 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */