offapi/com/sun/star/table/AccessibleCellView.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: AccessibleCellView.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_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 #ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__
  50 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  54 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  55 #endif
  56
  57
  58 //=============================================================================
  59
  60 module com {  module sun {  module star {  module table {
  61
  62 //=============================================================================
  63
  64 /** The accessible view of a cell in a text document or in the page preview
  65       of a spreadsheet document. See
  66     <type scope="::com::sun::star::sheet">AccessibleCell</type> for cells in
  67     the edit view of a spreadsheet.
  68     @since OOo 1.1.2
  69 */
  70 published service AccessibleCellView
  71 {
  72     /** This interface gives access to the visible content of a cell in a
  73         accessible spreadsheet page preview or accessible text document view.
  74     <ul>
  75         <li>The parent returned by <method scope="::com::sun::star::accessibility"
  76             >XAccessibleContext::getAccessibleParent</method>
  77             is the accessible table view.</li>
  78         <li>The children returned by
  79             <method scope="::com::sun::star::accessibility"
  80             >XAccessibleContext::getAccessibleChild</method> all
  81             support the interface XAccessible. Calling
  82             <method scope="::com::sun::star::accessibility"
  83             >XAccessibleContext::getAccessibleContext</method> for these
  84             children returns an object that supports the service
  85             <type scope="::com::sun::star::text"
  86             >AccessibleParagraphView</type>:
  87             A child of this kind is returned for every paragraph
  88             fragment that is contained in the cell and
  89             is at least partially visible. A paragraph fragment is
  90             the part of a paragraph that is displayed on a
  91             certain page.
  92         <li>The name is something like A10 or B23 or so on.</li>
  93         <li>The description is the name or the content of the given note.</li>
  94         <li>The role is <const scope="::com::sun::star::accessibility"
  95             >AccessibleRole::TABLE_CELL</const></li>
  96         <li>For spreadsheets, there are relations between the cell and the
  97             shapes with an anchor on this cell.</li>
  98         <li>The following states are supported:
  99             <ul>
 100                 <li><const scope="::com::sun::star::accessibility"
 101                     >AccessibleStateType::DEFUNC</const> is always false if the
 102                     cell is showed, otherwise it is true.</li>
 103                 <li><const scope="::com::sun::star::accessibility"
 104                     >AccessibleStateType::EDITABLE</const> is false if the cell
 105                     is showed in a page preview or the cell or the table is
 106                     protected, otherwise it is true.</li>
 107                 <li><const scope="::com::sun::star::accessibility"
 108                     >AccessibleStateType::ENABLED</const> is always true.</li>
 109                 <li><const scope="::com::sun::star::accessibility"
 110                     >AccessibleStateType::MULTI_LINE</const> is always true in
 111                     spreadsheets and false otherwise.</li>
 112                 <li><const scope="::com::sun::star::accessibility"
 113                     >AccessibleStateType::OPAQUE</const> is false if the cell
 114                     has no background color or graphic, otherwise it is true.</li>
 115                 <li><const scope="::com::sun::star::accessibility"
 116                     >AccessibleStateType::SELECTABLE</const> is true if the
 117                     cell is not showed in a page preview, otherwise is it
 118                     false.</li>
 119                 <li><const scope="::com::sun::star::accessibility"
 120                     >AccessibleStateType::SELECTED</const> is true, if the cell
 121                     is selected. This is not possible in the page preview.</li>
 122                 <li><const scope="::com::sun::star::accessibility"
 123                     >AccessibleStateType::SHOWING</const>Is true if the
 124                     Bounding Box lies in the Bounding Box of the parent.
 125                     Otherwise it is false.</li>
 126                 <li><const scope="::com::sun::star::accessibility"
 127                     >AccessibleStateType::TRANSIENT</const>Is true if the cell
 128                     is showed in a spreadsheet page preview. Otherwise it is
 129                     false.</li>
 130                 <li><const scope="::com::sun::star::accessibility"
 131                     >AccessibleStateType::VISIBLE</const>Is always true.</li>
 132             </ul>
 133         </li>
 134     </ul>
 135      */
 136     interface ::com::sun::star::accessibility::XAccessibleContext;
 137
 138     /** This interface gives access to the visibility of the cell.
 139     */
 140     interface ::com::sun::star::accessibility::XAccessibleComponent;
 141
 142     /** This interface gives access to the value of the cell.
 143         Only a readonly access is possible.
 144      */
 145     interface ::com::sun::star::accessibility::XAccessibleValue;
 146
 147     /** This interface is for selecting the text, value or parts of this in the
 148         cell. This interface is optional.
 149      */
 150     [optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
 151
 152     /** This is the interface for listeners */
 153     [optional] interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 154 };
 155
 156 //=============================================================================
 157
 158 }; }; }; };
 159
 160 #endif