offapi/com/sun/star/sheet/AccessibleCell.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: AccessibleCell.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_AccessibleCell_idl__
  31 #define __com_sun_star_sheet_AccessibleCell_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_XAccessibleValue_idl__
  42 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_accessibility_XAccessibleText_idl__
  46 #include <com/sun/star/accessibility/XAccessibleText.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** The accessible view of a spreadsheet document
  57
  58      @since OOo 1.1.2
  59
  60  */
  61 published service AccessibleCell
  62 {
  63     /** This interface gives access to the whole content of the cell.
  64
  65     <ul>
  66         <li>The parent returned by
  67             <method scope="::com::sun::star::accessibility"
  68             >XAccessibleContext::getAccessibleParent</method>
  69             is the accessible spreadsheet.</li>
  70         <li>This object has no children.</li>
  71         <li>The description is ???.</li>
  72         <li>The name is something like A10 or B23 or so on.</li>
  73         <li>The role is <const scope="::com::sun::star::accessibility"
  74             >AccessibleRole::TABLE_CELL</const></li>
  75         <li>There are relations between the cell and the shapes with an anchor
  76             on this cell.</li>
  77         <li>The following states are supported:
  78             <ul>
  79                 <li><const scope="::com::sun::star::accessibility"
  80                     >AccessibleStateType::DEFUNC</const> is always false if the
  81                     parent table is showed, otherwise it is true.</li>
  82                 <li><const scope="::com::sun::star::accessibility"
  83                     >AccessibleStateType::EDITABLE</const> is false if the cell
  84                     or the table is protected, otherwise it is true.</li>
  85                 <li><const scope="::com::sun::star::accessibility"
  86                     >AccessibleStateType::ENABLED</const> is always true.</li>
  87                 <li><const scope="::com::sun::star::accessibility"
  88                     >AccessibleStateType::MULTILINE</const> is always true.</li>
  89                 <li><const scope="::com::sun::star::accessibility"
  90                     >AccessibleStateType::MULTISELECTABLE</const> is always
  91                     true.</li>
  92                 <li><const scope="::com::sun::star::accessibility"
  93                     >AccessibleStateType::OPAQUE</const> is false if the cell
  94                     has no background color or graphic, otherwise it is
  95                     true.</li>
  96                 <li><const scope="::com::sun::star::accessibility"
  97                     >AccessibleStateType::RESIZEABLE</const> is false if the
  98                     table is protected, otherwise is it true.</li>
  99                 <li><const scope="::com::sun::star::accessibility"
 100                     >AccessibleStateType::SELECTABLE</const> is always
 101                     true.</li>
 102                 <li><const scope="::com::sun::star::accessibility"
 103                     >AccessibleStateType::SELECTED</const> is true, if the
 104                     cell is selected.</li>
 105                 <li><const scope="::com::sun::star::accessibility"
 106                     >AccessibleStateType::TRANSIENT</const> is always true.</li>
 107                 <li><const scope="::com::sun::star::accessibility"
 108                     >AccessibleStateType::SHOWING</const>Is true if the
 109                     Bounding Box lies in Bounding Box of the parent. Otherwise
 110                     it is false.</li>
 111                 <li><const scope="::com::sun::star::accessibility"
 112                     >AccessibleStateType::VISIBLE</const>Is false if the
 113                     column/row with this cell is filtered or hidden.
 114                     Otherwise is true.</li>
 115             </ul>
 116         </li>
 117     </ul>
 118      */
 119     interface ::com::sun::star::accessibility::XAccessibleContext;
 120
 121     /** This interface gives access to the visibility of the cell.
 122     */
 123     interface ::com::sun::star::accessibility::XAccessibleComponent;
 124
 125     /** This interface gives access to the value of the cell.
 126      */
 127     interface ::com::sun::star::accessibility::XAccessibleValue;
 128
 129     /** This interface gives access to the text representation of the cell content.
 130      */
 131     interface ::com::sun::star::accessibility::XAccessibleText;
 132 };
 133
 134 //=============================================================================
 135
 136 }; }; }; };
 137
 138 #endif