offapi/com/sun/star/sheet/AccessibleSpreadsheet.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
  20
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** The accessible view of a spreadsheet document
  25
  26      @since OOo 1.1.2
  27 */
  28 service AccessibleSpreadsheet
  29 {
  30     /** This interface gives access to any object in the currently visible table
  31         on the desktop.
  32
  33     <ul>
  34         <li>The parent returned by
  35         ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  36             is the accessible spreadsheet document view.</li>
  37         <li>The children returned by
  38             ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  39             all support the interface XAccessible. Calling
  40             ::com::sun::star::accessibility::XAccessible::getAccessibleContext()
  41             for these children
  42             returns an object that supports the following service.</li>
  43         <ul>
  44             <li>::com::sun::star::sheet::AccessibleCell:
  45                 A child where calling
  46                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
  47                 an object that supports this service is returned for
  48                 every cell in this table.</li>
  49         </ul>
  50         <p>The following rules apply to the children order.</p>
  51         <ul>
  52             <li>All the children are cells. The order of this cells is to
  53             the order on the screen. This means that the first cell is the
  54             cell in the left top edge of the table and the last one is the
  55             cell in the right bottom edge of the table. The second is the
  56             cell in the first row and second column and so on.</li>
  57         </ul>
  58         <li>The description is ???.</li>
  59         <li>The name is the given table name.</li>
  60         <li>The role is ::com::sun::star::accessibility::AccessibleRole::TABLE
  61             </li>
  62         <li>There are relations between the table and the shapes with an anchor
  63             on this table (not with an anchor on a cell in this table).</li>
  64         <li>The following states are supported:
  65             <ul>
  66                 <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  67                     is always false if the
  68                     table is not deleted and the document is open, otherwise it
  69                     is true.</li>
  70                 <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  71                     is false if the
  72                     table is protected, otherwise it is true.</li>
  73                 <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  74                     is always true.</li>
  75                 <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
  76                     is always true.</li>
  77                 <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  78                     is always true.</li>
  79                 <li>::com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  80                     is always false.</li>
  81                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  82                     is always true.</li>
  83                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED
  84                     is true if the complete table (all cells) is selected.</li>
  85                 <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
  86                     is true if the
  87                     Bounding Box lies in the Bounding Box of the parent.
  88                     Otherwise it is false.</li>
  89                 <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
  90                     is always true.</li>
  91             </ul>
  92         </li>
  93     </ul>
  94      */
  95     interface ::com::sun::star::accessibility::XAccessibleContext;
  96
  97     /** This interface gives access to the visibility of the table.
  98     */
  99     interface ::com::sun::star::accessibility::XAccessibleComponent;
 100
 101     /** This interface gives access to any cell that is at least partially
 102         visible on the screen. So this interface gives access to the same
 103         things like the XAccessibleContext interface. Therefore it use more
 104         usable methods. Also it gives access to some table specific data.
 105      */
 106     interface ::com::sun::star::accessibility::XAccessibleTable;
 107
 108     /** This interface is for selecting the cells.
 109      */
 110     interface ::com::sun::star::accessibility::XAccessibleSelection;
 111
 112     /** This is the interface for listeners */
 113     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 114 };
 115
 116
 117 }; }; }; };
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */