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