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