offapi/com/sun/star/table/AccessibleCellView.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_idl__
  28 #define __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_idl__
  29
  30 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  31 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  35 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_accessibility_XAccessibleValue_idl__
  39 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_accessibility_XAccessibleText_idl__
  43 #include <com/sun/star/accessibility/XAccessibleText.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__
  47 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  51 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  52 #endif
  53
  54
  55 //=============================================================================
  56
  57 module com {  module sun {  module star {  module table {
  58
  59 //=============================================================================
  60
  61 /** The accessible view of a cell in a text document or in the page preview
  62       of a spreadsheet document. See
  63     <type scope="::com::sun::star::sheet">AccessibleCell</type> for cells in
  64     the edit view of a spreadsheet.
  65     @since OOo 1.1.2
  66 */
  67 published service AccessibleCellView
  68 {
  69     /** This interface gives access to the visible content of a cell in a
  70         accessible spreadsheet page preview or accessible text document view.
  71     <ul>
  72         <li>The parent returned by <method scope="::com::sun::star::accessibility"
  73             >XAccessibleContext::getAccessibleParent</method>
  74             is the accessible table view.</li>
  75         <li>The children returned by
  76             <method scope="::com::sun::star::accessibility"
  77             >XAccessibleContext::getAccessibleChild</method> all
  78             support the interface XAccessible. Calling
  79             <method scope="::com::sun::star::accessibility"
  80             >XAccessibleContext::getAccessibleContext</method> for these
  81             children returns an object that supports the service
  82             <type scope="::com::sun::star::text"
  83             >AccessibleParagraphView</type>:
  84             A child of this kind is returned for every paragraph
  85             fragment that is contained in the cell and
  86             is at least partially visible. A paragraph fragment is
  87             the part of a paragraph that is displayed on a
  88             certain page.
  89         <li>The name is something like A10 or B23 or so on.</li>
  90         <li>The description is the name or the content of the given note.</li>
  91         <li>The role is <const scope="::com::sun::star::accessibility"
  92             >AccessibleRole::TABLE_CELL</const></li>
  93         <li>For spreadsheets, there are relations between the cell and the
  94             shapes with an anchor on this cell.</li>
  95         <li>The following states are supported:
  96             <ul>
  97                 <li><const scope="::com::sun::star::accessibility"
  98                     >AccessibleStateType::DEFUNC</const> is always false if the
  99                     cell is showed, otherwise it is true.</li>
 100                 <li><const scope="::com::sun::star::accessibility"
 101                     >AccessibleStateType::EDITABLE</const> is false if the cell
 102                     is showed in a page preview or the cell or the table is
 103                     protected, otherwise it is true.</li>
 104                 <li><const scope="::com::sun::star::accessibility"
 105                     >AccessibleStateType::ENABLED</const> is always true.</li>
 106                 <li><const scope="::com::sun::star::accessibility"
 107                     >AccessibleStateType::MULTI_LINE</const> is always true in
 108                     spreadsheets and false otherwise.</li>
 109                 <li><const scope="::com::sun::star::accessibility"
 110                     >AccessibleStateType::OPAQUE</const> is false if the cell
 111                     has no background color or graphic, otherwise it is true.</li>
 112                 <li><const scope="::com::sun::star::accessibility"
 113                     >AccessibleStateType::SELECTABLE</const> is true if the
 114                     cell is not showed in a page preview, otherwise is it
 115                     false.</li>
 116                 <li><const scope="::com::sun::star::accessibility"
 117                     >AccessibleStateType::SELECTED</const> is true, if the cell
 118                     is selected. This is not possible in the page preview.</li>
 119                 <li><const scope="::com::sun::star::accessibility"
 120                     >AccessibleStateType::SHOWING</const>Is true if the
 121                     Bounding Box lies in the Bounding Box of the parent.
 122                     Otherwise it is false.</li>
 123                 <li><const scope="::com::sun::star::accessibility"
 124                     >AccessibleStateType::TRANSIENT</const>Is true if the cell
 125                     is showed in a spreadsheet page preview. Otherwise it is
 126                     false.</li>
 127                 <li><const scope="::com::sun::star::accessibility"
 128                     >AccessibleStateType::VISIBLE</const>Is always true.</li>
 129             </ul>
 130         </li>
 131     </ul>
 132      */
 133     interface ::com::sun::star::accessibility::XAccessibleContext;
 134
 135     /** This interface gives access to the visibility of the cell.
 136     */
 137     interface ::com::sun::star::accessibility::XAccessibleComponent;
 138
 139     /** This interface gives access to the value of the cell.
 140         Only a readonly access is possible.
 141      */
 142     interface ::com::sun::star::accessibility::XAccessibleValue;
 143
 144     /** This interface is for selecting the text, value or parts of this in the
 145         cell. This interface is optional.
 146      */
 147     [optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
 148
 149     /** This is the interface for listeners */
 150     [optional] interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 151 };
 152
 153 //=============================================================================
 154
 155 }; }; }; };
 156
 157 #endif