offapi/com/sun/star/table/AccessibleTableView.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: AccessibleTableView.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_AccessibleSpreadsheetDocumentView_idl__
  31 #define __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_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_XAccessibleTable_idl__
  42 #include <com/sun/star/accessibility/XAccessibleTable.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__
  46 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  50 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56 module com {  module sun {  module star {  module table {
  57
  58 //=============================================================================
  59
  60 /** The accessible view of a table in a text document or in the page preview
  61       of a spreadsheet document. See
  62     <type scope="::com::sun::star::sheet">AccessibleSpreadsheet</type> for
  63     tables in the edit view of a spreadsheet.
  64     @since OOo 1.1.2
  65 */
  66 published service AccessibleTableView
  67 {
  68     /** This interface gives access to any table cell that is contained in
  69           a table fragment that is at least partially visible. A table fragment
  70         is the part of a table that is displayed at a single page.
  71
  72     <ul>
  73         <li>The parent returned by
  74             <method scope="::com::sun::star::accessibility"
  75             >XAccessibleContext::getAccessibleParent</method>
  76             is the accessible text document view, a page of the accessible
  77             text documenent page preview, or the accessible spreadsheet
  78             page preview.</li>
  79         <li>The children returned by
  80             <method scope="::com::sun::star::accessibility"
  81             >XAccessibleContext::getAccessibleChild</method> all
  82             support the interface XAccessible. Calling
  83             <method scope="::com::sun::star::accessibility"
  84             >XAccessible::getAccessibleContext</method> for these children
  85             returns an object that supports the service.
  86             <type scope="::com::sun::star::table">AccessibleCellView</type>:
  87             A child where calling
  88             <method scope="::com::sun::star::accessibility"
  89             >XAccessibleContext::getAccessibleChild</method>
  90             an object that supports this service is returned for
  91             every partially visible cell in this table.
  92         <p>The following rules apply to the children order.</p>
  93         <ul>
  94             <li>All the children are cells. The order of this cells is to
  95             the order on the screen. This means that the first cell is the
  96             cell in the left top edge of the table and the last one is the
  97             cell in the right bottom edge of the table. The second is the
  98             cell in the first row and second xolumn and so on.</li>
  99         </ul>
 100         <li>The description is ???.</li>
 101         <li>The name is the given table name and a number to make it non-ambiguous.</li>
 102         <li>The role is <const scope="::com::sun::star::accessibility"
 103             >AccessibleRole::TABLE</const></li>
 104         <li>In a spreadsheet page preview there are relations between the
 105             table and the shapes with an anchor
 106             on this table (not with an anchor on a cell in this table).</li>
 107         <li>The following states are supported:
 108             <ul>
 109                 <li><const scope="::com::sun::star::accessibility"
 110                     >AccessibleStateType::DEFUNC</const> is always false if the
 111                     table is not deleted, the document is open. Also it is
 112                     false if the table was showed in a page preview and the
 113                     page preview is allready opend, otherwise it is true.</li>
 114                 <li><const scope="::com::sun::star::accessibility"
 115                     >AccessibleStateType::EDITABLE</const> is false if the
 116                     table is showed in a page preview or the table is
 117                     protected, otherwise it is true.</li>
 118                 <li><const scope="::com::sun::star::accessibility"
 119                     >AccessibleStateType::ENABLED</const> is always true.</li>
 120                 <li><const scope="::com::sun::star::accessibility"
 121                     >AccessibleStateType::MULTI_SELECTABLE</const> is false
 122                     if the table is showed in a page preview, otherwise it is
 123                     true.</li>
 124                 <li><const scope="::com::sun::star::accessibility"
 125                     >AccessibleStateType::OPAQUE</const> is false, if the table
 126                     has no background color or graphic, otherwise it is
 127                     false.</li>
 128                 <li><const scope="::com::sun::star::accessibility"
 129                     >AccessibleStateType::SHOWING</const>Is true if the
 130                     Bounding Box lies in the Bounding Box of the parent.
 131                     Otherwise it is false.</li>
 132                 <li><const scope="::com::sun::star::accessibility"
 133                     >AccessibleStateType::VISIBLE</const>Is always true.</li>
 134             </ul>
 135         </li>
 136     </ul>
 137
 138      */
 139     interface ::com::sun::star::accessibility::XAccessibleContext;
 140
 141     /** This interface gives access to the visibility of the document.
 142     */
 143     interface ::com::sun::star::accessibility::XAccessibleComponent;
 144
 145     /** This interface gives access to any cell that is at least partially
 146         visible on the screen. So this interface gives access to the same
 147         things like the XAccessibleContext interface. Therefor it use more
 148         usable methods. Also it gives access to some table specific data.
 149      */
 150     interface ::com::sun::star::accessibility::XAccessibleTable;
 151
 152     /** This interface is for selecting the cells. This interface is optional.
 153      */
 154     [optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
 155
 156     /** This is the interface for listeners */
 157     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 158 };
 159
 160 //=============================================================================
 161
 162 }; }; }; };
 163
 164 #endif