offapi/com/sun/star/sheet/SheetCell.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SheetCell.idl,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_SheetCell_idl__
  32 #define __com_sun_star_sheet_SheetCell_idl__
  33
  34
  35 #ifndef __com_sun_star_table_Cell_idl__
  36 #include <com/sun/star/table/Cell.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_text_Text_idl__
  40 #include <com/sun/star/text/Text.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_style_CharacterProperties_idl__
  44 #include <com/sun/star/style/CharacterProperties.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
  48 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  49 #endif
  50
  51 #ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
  52 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  53 #endif
  54
  55 #ifndef __com_sun_star_style_ParagraphProperties_idl__
  56 #include <com/sun/star/style/ParagraphProperties.idl>
  57 #endif
  58
  59 #ifndef __com_sun_star_style_ParagraphPropertiesAsian_idl__
  60 #include <com/sun/star/style/ParagraphPropertiesAsian.idl>
  61 #endif
  62
  63 #ifndef __com_sun_star_style_ParagraphPropertiesComplex_idl__
  64 #include <com/sun/star/style/ParagraphPropertiesComplex.idl>
  65 #endif
  66
  67 #ifndef __com_sun_star_sheet_SheetRangesQuery_idl__
  68 #include <com/sun/star/sheet/SheetRangesQuery.idl>
  69 #endif
  70
  71
  72 #ifndef __com_sun_star_document_XActionLockable_idl__
  73 #include <com/sun/star/document/XActionLockable.idl>
  74 #endif
  75
  76 #ifndef __com_sun_star_util_XReplaceable_idl__
  77 #include <com/sun/star/util/XReplaceable.idl>
  78 #endif
  79
  80 #ifndef __com_sun_star_util_XIndent_idl__
  81 #include <com/sun/star/util/XIndent.idl>
  82 #endif
  83
  84 #ifndef __com_sun_star_table_XColumnRowRange_idl__
  85 #include <com/sun/star/table/XColumnRowRange.idl>
  86 #endif
  87
  88 #ifndef __com_sun_star_sheet_XCellAddressable_idl__
  89 #include <com/sun/star/sheet/XCellAddressable.idl>
  90 #endif
  91
  92 #ifndef __com_sun_star_sheet_XSheetAnnotationAnchor_idl__
  93 #include <com/sun/star/sheet/XSheetAnnotationAnchor.idl>
  94 #endif
  95
  96 #ifndef __com_sun_star_text_XTextFieldsSupplier_idl__
  97 #include <com/sun/star/text/XTextFieldsSupplier.idl>
  98 #endif
  99
 100
 101 #ifndef __com_sun_star_awt_Point_idl__
 102 #include <com/sun/star/awt/Point.idl>
 103 #endif
 104
 105 #ifndef __com_sun_star_awt_Size_idl__
 106 #include <com/sun/star/awt/Size.idl>
 107 #endif
 108
 109 #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
 110 #include <com/sun/star/sheet/XSheetConditionalEntries.idl>
 111 #endif
 112
 113 #ifndef __com_sun_star_beans_XPropertySet_idl__
 114 #include <com/sun/star/beans/XPropertySet.idl>
 115 #endif
 116
 117 #ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
 118 #include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
 119 #endif
 120
 121 #ifndef __com_sun_star_util_XModifyBroadcaster_idl__
 122 #include <com/sun/star/util/XModifyBroadcaster.idl>
 123 #endif
 124
 125 //=============================================================================
 126
 127 module com {  module sun {  module star {  module sheet {
 128
 129 //=============================================================================
 130
 131 /** represents a single addressable cell in a spreadsheet document.
 132  */
 133 published service SheetCell
 134 {
 135     //-------------------------------------------------------------------------
 136
 137     /** provides basic cell handling and contributes common cell
 138         formatting properties.
 139      */
 140     service com::sun::star::table::Cell;
 141
 142     //-------------------------------------------------------------------------
 143
 144     /** provides handling of formatted text cells.
 145      */
 146     service com::sun::star::text::Text;
 147
 148     //-------------------------------------------------------------------------
 149
 150     /** contributes properties for character formatting of Western text.
 151      */
 152     service com::sun::star::style::CharacterProperties;
 153
 154     //-------------------------------------------------------------------------
 155
 156     /** contributes properties for character formatting of Asian text.
 157      */
 158     service com::sun::star::style::CharacterPropertiesAsian;
 159
 160     //-------------------------------------------------------------------------
 161
 162     /** contributes properties for character formatting of Complex text.
 163      */
 164     service com::sun::star::style::CharacterPropertiesComplex;
 165
 166     //-------------------------------------------------------------------------
 167
 168     /** contributes properties for paragraph formatting.
 169      */
 170     service com::sun::star::style::ParagraphProperties;
 171
 172     //-------------------------------------------------------------------------
 173
 174     /** contributes properties for paragraph formatting of Asian text.
 175      */
 176     [optional] service com::sun::star::style::ParagraphPropertiesAsian;
 177
 178     //-------------------------------------------------------------------------
 179
 180     /** contributes properties for paragraph formatting of Complex text.
 181      */
 182     [optional] service com::sun::star::style::ParagraphPropertiesComplex;
 183
 184     //-------------------------------------------------------------------------
 185
 186     /** provides interfaces to find cells with specific properties.
 187      */
 188     service com::sun::star::sheet::SheetRangesQuery;
 189
 190     //=========================================================================
 191
 192     /** provides methods to lock and unlock the update between
 193         <type scope="com::sun::star::table">XCell</type> and
 194         <type scope="com::sun::star::text">XText</type>.
 195     */
 196     interface com::sun::star::document::XActionLockable;
 197
 198     //-------------------------------------------------------------------------
 199
 200     /** provides "Find & Replace" functionality.
 201
 202         <p>The property
 203         <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member>
 204         has a different meaning in spreadsheets: If set to <TRUE/>, the
 205         spreadsheet searches for cells containing the serch text only.</p>
 206      */
 207     interface com::sun::star::util::XReplaceable;
 208
 209     //-------------------------------------------------------------------------
 210
 211     /** provides modifying the cell indentation.
 212      */
 213     interface com::sun::star::util::XIndent;
 214
 215     //-------------------------------------------------------------------------
 216
 217     /** provides access to the collections of columns and rows.
 218      */
 219     interface com::sun::star::table::XColumnRowRange;
 220
 221     //-------------------------------------------------------------------------
 222
 223     /** provides access to the cell address of this cell.
 224      */
 225     interface com::sun::star::sheet::XCellAddressable;
 226
 227     //-------------------------------------------------------------------------
 228
 229     /** provides access to the annotation attached to this cell.
 230      */
 231     interface com::sun::star::sheet::XSheetAnnotationAnchor;
 232
 233     //-------------------------------------------------------------------------
 234
 235     /** provides access to the text fields used in this cell.
 236      */
 237     interface com::sun::star::text::XTextFieldsSupplier;
 238
 239     //-------------------------------------------------------------------------
 240
 241     [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
 242
 243     //-------------------------------------------------------------------------
 244
 245     /**
 246
 247     @since OOo 2.0.0
 248
 249     */
 250     [optional] interface com::sun::star::util::XModifyBroadcaster;
 251
 252     //=========================================================================
 253
 254     /** contains the position of this cell in the sheet (in 1/100 mm).
 255
 256         <p>This property contains the absolute position in the whole
 257         sheet, not the position in the visible area.</p>
 258      */
 259     [readonly, property] com::sun::star::awt::Point Position;
 260
 261     //-------------------------------------------------------------------------
 262
 263     /** contains the size of this cell (in 1/100 mm).
 264      */
 265     [readonly, property] com::sun::star::awt::Size Size;
 266
 267     //-------------------------------------------------------------------------
 268
 269     /** contains the formula string with localized function names.
 270
 271         <p>This property can also be used to set a new localized formula.</p>
 272      */
 273     [optional, property] string FormulaLocal;
 274
 275     //-------------------------------------------------------------------------
 276
 277     /** contains the result type of a formula.
 278
 279         @see com::sun::star::sheet::FormulaResult
 280      */
 281     [readonly, property] long FormulaResultType;
 282
 283     //-------------------------------------------------------------------------
 284
 285     /** contains the conditional formatting settings for this cell.
 286
 287         <p>After a conditional format has been changed it has to be
 288         reinserted into the property set.</p>
 289
 290         @see com::sun::star::sheet::TableConditionalFormat
 291      */
 292     [property] com::sun::star::sheet::XSheetConditionalEntries
 293         ConditionalFormat;
 294
 295     //-------------------------------------------------------------------------
 296
 297     /** contains the conditional formatting settings for this cell,
 298         using localized formulas.
 299
 300         <p>After a conditional format has been changed it has to be
 301         reinserted into the property set.</p>
 302
 303         @see com::sun::star::sheet::TableConditionalFormat
 304      */
 305     [optional, property] com::sun::star::sheet::XSheetConditionalEntries
 306         ConditionalFormatLocal;
 307
 308     //-------------------------------------------------------------------------
 309
 310     /** contains the data validation settings for this cell.
 311
 312         <p>After the data validation settings have been changed the
 313         validation has to be reinserted into the property set.</p>
 314
 315         @see com::sun::star::sheet::TableValidation
 316      */
 317     [property] com::sun::star::beans::XPropertySet Validation;
 318
 319     //-------------------------------------------------------------------------
 320
 321     /** contains the data validation settings for this cell,
 322         using localized formulas.
 323
 324         <p>After the data validation settings have been changed the
 325         validation has to be reinserted into the property set.</p>
 326
 327         @see com::sun::star::sheet::TableValidation
 328      */
 329     [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
 330
 331     //-------------------------------------------------------------------------
 332
 333     /** Returns the absolute adress of the range as string, e.g. "$Sheet1.$B$2".
 334      */
 335     [optional, readonly, property] string AbsoluteName;
 336 };
 337
 338 //=============================================================================
 339
 340 }; }; }; };
 341
 342 #endif
 343