offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.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_sheet_AccessibleSpreadsheetPageView_idl__
  20 #define __com_sun_star_sheet_AccessibleSpreadsheetPageView_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 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** The accessible view of a spreadsheet page preview
  31
  32      @since OOo 1.1.2
  33
  34  */
  35 service AccessibleSpreadsheetPageView
  36 {
  37     /** This interface gives access to any object that is at least partially
  38         visible on the screen in the page preview.
  39
  40     <ul>
  41         <li>The parent returned by
  42             ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  43             is the window which contains the view of these page preview.</li>
  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
  49             an object that supports one of the following services.</li>
  50         <ul>
  51             <li>::com::sun::star::sheet::AccessiblePageHeaderFooterAreasView:
  52                 A child where calling
  53                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  54                 an object that supports this service is returned for
  55                 every header and footer that is at least partially visible.</li>
  56             <li>::com::sun::star::table::AccessibleTableView:
  57                 A child where calling
  58                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  59                 an object that supports this service is returned for
  60                 every table fragment that is contained in the document body
  61                 and is at least partially visible. A table fragment is the
  62                 part of a table that is displayed on a certain page.</li>
  63             <li>::com::sun::star::drawing::AccessibleShape:
  64                 A child where calling
  65                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  66                 an object that supports this service is returned
  67                 for every shape that is at least partially visible. These
  68                 objects are children of the
  69                 AccessibleSpreadsheetPageView regardless
  70                 whether they are bound to a table or a cell.</li>
  71             <li>::com::sun::star::text::AccessibleParagraphView:
  72                 A child where calling
  73                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  74                 an object that supports this service is returned for
  75                 every note (its paragraphs) and its location (which is
  76                 represented as a paragraph with the cell name as content).</li>
  77         </ul>
  78         <p>The following rules apply to the children order. General it
  79             represents the paint order. The object in the background came
  80             first and than all over lying objects. The last painted object
  81             is also the last child.</p>
  82         <ul>
  83             <li>The logical order of paragraph and table fragments is never
  84                 changed.</li>
  85             <li>Headers appear immediately before the first table fragment
  86                 of the header's page.</li>
  87             <li>Footers appear immediately after the last table fragment.</li>
  88             <li>Shapes appear before any other children if they are painted
  89                 in the background.  Their order reflects the z order.</li>
  90             <li>Shapes appear behind any other children except controls if
  91                 they are painted in the foreground. Their order reflects the
  92                 z order.</li>
  93             <li>Controls appear behind any other objects. Their order
  94                 reflects the z order.</li>
  95         </ul>
  96         <li>The description is ???.</li>
  97         <li>The name is Spreadsheet Document Page Preview.</li>
  98         <li>The role is
  99             ::com::sun::star::accessibility::AccessibleRole::DOCUMENT_SPREADSHEET</li>
 100         <li>There are no relations.</li>
 101         <li>The following states are supported:
 102             <ul>
 103                 <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
 104                     is always false until the preview is closed.</li>
 105                 <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
 106                     is always false,
 107                     because the document is not editable in the page preview.
 108                     So it is left out of the list.</li>
 109                 <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
 110                     is always true.</li>
 111                 <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
 112                     makes no sense on a
 113                     document and so it is left out of the list.</li>
 114                 <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
 115                     is always false, because in a page preview a selection is
 116                     not possible. So it is left out of the list.</li>
 117                 <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
 118                     is always true.</li>
 119                 <li>::com::sun::star::accessibility::AccessibleStateType::RESIZABLE
 120                     is always false,
 121                     because you can resize the window of the page preview, but
 122                     not the page preview itself. So it is left out of the
 123                     list.</li>
 124                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE
 125                     is always false,
 126                     because in the page preview is no selection possible. So
 127                     it is left out of the list.</li>
 128                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED
 129                     is always false,
 130                     because in the page preview is no selection possible. So
 131                     it is left out of the list.</li>
 132                 <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
 133                     is true if the
 134                     Bounding Box lies in the Bounding Box of the parent.
 135                     Otherwise it is false.</li>
 136                 <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
 137                     is always true.</li>
 138             </ul>
 139         </li>
 140     </ul>
 141
 142      */
 143     interface ::com::sun::star::accessibility::XAccessibleContext;
 144
 145     /** This interface gives access to the visibility of the document.
 146     */
 147     interface ::com::sun::star::accessibility::XAccessibleComponent;
 148
 149     /** This is the interface for listeners */
 150     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 151 };
 152
 153
 154 }; }; }; };
 155
 156 #endif
 157
 158 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */