offapi/com/sun/star/sheet/SheetCellRange.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
  21
  22
  23
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** represents a rectangular range of cells in a spreadsheet document.
  30
  31     <p>This service is an extension of the CellRange service for use
  32     in spreadsheet documents.</p>
  33  */
  34 published service SheetCellRange
  35 {
  36
  37     /** provides basic handling of cell ranges and contributes common cell
  38         formatting properties.
  39      */
  40     service com::sun::star::table::CellRange;
  41
  42
  43     /** contributes properties for character formatting of Western text.
  44      */
  45     service com::sun::star::style::CharacterProperties;
  46
  47
  48     /** contributes properties for character formatting of Asian text.
  49      */
  50     service com::sun::star::style::CharacterPropertiesAsian;
  51
  52
  53     /** contributes properties for character formatting of Complex text.
  54      */
  55     service com::sun::star::style::CharacterPropertiesComplex;
  56
  57
  58     /** contributes properties for paragraph formatting.
  59      */
  60     service com::sun::star::style::ParagraphProperties;
  61
  62
  63     /** provides interfaces to find cells with specific properties.
  64      */
  65     service com::sun::star::sheet::SheetRangesQuery;
  66
  67
  68     /** provides "Find and Replace" functionality.
  69
  70         <p>The property
  71         com::sun::star::util::SearchDescriptor::SearchWords
  72         has a different meaning in spreadsheets: If set to `TRUE`, the
  73         spreadsheet searches for cells containing the search text only.</p>
  74      */
  75     interface com::sun::star::util::XReplaceable;
  76
  77
  78     /** provides merging and unmerging the cells of this cell range.
  79      */
  80     interface com::sun::star::util::XMergeable;
  81
  82
  83     /** provides modifying the cell indentation.
  84      */
  85     interface com::sun::star::util::XIndent;
  86
  87
  88     /** provides access to the collections of columns and rows.
  89      */
  90     interface com::sun::star::table::XColumnRowRange;
  91
  92
  93     /** provides applying an AutoFormat to the cell range.
  94      */
  95     interface com::sun::star::table::XAutoFormattable;
  96
  97
  98     /** provides access to the spreadsheet that contains this cell range.
  99      */
 100     interface com::sun::star::sheet::XSheetCellRange;
 101
 102
 103     /** provides simultaneous access to the contents of all cells.
 104      */
 105     interface com::sun::star::sheet::XCellRangeData;
 106
 107
 108     /** provides simultaneous access to the formula contents of all cells.
 109
 110         @since OOo 1.1.2
 111      */
 112     [optional] interface com::sun::star::sheet::XCellRangeFormula;
 113
 114
 115     /** provides access to the cell range address of this range.
 116      */
 117     interface com::sun::star::sheet::XCellRangeAddressable;
 118
 119
 120     /** provides computation of a value based on the contents of all
 121         cells of this range and to clear specific cells.
 122      */
 123     interface com::sun::star::sheet::XSheetOperation;
 124
 125
 126     /** provides filling out the cell range automatically with values based
 127         on a start value, step count and fill mode.
 128      */
 129     interface com::sun::star::sheet::XCellSeries;
 130
 131
 132     /** provides handling of array formulas.
 133      */
 134     interface com::sun::star::sheet::XArrayFormulaRange;
 135
 136
 137     /** provides access to the Multiple Operations feature.
 138      */
 139     interface com::sun::star::sheet::XMultipleOperation;
 140
 141
 142     /** provides sorting functionality.
 143      */
 144     interface com::sun::star::util::XSortable;
 145
 146
 147     /** provides functionality to import data from external data sources.
 148
 149         @see com::sun::star::sheet::DatabaseImportDescriptor
 150
 151      */
 152     interface com::sun::star::util::XImportable;
 153
 154
 155     /** provides calculating SubTotal values in this range.
 156      */
 157     interface com::sun::star::sheet::XSubTotalCalculatable;
 158
 159
 160     /** provides filtering the contents of this range.
 161      */
 162     interface com::sun::star::sheet::XSheetFilterableEx;
 163
 164
 165     /** provide access to a collection of equal-formatted cell ranges.
 166      */
 167     interface com::sun::star::sheet::XCellFormatRangesSupplier;
 168
 169
 170     /** provide access to a collection of equal-formatted cell ranges.
 171      */
 172     interface com::sun::star::sheet::XUniqueCellFormatRangesSupplier;
 173
 174
 175     /** provides modifying the source data cells of a chart and makes
 176         it possible to learn about changes in the cell values.
 177      */
 178     interface com::sun::star::chart::XChartDataArray;
 179
 180
 181     [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
 182
 183
 184     /**
 185
 186     @since OOo 2.0
 187
 188     */
 189     [optional] interface com::sun::star::util::XModifyBroadcaster;
 190
 191
 192     /** contains the position of the top left cell of this range in
 193         the sheet (in 1/100 mm).
 194
 195         <p>This property contains the absolute position in the whole
 196         sheet, not the position in the visible area.</p>
 197      */
 198     [readonly, property] com::sun::star::awt::Point Position;
 199
 200
 201     /** contains the size of this range (in 1/100 mm).
 202      */
 203     [readonly, property] com::sun::star::awt::Size Size;
 204
 205
 206     /** contains the conditional formatting settings for this cell.
 207
 208         <p>After a conditional format has been changed it has to be
 209         reinserted into the property set.</p>
 210
 211         @see com::sun::star::sheet::TableConditionalFormat
 212      */
 213     [property] com::sun::star::sheet::XSheetConditionalEntries
 214         ConditionalFormat;
 215
 216
 217     /** contains the conditional formatting settings for this cell,
 218         using localized formulas.
 219
 220         <p>After a conditional format has been changed it has to be
 221         reinserted into the property set.</p>
 222
 223         @see com::sun::star::sheet::TableConditionalFormat
 224      */
 225     [optional, property] com::sun::star::sheet::XSheetConditionalEntries
 226         ConditionalFormatLocal;
 227
 228
 229     /** contains the data validation settings for this cell.
 230
 231         <p>After the data validation settings have been changed the
 232         validation has to be reinserted into the property set.</p>
 233
 234         @see com::sun::star::sheet::TableValidation
 235      */
 236     [property] com::sun::star::beans::XPropertySet Validation;
 237
 238
 239     /** contains the data validation settings for this cell,
 240         using localized formulas.
 241
 242         <p>After the data validation settings have been changed the
 243         validation has to be reinserted into the property set.</p>
 244
 245         @see com::sun::star::sheet::TableValidation
 246      */
 247     [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
 248
 249
 250     /** Returns the absolute address of the range as string, e.g. "$Sheet1.$B$2:$D$5".
 251      */
 252     [optional, readonly, property] string AbsoluteName;
 253 };
 254
 255
 256 }; }; }; };
 257
 258 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */