offapi/com/sun/star/text/AccessibleTextDocumentView.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
  22 module com {  module sun {  module star {  module text {
  23
  24
  25 /** The accessible view of a text document.
  26
  27      @since OOo 1.1.2
  28  */
  29 service AccessibleTextDocumentView
  30 {
  31     /** This interface gives access to any text, table, graphic, embedded
  32           object and drawing that is at least partially visible on the screen.
  33         The tree that arises from the children of this object reflects the
  34         structure of the document as it is displayed.
  35
  36         <ul>
  37             <li>The children returned by
  38                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  39                 all support the interface XAccessible. Calling
  40                 ::com::sun::star::accessibility::XAccessible::getAccessibleContext()
  41                 for these children returns an object that supports one of the
  42                 following services.
  43                 <ul>
  44                     <li>::com::sun::star::text::AccessibleHeaderFooterView:
  45                         A child of this kind is returned for every header
  46                         and footer that is at least partially visible.
  47                     <li>::com::sun::star::text::AccessibleFootnoteView:
  48                         A child of this kind is returned for every footnote
  49                         that is at least partially visible.
  50                     <li>::com::sun::star::text::AccessibleEndnoteView:
  51                         A child of this kind is returned for every endnote
  52                         that is at least partially visible.
  53                     <li>::com::sun::star::text::AccessibleParagraphView:
  54                         A child of this kind is returned for every paragraph
  55                         fragment that is contained in the document body and
  56                         is at least partially visible. A paragraph fragment is
  57                         the part of a paragraph that is displayed on a
  58                         certain page.
  59                     <li>::com::sun::star::table::AccessibleTableView:
  60                         A child of this kind is returned for every table
  61                         fragment that is contained in the document body
  62                         and is at least partially visible. A table fragment is
  63                         the part of a table that is displayed on a certain page.
  64                     <li>::com::sun::star::text::AccessibleTextFrameView:
  65                         A child of this
  66                         kind is returned for every text frame that is at
  67                         least partially visible. These objects are children
  68                         of the
  69                         AccessibleTextDocumentView regardless
  70                         whether they are bound to a page, a paragraph, a
  71                         frame, or a character. The only exception are text
  72                         frames that are bound as character. They are children
  73                         of the paragraph they are contained in.
  74                     <li>::com::sun::star::text::AccessibleTextGraphicObject:
  75                         A child of this kind is returned for every graphic that
  76                         is at least partially visible. These objects are
  77                         children of the AccessibleTextDocumentView
  78                         regardless whether they are bound to a page, paragraph,
  79                         a frame or a character. The only exception
  80                         are text frames that are bound as character. They are
  81                         children of the paragraph they are contained in.
  82                     <li>::com::sun::star::text::AccessibleTextEmbeddedObject:
  83                         A child of this kind is returned for every embedded
  84                         object that is at least partially visible.
  85                         These objects are children of the
  86                         AccessibleTextDocumentView regardless
  87                         whether they are bound to a page, a paragraph, a frame,
  88                         or a character.  They are children of the paragraph they
  89                         are contained in.
  90                     <li>::com::sun::star::drawing::AccessibleShape:
  91                         A child of this kind (or a
  92                         derived interface) is returned for every shape that
  93                         is at least partially visible. These objects are
  94                         children of the
  95                         AccessibleTextDocumentView regardless
  96                         whether they are bound to a page, a paragraph, a
  97                         frame or a character.
  98                 </ul>
  99                 <p>The following rules apply to the children order:
 100                 <ul>
 101                     <li>The logical order of paragraph and table fragments is
 102                         never changed.
 103                     <li>Headers appear immediately before the first paragraph or
 104                         table fragment of the header's page.
 105                     <li>Footnotes appear immediately after the last paragraph or
 106                         table fragment of the footnote's page. The logical order
 107                         of footnotes isn't changed.
 108                     <li>Endnotes appear immediately after the last footnote of
 109                         the endnote's page or after the last paragraph or
 110                         table fragment of this page if there are no footnotes.
 111                         The logical order of endnotes isn't changed.
 112                     <li>Footers appear immediately after the last endnote,
 113                         footnote, paragraph or table fragment of the footer's
 114                         page.
 115                     <li>Text frames, graphics, embedded objects and shapes that
 116                         are painted in the background appear before any other
 117                         children. Their order reflects the z order.
 118                     <li>Text frames, graphics, embedded objects and shapes
 119                         that are painted in the foreground appear behind any
 120                            other children. Their order reflects the z order,
 121                         with the exception of controls that appear really last,
 122                         but also keep the z order.
 123                 </ul>
 124             <li>The role is
 125                 ::com::sun::star::accessibility::AccessibleRole::DOCUMENT_TEXT.
 126             <li>The name is "document view" (or the equivalent term
 127                 in application's language).
 128             <li>The description also is "document view" (or the equivalent term
 129                 in application's language).
 130             <li>There are no relation sets.
 131             <li>The following states might be contained in the state set
 132                 returned by
 133                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet():
 134                 <ul>
 135                     <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
 136                         (indicates that the document window has been closed)
 137                     <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
 138                     <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
 139                         (always contained)
 140                     <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
 141                         (always contained)
 142                     <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
 143                         (always contained)
 144                     <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
 145                     <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
 146                 </ul>
 147             <li>Depending of the application's region setting, the locale is
 148                 the western, Asian or complex default language of the document.
 149         </ul>
 150
 151     */
 152     interface ::com::sun::star::accessibility::XAccessibleContext;
 153
 154     /** This interface describes the graphical representation of a text
 155           document view.
 156     */
 157     interface ::com::sun::star::accessibility::XAccessibleComponent;
 158
 159     /** This interface is for selecting the document's children. Selectable
 160           are any children with the exception of headers, footers, footnotes
 161         and endnotes, where only the grandchildren might be selectable.
 162     */
 163     interface ::com::sun::star::accessibility::XAccessibleSelection;
 164
 165     /** This is the interface for listeners
 166     */
 167     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 168 };
 169
 170
 171 }; }; }; };
 172
 173 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */