offapi/com/sun/star/sheet/AccessibleCell.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 sheet {
  23
  24
  25 /** The accessible view of a spreadsheet document
  26
  27      @since OOo 1.1.2
  28
  29  */
  30 service AccessibleCell
  31 {
  32     /** This interface gives access to the whole content of the cell.
  33
  34     <ul>
  35         <li>The parent returned by
  36             ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  37             is the accessible spreadsheet.</li>
  38         <li>This object has no children.</li>
  39         <li>The description is ???.</li>
  40         <li>The name is something like A10 or B23 or so on.</li>
  41         <li>The role is
  42             ::com::sun::star::accessibility::AccessibleRole::TABLE_CELL</li>
  43         <li>There are relations between the cell and the shapes with an anchor
  44             on this cell.</li>
  45         <li>The following states are supported:
  46             <ul>
  47                 <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  48                     is always false if the
  49                     parent table is showed, otherwise it is true.</li>
  50                 <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  51                     is false if the cell
  52                     or the table is protected, otherwise it is true.</li>
  53                 <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  54                     is always true.</li>
  55                 <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE
  56                     is always true.</li>
  57                 <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
  58                     is always true.</li>
  59                 <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  60                     is false if the cell
  61                     has no background color or graphic, otherwise it is
  62                     true.</li>
  63                 <li>::com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  64                     is false if the
  65                     table is protected, otherwise is it true.</li>
  66                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  67                     is always true.</li>
  68                 <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED
  69                     is true, if the cell is selected.</li>
  70                 <li>::com::sun::star::accessibility::AccessibleStateType::TRANSIENT
  71                     is always true.</li>
  72                 <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
  73                     is true if the
  74                     Bounding Box lies in Bounding Box of the parent. Otherwise
  75                     it is false.</li>
  76                 <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
  77                     is false if the
  78                     column/row with this cell is filtered or hidden.
  79                     Otherwise is true.</li>
  80             </ul>
  81         </li>
  82     </ul>
  83      */
  84     interface ::com::sun::star::accessibility::XAccessibleContext;
  85
  86     /** This interface gives access to the visibility of the cell.
  87     */
  88     interface ::com::sun::star::accessibility::XAccessibleComponent;
  89
  90     /** This interface gives access to the value of the cell.
  91      */
  92     interface ::com::sun::star::accessibility::XAccessibleValue;
  93
  94     /** This interface gives access to the text representation of the cell content.
  95      */
  96     interface ::com::sun::star::accessibility::XAccessibleText;
  97 };
  98
  99
 100 }; }; }; };
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */