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