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

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