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