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