offapi/com/sun/star/sheet/SheetCellRange.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: SheetCellRange.idl,v $
  10  * $Revision: 1.18 $
  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_SheetCellRange_idl__
  32 #define __com_sun_star_sheet_SheetCellRange_idl__
  33
  34
  35 #ifndef __com_sun_star_table_CellRange_idl__
  36 #include <com/sun/star/table/CellRange.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_style_CharacterProperties_idl__
  40 #include <com/sun/star/style/CharacterProperties.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
  44 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
  48 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  49 #endif
  50
  51 #ifndef __com_sun_star_style_ParagraphProperties_idl__
  52 #include <com/sun/star/style/ParagraphProperties.idl>
  53 #endif
  54
  55 #ifndef __com_sun_star_sheet_SheetRangesQuery_idl__
  56 #include <com/sun/star/sheet/SheetRangesQuery.idl>
  57 #endif
  58
  59
  60 #ifndef __com_sun_star_util_XReplaceable_idl__
  61 #include <com/sun/star/util/XReplaceable.idl>
  62 #endif
  63
  64 #ifndef __com_sun_star_util_XMergeable_idl__
  65 #include <com/sun/star/util/XMergeable.idl>
  66 #endif
  67
  68 #ifndef __com_sun_star_util_XIndent_idl__
  69 #include <com/sun/star/util/XIndent.idl>
  70 #endif
  71
  72 #ifndef __com_sun_star_table_XColumnRowRange_idl__
  73 #include <com/sun/star/table/XColumnRowRange.idl>
  74 #endif
  75
  76 #ifndef __com_sun_star_table_XAutoFormattable_idl__
  77 #include <com/sun/star/table/XAutoFormattable.idl>
  78 #endif
  79
  80 #ifndef __com_sun_star_sheet_XSheetCellRange_idl__
  81 #include <com/sun/star/sheet/XSheetCellRange.idl>
  82 #endif
  83
  84 #ifndef __com_sun_star_sheet_XCellRangeData_idl__
  85 #include <com/sun/star/sheet/XCellRangeData.idl>
  86 #endif
  87
  88 #ifndef __com_sun_star_sheet_XCellRangeFormula_idl__
  89 #include <com/sun/star/sheet/XCellRangeFormula.idl>
  90 #endif
  91
  92 #ifndef __com_sun_star_sheet_XCellRangeAddressable_idl__
  93 #include <com/sun/star/sheet/XCellRangeAddressable.idl>
  94 #endif
  95
  96 #ifndef __com_sun_star_sheet_XSheetOperation_idl__
  97 #include <com/sun/star/sheet/XSheetOperation.idl>
  98 #endif
  99
 100 #ifndef __com_sun_star_sheet_XCellSeries_idl__
 101 #include <com/sun/star/sheet/XCellSeries.idl>
 102 #endif
 103
 104 #ifndef __com_sun_star_sheet_XArrayFormulaRange_idl__
 105 #include <com/sun/star/sheet/XArrayFormulaRange.idl>
 106 #endif
 107
 108 #ifndef __com_sun_star_sheet_XMultipleOperation_idl__
 109 #include <com/sun/star/sheet/XMultipleOperation.idl>
 110 #endif
 111
 112 #ifndef __com_sun_star_util_XSortable_idl__
 113 #include <com/sun/star/util/XSortable.idl>
 114 #endif
 115
 116 #ifndef __com_sun_star_util_XImportable_idl__
 117 #include <com/sun/star/util/XImportable.idl>
 118 #endif
 119
 120 #ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__
 121 #include <com/sun/star/sheet/XSubTotalCalculatable.idl>
 122 #endif
 123
 124 #ifndef __com_sun_star_sheet_XSheetFilterableEx_idl__
 125 #include <com/sun/star/sheet/XSheetFilterableEx.idl>
 126 #endif
 127
 128 #ifndef __com_sun_star_sheet_XCellFormatRangesSupplier_idl__
 129 #include <com/sun/star/sheet/XCellFormatRangesSupplier.idl>
 130 #endif
 131
 132 #ifndef __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__
 133 #include <com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl>
 134 #endif
 135
 136 #ifndef __com_sun_star_chart_XChartDataArray_idl__
 137 #include <com/sun/star/chart/XChartDataArray.idl>
 138 #endif
 139
 140
 141 #ifndef __com_sun_star_awt_Point_idl__
 142 #include <com/sun/star/awt/Point.idl>
 143 #endif
 144
 145 #ifndef __com_sun_star_awt_Size_idl__
 146 #include <com/sun/star/awt/Size.idl>
 147 #endif
 148
 149 #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
 150 #include <com/sun/star/sheet/XSheetConditionalEntries.idl>
 151 #endif
 152
 153 #ifndef __com_sun_star_beans_XPropertySet_idl__
 154 #include <com/sun/star/beans/XPropertySet.idl>
 155 #endif
 156
 157 #ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
 158 #include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
 159 #endif
 160
 161 #ifndef __com_sun_star_util_XModifyBroadcaster_idl__
 162 #include <com/sun/star/util/XModifyBroadcaster.idl>
 163 #endif
 164
 165 //=============================================================================
 166
 167 module com {  module sun {  module star {  module sheet {
 168
 169 //=============================================================================
 170
 171 /** represents a rectangular range of cells in a spreadsheet document.
 172
 173     <p>This service is an extension of the CellRange service for use
 174     in spreadsheet documents.</p>
 175  */
 176 published service SheetCellRange
 177 {
 178     //-------------------------------------------------------------------------
 179
 180     /** provides basic handling of cell ranges and contributes common cell
 181         formatting properties.
 182      */
 183     service com::sun::star::table::CellRange;
 184
 185     //-------------------------------------------------------------------------
 186
 187     /** contributes properties for character formatting of Western text.
 188      */
 189     service com::sun::star::style::CharacterProperties;
 190
 191     //-------------------------------------------------------------------------
 192
 193     /** contributes properties for character formatting of Asian text.
 194      */
 195     service com::sun::star::style::CharacterPropertiesAsian;
 196
 197     //-------------------------------------------------------------------------
 198
 199     /** contributes properties for character formatting of Complex text.
 200      */
 201     service com::sun::star::style::CharacterPropertiesComplex;
 202
 203     //-------------------------------------------------------------------------
 204
 205     /** contributes properties for paragraph formatting.
 206      */
 207     service com::sun::star::style::ParagraphProperties;
 208
 209     //-------------------------------------------------------------------------
 210
 211     /** provides interfaces to find cells with specific properties.
 212      */
 213     service com::sun::star::sheet::SheetRangesQuery;
 214
 215     //=========================================================================
 216
 217     /** provides "Find & Replace" functionality.
 218
 219         <p>The property
 220         <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member>
 221         has a different meaning in spreadsheets: If set to <TRUE/>, the
 222         spreadsheet searches for cells containing the serch text only.</p>
 223      */
 224     interface com::sun::star::util::XReplaceable;
 225
 226     //-------------------------------------------------------------------------
 227
 228     /** provides merging and unmerging the cells of this cell range.
 229      */
 230     interface com::sun::star::util::XMergeable;
 231
 232     //-------------------------------------------------------------------------
 233
 234     /** provides modifying the cell indentation.
 235      */
 236     interface com::sun::star::util::XIndent;
 237
 238     //-------------------------------------------------------------------------
 239
 240     /** provides access to the collections of columns and rows.
 241      */
 242     interface com::sun::star::table::XColumnRowRange;
 243
 244     //-------------------------------------------------------------------------
 245
 246     /** provides applying an AutoFormat to the cell range.
 247      */
 248     interface com::sun::star::table::XAutoFormattable;
 249
 250     //-------------------------------------------------------------------------
 251
 252     /** provides access to the spreadsheet that contains this cell range.
 253      */
 254     interface com::sun::star::sheet::XSheetCellRange;
 255
 256     //-------------------------------------------------------------------------
 257
 258     /** provides simultaneous access to the contents of all cells.
 259      */
 260     interface com::sun::star::sheet::XCellRangeData;
 261
 262     //-------------------------------------------------------------------------
 263
 264     /** provides simultaneous access to the formula contents of all cells.
 265
 266         @since OOo 1.1.2
 267      */
 268     [optional] interface com::sun::star::sheet::XCellRangeFormula;
 269
 270     //-------------------------------------------------------------------------
 271
 272     /** provides access to the cell range address of this range.
 273      */
 274     interface com::sun::star::sheet::XCellRangeAddressable;
 275
 276     //-------------------------------------------------------------------------
 277
 278     /** provides computation of a value based on the contents of all
 279         cells of this range and to clear specific cells.
 280      */
 281     interface com::sun::star::sheet::XSheetOperation;
 282
 283     //-------------------------------------------------------------------------
 284
 285     /** provides filling out the cell range automatically with values based
 286         on a start value, step count and fill mode.
 287      */
 288     interface com::sun::star::sheet::XCellSeries;
 289
 290     //-------------------------------------------------------------------------
 291
 292     /** provides handling of array formulas.
 293      */
 294     interface com::sun::star::sheet::XArrayFormulaRange;
 295
 296     //-------------------------------------------------------------------------
 297
 298     /** provides access to the Multiple Operations feature.
 299      */
 300     interface com::sun::star::sheet::XMultipleOperation;
 301
 302     //-------------------------------------------------------------------------
 303
 304     /** provides sorting functionality.
 305      */
 306     interface com::sun::star::util::XSortable;
 307
 308     //-------------------------------------------------------------------------
 309
 310     /** provides functionality to import data from external data sources.
 311
 312         @see com::sun::star::sheet::DatabaseImportDescriptor
 313
 314      */
 315     interface com::sun::star::util::XImportable;
 316
 317     //-------------------------------------------------------------------------
 318
 319     /** provides calculating SubTotal values in this range.
 320      */
 321     interface com::sun::star::sheet::XSubTotalCalculatable;
 322
 323     //-------------------------------------------------------------------------
 324
 325     /** provides filtering the contents of this range.
 326      */
 327     interface com::sun::star::sheet::XSheetFilterableEx;
 328
 329     //-------------------------------------------------------------------------
 330
 331     /** provide access to a collection of equal-formatted cell ranges.
 332      */
 333     interface com::sun::star::sheet::XCellFormatRangesSupplier;
 334
 335     //-------------------------------------------------------------------------
 336
 337     /** provide access to a collection of equal-formatted cell ranges.
 338      */
 339     interface com::sun::star::sheet::XUniqueCellFormatRangesSupplier;
 340
 341     //-------------------------------------------------------------------------
 342
 343     /** provides modifying the source data cells of a chart and makes
 344         it possible to learn about changes in the cell values.
 345      */
 346     interface com::sun::star::chart::XChartDataArray;
 347
 348     //-------------------------------------------------------------------------
 349
 350     [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
 351
 352     //-------------------------------------------------------------------------
 353
 354     /**
 355
 356     @since OOo 2.0.0
 357
 358     */
 359     [optional] interface com::sun::star::util::XModifyBroadcaster;
 360
 361     //=========================================================================
 362
 363     /** contains the position of the top left cell of this range in
 364         the sheet (in 1/100 mm).
 365
 366         <p>This property contains the absolute position in the whole
 367         sheet, not the position in the visible area.</p>
 368      */
 369     [readonly, property] com::sun::star::awt::Point Position;
 370
 371     //-------------------------------------------------------------------------
 372
 373     /** contains the size of this range (in 1/100 mm).
 374      */
 375     [readonly, property] com::sun::star::awt::Size Size;
 376
 377     //-------------------------------------------------------------------------
 378
 379     /** contains the conditional formatting settings for this cell.
 380
 381         <p>After a conditional format has been changed it has to be
 382         reinserted into the property set.</p>
 383
 384         @see com::sun::star::sheet::TableConditionalFormat
 385      */
 386     [property] com::sun::star::sheet::XSheetConditionalEntries
 387         ConditionalFormat;
 388
 389     //-------------------------------------------------------------------------
 390
 391     /** contains the conditional formatting settings for this cell,
 392         using localized formulas.
 393
 394         <p>After a conditional format has been changed it has to be
 395         reinserted into the property set.</p>
 396
 397         @see com::sun::star::sheet::TableConditionalFormat
 398      */
 399     [optional, property] com::sun::star::sheet::XSheetConditionalEntries
 400         ConditionalFormatLocal;
 401
 402     //-------------------------------------------------------------------------
 403
 404     /** contains the data validation settings for this cell.
 405
 406         <p>After the data validation settings have been changed the
 407         validation has to be reinserted into the property set.</p>
 408
 409         @see com::sun::star::sheet::TableValidation
 410      */
 411     [property] com::sun::star::beans::XPropertySet Validation;
 412
 413     //-------------------------------------------------------------------------
 414
 415     /** contains the data validation settings for this cell,
 416         using localized formulas.
 417
 418         <p>After the data validation settings have been changed the
 419         validation has to be reinserted into the property set.</p>
 420
 421         @see com::sun::star::sheet::TableValidation
 422      */
 423     [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
 424
 425     //-------------------------------------------------------------------------
 426
 427     /** Returns the absolute adress of the range as string, e.g. "$Sheet1.$B$2:$D$5".
 428      */
 429     [optional, readonly, property] string AbsoluteName;
 430 };
 431
 432 //=============================================================================
 433
 434 }; }; }; };
 435
 436 #endif
 437