offapi/com/sun/star/sheet/AccessibleSpreadsheet.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: AccessibleSpreadsheet.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_AccessibleSpreadsheet_idl__
  31 #define __com_sun_star_sheet_AccessibleSpreadsheet_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 module com {  module sun {  module star {  module sheet {
  56
  57 //=============================================================================
  58
  59 /** The accessible view of a spreadsheet document
  60
  61      @since OOo 1.1.2
  62 */
  63 published service AccessibleSpreadsheet
  64 {
  65     /** This interface gives access to any object in the currently visible table
  66         on the desktop.
  67
  68     <ul>
  69         <li>The parent returned by <method scope="::com::sun::star::accessibility"
  70             >XAccessibleContext::getAccessibleParent</method>
  71             is the accessible spreadsheet document view.</li>
  72         <li>The children returned by <method scope="::com::sun::star::accessibility"
  73             >XAccessibleContext::getAccessibleChild</method> all
  74             support the interface XAccessible. Calling
  75             <method scope="::com::sun::star::accessibility"
  76             >XAccessible::getAccessibleContext</method> for these children
  77             returns an object that supports the following service.</li>
  78         <ul>
  79             <li><type scope="::com::sun::star::sheet">AccessibleCell</type>:
  80                 A child where calling
  81                 <method scope="::com::sun::star::accessibility"
  82                 >XAccessibleContext::getAccessibleChild</method>
  83                 an object that supports this service is returned for
  84                 every cell in this table.</li>
  85         </ul>
  86         <p>The following rules apply to the children order.</p>
  87         <ul>
  88             <li>All the children are cells. The order of this cells is to
  89             the order on the screen. This means that the first cell is the
  90             cell in the left top edge of the table and the last one is the
  91             cell in the right bottom edge of the table. The second is the
  92             cell in the first row and second xolumn and so on.</li>
  93         </ul>
  94         <li>The description is ???.</li>
  95         <li>The name is the given table name.</li>
  96         <li>The role is <const scope="::com::sun::star::accessibility"
  97             >AccessibleRole::TABLE</const></li>
  98         <li>There are relations between the table and the shapes with an anchor
  99             on this table (not with an anchor on a cell in this table).</li>
 100         <li>The following states are supported:
 101             <ul>
 102                 <li><const scope="::com::sun::star::accessibility"
 103                     >AccessibleStateType::DEFUNC</const> is always false if the
 104                     table is not deleted and the document is open, otherwise it
 105                     is true.</li>
 106                 <li><const scope="::com::sun::star::accessibility"
 107                     >AccessibleStateType::EDITABLE</const> is false if the
 108                     table is protected, otherwise it is true.</li>
 109                 <li><const scope="::com::sun::star::accessibility"
 110                     >AccessibleStateType::ENABLED</const> is always true.</li>
 111                 <li><const scope="::com::sun::star::accessibility"
 112                     >AccessibleStateType::MULTI_SELECTABLE</const> is always
 113                     true.</li>
 114                 <li><const scope="::com::sun::star::accessibility"
 115                     >AccessibleStateType::OPAQUE</const> is always true.</li>
 116                 <li><const scope="::com::sun::star::accessibility"
 117                     >AccessibleStateType::RESIZEABLE</const>is always
 118                     false.</li>
 119                 <li><const scope="::com::sun::star::accessibility"
 120                     >AccessibleStateType::SELECTABLE</const> is always
 121                     true.</li>
 122                 <li><const scope="::com::sun::star::accessibility"
 123                     >AccessibleStateType::SELECTED</const> is true if the
 124                     complete table (all cells) is selected.</li>
 125                 <li><const scope="::com::sun::star::accessibility"
 126                     >AccessibleStateType::SHOWING</const>Is true if the
 127                     Bounding Box lies in the Bounding Box of the parent.
 128                     Otherwise it is false.</li>
 129                 <li><const scope="::com::sun::star::accessibility"
 130                     >AccessibleStateType::VISIBLE</const>Is always true.</li>
 131             </ul>
 132         </li>
 133     </ul>
 134      */
 135     interface ::com::sun::star::accessibility::XAccessibleContext;
 136
 137     /** This interface gives access to the visibility of the table.
 138     */
 139     interface ::com::sun::star::accessibility::XAccessibleComponent;
 140
 141     /** This interface gives access to any cell that is at least partially
 142         visible on the screen. So this interface gives access to the same
 143         things like the XAccessibleContext interface. Therefor it use more
 144         usable methods. Also it gives access to some table specific data.
 145      */
 146     interface ::com::sun::star::accessibility::XAccessibleTable;
 147
 148     /** This interface is for selecting the cells.
 149      */
 150     interface ::com::sun::star::accessibility::XAccessibleSelection;
 151
 152     /** This is the interface for listeners */
 153     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 154 };
 155
 156 //=============================================================================
 157
 158 }; }; }; };
 159
 160 #endif