offapi/com/sun/star/sheet/SheetCell.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
  23
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** represents a single addressable cell in a spreadsheet document.
  30  */
  31 published service SheetCell
  32 {
  33
  34     /** provides basic cell handling and contributes common cell
  35         formatting properties.
  36      */
  37     service com::sun::star::table::Cell;
  38
  39
  40     /** provides handling of formatted text cells.
  41      */
  42     service com::sun::star::text::Text;
  43
  44
  45     /** contributes properties for character formatting of Western text.
  46      */
  47     service com::sun::star::style::CharacterProperties;
  48
  49
  50     /** contributes properties for character formatting of Asian text.
  51      */
  52     service com::sun::star::style::CharacterPropertiesAsian;
  53
  54
  55     /** contributes properties for character formatting of Complex text.
  56      */
  57     service com::sun::star::style::CharacterPropertiesComplex;
  58
  59
  60     /** contributes properties for paragraph formatting.
  61      */
  62     service com::sun::star::style::ParagraphProperties;
  63
  64
  65     /** contributes properties for paragraph formatting of Asian text.
  66      */
  67     [optional] service com::sun::star::style::ParagraphPropertiesAsian;
  68
  69
  70     /** contributes properties for paragraph formatting of Complex text.
  71      */
  72     [optional] service com::sun::star::style::ParagraphPropertiesComplex;
  73
  74
  75     /** provides interfaces to find cells with specific properties.
  76      */
  77     service com::sun::star::sheet::SheetRangesQuery;
  78
  79
  80     /** provides methods to lock and unlock the update between
  81         com::sun::star::table::XCell and
  82         com::sun::star::text::XText.
  83     */
  84     interface com::sun::star::document::XActionLockable;
  85
  86
  87     /** provides "Find and Replace" functionality.
  88
  89         <p>The property
  90         com::sun::star::util::SearchDescriptor::SearchWords
  91         has a different meaning in spreadsheets: If set to `TRUE`, the
  92         spreadsheet searches for cells containing the search text only.</p>
  93      */
  94     interface com::sun::star::util::XReplaceable;
  95
  96
  97     /** provides modifying the cell indentation.
  98      */
  99     interface com::sun::star::util::XIndent;
 100
 101
 102     /** provides access to the collections of columns and rows.
 103      */
 104     interface com::sun::star::table::XColumnRowRange;
 105
 106
 107     /** provides access to the cell address of this cell.
 108      */
 109     interface com::sun::star::sheet::XCellAddressable;
 110
 111
 112     /** provides access to the annotation attached to this cell.
 113      */
 114     interface com::sun::star::sheet::XSheetAnnotationAnchor;
 115
 116
 117     /** provides access to the text fields used in this cell.
 118
 119         <p>With com::sun::star::text::XTextFieldsSupplier::getTextFieldMasters
 120         always returns void since the field master is not supported.</p>
 121      */
 122     interface com::sun::star::text::XTextFieldsSupplier;
 123
 124
 125     [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
 126
 127
 128     /**
 129
 130     @since OOo 2.0
 131
 132     */
 133     [optional] interface com::sun::star::util::XModifyBroadcaster;
 134
 135
 136     /** contains the position of this cell in the sheet (in 1/100 mm).
 137
 138         <p>This property contains the absolute position in the whole
 139         sheet, not the position in the visible area.</p>
 140      */
 141     [readonly, property] com::sun::star::awt::Point Position;
 142
 143
 144     /** contains the size of this cell (in 1/100 mm).
 145      */
 146     [readonly, property] com::sun::star::awt::Size Size;
 147
 148
 149     /** contains the formula string with localized function names.
 150
 151         <p>This property can also be used to set a new localized formula.</p>
 152      */
 153     [optional, property] string FormulaLocal;
 154
 155
 156     /** contains the content type of the cell.
 157
 158         <p>This property returns not com::sun::star::sheet::FormulaResult
 159         but instead com::sun::star::table::CellContentType. Use FormulaResult2
 160         if the correct property is needed.</p>
 161      */
 162     [readonly, property] long FormulaResultType;
 163
 164
 165     /** contains the conditional formatting settings for this cell.
 166
 167         <p>After a conditional format has been changed it has to be
 168         reinserted into the property set.</p>
 169
 170         @see com::sun::star::sheet::TableConditionalFormat
 171      */
 172     [property] com::sun::star::sheet::XSheetConditionalEntries
 173         ConditionalFormat;
 174
 175
 176     /** contains the conditional formatting settings for this cell,
 177         using localized formulas.
 178
 179         <p>After a conditional format has been changed it has to be
 180         reinserted into the property set.</p>
 181
 182         @see com::sun::star::sheet::TableConditionalFormat
 183      */
 184     [optional, property] com::sun::star::sheet::XSheetConditionalEntries
 185         ConditionalFormatLocal;
 186
 187
 188     /** contains the data validation settings for this cell.
 189
 190         <p>After the data validation settings have been changed the
 191         validation has to be reinserted into the property set.</p>
 192
 193         @see com::sun::star::sheet::TableValidation
 194      */
 195     [property] com::sun::star::beans::XPropertySet Validation;
 196
 197
 198     /** contains the data validation settings for this cell,
 199         using localized formulas.
 200
 201         <p>After the data validation settings have been changed the
 202         validation has to be reinserted into the property set.</p>
 203
 204         @see com::sun::star::sheet::TableValidation
 205      */
 206     [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
 207
 208
 209     /** Returns the absolute address of the range as string, e.g. "$Sheet1.$B$2".
 210      */
 211     [optional, readonly, property] string AbsoluteName;
 212
 213
 214     /** contains the content type of the cell.
 215
 216         @see com::sun::star::table::CellContentType
 217         @since LibreOffice 6.1
 218     */
 219     [optional, readonly, property] com::sun::star::table::CellContentType CellContentType;
 220
 221
 222     /** contains the result type of a formula.
 223
 224         @see com::sun::star::sheet::FormulaResult
 225         @since LibreOffice 6.1
 226      */
 227     [optional, readonly, property] long FormulaResultType2;
 228 };
 229
 230
 231 }; }; }; };
 232
 233 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */