offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sheet_AccessibleSpreadsheetPageView_idl__
  28 #define __com_sun_star_sheet_AccessibleSpreadsheetPageView_idl__
  29
  30 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  31 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  35 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  39 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** The accessible view of a spreadsheet page preview
  49
  50      @since OOo 1.1.2
  51
  52  */
  53 published service AccessibleSpreadsheetPageView
  54 {
  55     /** This interface gives access to any object that is at least partially
  56         visible on the screen in the page preview.
  57
  58     <ul>
  59         <li>The parent returned by
  60             <method scope="::com::sun::star::accessibility"
  61             >XAccessibleContext::getAccessibleParent</method>
  62             is the window wich contains the view of these page preview.</li>
  63         <li>The children returned by
  64             <method scope="::com::sun::star::accessibility"
  65             >XAccessibleContext::getAccessibleChild</method> all
  66             support the interface XAccessible. Calling
  67             <method scope="::com::sun::star::accessibility"
  68             >XAccessibleContext::getAccessibleContext</method> for these children returns
  69             an object that supports one of the following services.</li>
  70         <ul>
  71             <li><type scope="::com::sun::star::sheet"
  72                 >AccessiblePageHeaderFooterAreasView</type>: A child where calling
  73                 <method scope="::com::sun::star::accessibility"
  74                 >XAccessibleContext::getAccessibleChild</method>
  75                 an object that supports this service is returned for
  76                 every header and footer that is at least partially visible.</li>
  77             <li><type scope="::com::sun::star::table">AccessibleTableView</type>:
  78                 A child where calling
  79                 <method scope="::com::sun::star::accessibility"
  80                 >XAccessibleChild::getAccessibleChild</method>
  81                 an object that supports this service is returned for
  82                 every table fragment that is contained in the document body
  83                 and is at least partially visible. A table fragment is the
  84                 part of a table that is displayed on a certain page.</li>
  85             <li><type scope="::com::sun::star::drawing">AccessibleShape</type>:
  86                 A child where calling
  87                 <method scope="::com::sun::star::accessibility"
  88                 >XAccessibleContext::getAccessibleChild</method>
  89                 an object that supports this service is returned
  90                 for every shape that is at least partially visible. These
  91                 objects are children of the
  92                 <type>AccessibleSpreadsheetPageView</type> regardless
  93                 whether they are bound to a table or a cell.</li>
  94             <li><type scope="::com::sun::star::text">AccessibleParagraphView</type>:
  95                 A child where calling
  96                 <method scope="::com::sun::star::accessibility"
  97                 >XAccessibleContext::getAccessibleChild</method>
  98                 an object that supports this service is returned for
  99                 every note (its paragraphs) and its location (which is
 100                 represented as a paragraph with the cell name as content).</li>
 101         </ul>
 102         <p>The following rules apply to the children order. General it
 103             represents the paint order. The object in the background came
 104             first and than all over lying objects. The last painted object
 105             is also the last child.</p>
 106         <ul>
 107             <li>The logical order of paragraph and table fragments is never
 108                 changed.</li>
 109             <li>Headers appear immediately before the first table fragment
 110                 of the header's page.</li>
 111             <li>Footers appear immediately after the last table fragment.</li>
 112             <li>Shapes appear before any other children if they are painted
 113                 in the background.  Their order reflects the z order.</li>
 114             <li>Shapes appear behind any other children except controls if
 115                 they are painted in the foreground. Their order reflects the
 116                 z order.</li>
 117             <li>Controls appear behind any other objects. Their order
 118                 reflects the z order.</li>
 119         </ul>
 120         <li>The description is ???.</li>
 121         <li>The name is Spreadsheet Document Page Preview.</li>
 122         <li>The role is <const scope="::com::sun::star::accessibility"
 123             >AccessibleRole::DOCUMENT</const></li>
 124         <li>There are no relations.</li>
 125         <li>The following states are supported:
 126             <ul>
 127                 <li><const scope="::com::sun::star::accessibility"
 128                     >AccessibleStateType::DEFUNC</const> is always false until
 129                     the preview is closed.</li>
 130                 <li><const scope="::com::sun::star::accessibility"
 131                     >AccessibleStateType::EDITABLE</const> is always false,
 132                     because the document is not editable in the page preview.
 133                     So it is left out of the list.</li>
 134                 <li><const scope="::com::sun::star::accessibility"
 135                     >AccessibleStateType::ENABLED</const> is always true.</li>
 136                 <li><const scope="::com::sun::star::accessibility"
 137                     >AccessibleStateType::MULTILINE</const> makes no sense on a
 138                     document and so it is left out of the list.</li>
 139                 <li><const scope="::com::sun::star::accessibility"
 140                     >AccessibleStateType::MULTI_SELECTABLE</const> is always
 141                     false, because in a page preview a selection is not
 142                     possible. So it is left out of the list.</li>
 143                 <li><const scope="::com::sun::star::accessibility"
 144                     >AccessibleStateType::OPAQUE</const> is always true.</li>
 145                 <li><const scope="::com::sun::star::accessibility"
 146                     >AccessibleStateType::RESIZEABLE</const> is always false,
 147                     because you can resize the window of the page preview, but
 148                     not the page preview itself. So it is left out of the
 149                     list.</li>
 150                 <li><const scope="::com::sun::star::accessibility"
 151                     >AccessibleStateType::SELECTABLE</const> is always false,
 152                     because in the page preview is no selection possible. So
 153                     it is left out of the list.</li>
 154                 <li><const scope="::com::sun::star::accessibility"
 155                     >AccessibleStateType::SELECTED</const> is always false,
 156                     because in the page preview is no selection possible. So
 157                     it is left out of the list.</li>
 158                 <li><const scope="::com::sun::star::accessibility"
 159                     >AccessibleStateType::SHOWING</const>Is true if the
 160                     Bounding Box lies in the Bounding Box of the parent.
 161                     Otherwise it is false.</li>
 162                 <li><const scope="::com::sun::star::accessibility"
 163                     >AccessibleStateType::VISIBLE</const>Is always true.</li>
 164             </ul>
 165         </li>
 166     </ul>
 167
 168      */
 169     interface ::com::sun::star::accessibility::XAccessibleContext;
 170
 171     /** This interface gives access to the visibility of the document.
 172     */
 173     interface ::com::sun::star::accessibility::XAccessibleComponent;
 174
 175     /** This is the interface for listeners */
 176     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 177 };
 178
 179 //=============================================================================
 180
 181 }; }; }; };
 182
 183 #endif