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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_table_AccessibleCellView_idl__
  20 #define __com_sun_star_table_AccessibleCellView_idl__
  21
  22 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  23 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  24 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  25 #include <com/sun/star/accessibility/XAccessibleText.idl>
  26 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  27 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  28
  29
  30
  31 module com {  module sun {  module star {  module table {
  32
  33
  34 /** The accessible view of a cell in a text document or in the page preview
  35       of a spreadsheet document. See
  36     ::com::sun::star::sheet::AccessibleCell for cells in
  37     the edit view of a spreadsheet.
  38     @since OOo 1.1.2
  39 */
  40 service AccessibleCellView
  41 {
  42     /** This interface gives access to the visible content of a cell in a
  43         accessible spreadsheet page preview or accessible text document view.
  44     <ul>
  45         <li>The parent returned by
  46             ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  47             is the accessible table view.</li>
  48         <li>The children returned by
  49             ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  50             all support the interface XAccessible. Calling
  51             ::com::sun::star::accessibility::XAccessible::getAccessibleContext()
  52             for these children returns an object that supports the service
  53             ::com::sun::star::text::AccessibleParagraphView:
  54             A child of this kind is returned for every paragraph
  55             fragment that is contained in the cell and
  56             is at least partially visible. A paragraph fragment is
  57             the part of a paragraph that is displayed on a
  58             certain page.
  59         <li>The name is something like A10 or B23 or so on.</li>
  60         <li>The description is the name or the content of the given note.</li>
  61         <li>The role is
  62             ::com::sun::star::accessibility::AccessibleRole::TABLE_CELL</li>
  63         <li>For spreadsheets, there are relations between the cell and the
  64             shapes with an anchor on this cell.</li>
  65         <li>The following states are supported:
  66             <ul>
  67                 <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  68                     is always false if the
  69                     cell is shown, otherwise it is true.</li>
  70                 <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  71                     is false if the cell
  72                     is showed in a page preview or the cell or the table is
  73                     protected, otherwise it is true.</li>
  74                 <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  75                     is always true.</li>
  76                 <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
  77                     is always true in spreadsheets and false otherwise.</li>
  78                 <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  79                     is false if the cell
  80                     has no background color or graphic, otherwise it is true.</li>
  81                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  82                     is true if the
  83                     cell is not showed in a page preview, otherwise is it
  84                     false.</li>
  85                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED
  86                     is true, if the cell
  87                     is selected. This is not possible in the page preview.</li>
  88                 <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
  89                     is true if the
  90                     Bounding Box lies in the Bounding Box of the parent.
  91                     Otherwise it is false.</li>
  92                 <li>::com::sun::star::accessibility::AccessibleStateType::TRANSIENT
  93                     is true if the cell
  94                     is showed in a spreadsheet page preview. Otherwise it is
  95                     false.</li>
  96                 <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
  97                     is always true.</li>
  98             </ul>
  99         </li>
 100     </ul>
 101      */
 102     interface ::com::sun::star::accessibility::XAccessibleContext;
 103
 104     /** This interface gives access to the visibility of the cell.
 105     */
 106     interface ::com::sun::star::accessibility::XAccessibleComponent;
 107
 108     /** This interface gives access to the value of the cell.
 109         Only a readonly access is possible.
 110      */
 111     interface ::com::sun::star::accessibility::XAccessibleValue;
 112
 113     /** This interface is for selecting the text, value or parts of this in the
 114         cell. This interface is optional.
 115      */
 116     [optional] interface ::com::sun::star::accessibility::XAccessibleSelection;
 117
 118     /** This is the interface for listeners */
 119     [optional] interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 120 };
 121
 122
 123 }; }; }; };
 124
 125 #endif
 126
 127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */