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

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