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