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