1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef __com_sun_star_sheet_SheetCellRange_idl__
21 #define __com_sun_star_sheet_SheetCellRange_idl__
24 #include
<com
/sun
/star
/table
/CellRange.idl
>
25 #include
<com
/sun
/star
/style
/CharacterProperties.idl
>
26 #include
<com
/sun
/star
/style
/CharacterPropertiesAsian.idl
>
27 #include
<com
/sun
/star
/style
/CharacterPropertiesComplex.idl
>
28 #include
<com
/sun
/star
/style
/ParagraphProperties.idl
>
29 #include
<com
/sun
/star
/sheet
/SheetRangesQuery.idl
>
32 #include
<com
/sun
/star
/util
/XReplaceable.idl
>
33 #include
<com
/sun
/star
/util
/XMergeable.idl
>
34 #include
<com
/sun
/star
/util
/XIndent.idl
>
35 #include
<com
/sun
/star
/table
/XColumnRowRange.idl
>
36 #include
<com
/sun
/star
/table
/XAutoFormattable.idl
>
37 #include
<com
/sun
/star
/sheet
/XSheetCellRange.idl
>
38 #include
<com
/sun
/star
/sheet
/XCellRangeData.idl
>
39 #include
<com
/sun
/star
/sheet
/XCellRangeFormula.idl
>
40 #include
<com
/sun
/star
/sheet
/XCellRangeAddressable.idl
>
41 #include
<com
/sun
/star
/sheet
/XSheetOperation.idl
>
42 #include
<com
/sun
/star
/sheet
/XCellSeries.idl
>
43 #include
<com
/sun
/star
/sheet
/XArrayFormulaRange.idl
>
44 #include
<com
/sun
/star
/sheet
/XMultipleOperation.idl
>
45 #include
<com
/sun
/star
/util
/XSortable.idl
>
46 #include
<com
/sun
/star
/util
/XImportable.idl
>
47 #include
<com
/sun
/star
/sheet
/XSubTotalCalculatable.idl
>
48 #include
<com
/sun
/star
/sheet
/XSheetFilterableEx.idl
>
49 #include
<com
/sun
/star
/sheet
/XCellFormatRangesSupplier.idl
>
50 #include
<com
/sun
/star
/sheet
/XUniqueCellFormatRangesSupplier.idl
>
51 #include
<com
/sun
/star
/chart
/XChartDataArray.idl
>
54 #include
<com
/sun
/star
/awt
/Point.idl
>
55 #include
<com
/sun
/star
/awt
/Size.idl
>
56 #include
<com
/sun
/star
/sheet
/XSheetConditionalEntries.idl
>
57 #include
<com
/sun
/star
/beans
/XPropertySet.idl
>
58 #include
<com
/sun
/star
/beans
/XTolerantMultiPropertySet.idl
>
59 #include
<com
/sun
/star
/util
/XModifyBroadcaster.idl
>
62 module com
{ module sun
{ module star
{ module sheet
{
65 /** represents a rectangular range of cells in a spreadsheet document.
67 <p>This service is an extension of the CellRange service for use
68 in spreadsheet documents.</p>
70 published service SheetCellRange
73 /** provides basic handling of cell ranges and contributes common cell
74 formatting properties.
76 service com
::sun
::star
::table
::CellRange
;
79 /** contributes properties for character formatting of Western text.
81 service com
::sun
::star
::style
::CharacterProperties
;
84 /** contributes properties for character formatting of Asian text.
86 service com
::sun
::star
::style
::CharacterPropertiesAsian
;
89 /** contributes properties for character formatting of Complex text.
91 service com
::sun
::star
::style
::CharacterPropertiesComplex
;
94 /** contributes properties for paragraph formatting.
96 service com
::sun
::star
::style
::ParagraphProperties
;
99 /** provides interfaces to find cells with specific properties.
101 service com
::sun
::star
::sheet
::SheetRangesQuery
;
104 /** provides "Find & Replace" functionality.
107 com::sun::star::util::SearchDescriptor::SearchWords
108 has a different meaning in spreadsheets: If set to `TRUE`, the
109 spreadsheet searches for cells containing the search text only.</p>
111 interface com
::sun
::star
::util
::XReplaceable
;
114 /** provides merging and unmerging the cells of this cell range.
116 interface com
::sun
::star
::util
::XMergeable
;
119 /** provides modifying the cell indentation.
121 interface com
::sun
::star
::util
::XIndent
;
124 /** provides access to the collections of columns and rows.
126 interface com
::sun
::star
::table
::XColumnRowRange
;
129 /** provides applying an AutoFormat to the cell range.
131 interface com
::sun
::star
::table
::XAutoFormattable
;
134 /** provides access to the spreadsheet that contains this cell range.
136 interface com
::sun
::star
::sheet
::XSheetCellRange
;
139 /** provides simultaneous access to the contents of all cells.
141 interface com
::sun
::star
::sheet
::XCellRangeData
;
144 /** provides simultaneous access to the formula contents of all cells.
148 [optional] interface com
::sun
::star
::sheet
::XCellRangeFormula
;
151 /** provides access to the cell range address of this range.
153 interface com
::sun
::star
::sheet
::XCellRangeAddressable
;
156 /** provides computation of a value based on the contents of all
157 cells of this range and to clear specific cells.
159 interface com
::sun
::star
::sheet
::XSheetOperation
;
162 /** provides filling out the cell range automatically with values based
163 on a start value, step count and fill mode.
165 interface com
::sun
::star
::sheet
::XCellSeries
;
168 /** provides handling of array formulas.
170 interface com
::sun
::star
::sheet
::XArrayFormulaRange
;
173 /** provides access to the Multiple Operations feature.
175 interface com
::sun
::star
::sheet
::XMultipleOperation
;
178 /** provides sorting functionality.
180 interface com
::sun
::star
::util
::XSortable
;
183 /** provides functionality to import data from external data sources.
185 @see com::sun::star::sheet::DatabaseImportDescriptor
188 interface com
::sun
::star
::util
::XImportable
;
191 /** provides calculating SubTotal values in this range.
193 interface com
::sun
::star
::sheet
::XSubTotalCalculatable
;
196 /** provides filtering the contents of this range.
198 interface com
::sun
::star
::sheet
::XSheetFilterableEx
;
201 /** provide access to a collection of equal-formatted cell ranges.
203 interface com
::sun
::star
::sheet
::XCellFormatRangesSupplier
;
206 /** provide access to a collection of equal-formatted cell ranges.
208 interface com
::sun
::star
::sheet
::XUniqueCellFormatRangesSupplier
;
211 /** provides modifying the source data cells of a chart and makes
212 it possible to learn about changes in the cell values.
214 interface com
::sun
::star
::chart
::XChartDataArray
;
217 [optional] interface com
::sun
::star
::beans
::XTolerantMultiPropertySet
;
225 [optional] interface com
::sun
::star
::util
::XModifyBroadcaster
;
228 /** contains the position of the top left cell of this range in
229 the sheet (in 1/100 mm).
231 <p>This property contains the absolute position in the whole
232 sheet, not the position in the visible area.</p>
234 [readonly, property
] com
::sun
::star
::awt
::Point Position
;
237 /** contains the size of this range (in 1/100 mm).
239 [readonly, property
] com
::sun
::star
::awt
::Size Size
;
242 /** contains the conditional formatting settings for this cell.
244 <p>After a conditional format has been changed it has to be
245 reinserted into the property set.</p>
247 @see com::sun::star::sheet::TableConditionalFormat
249 [property
] com
::sun
::star
::sheet
::XSheetConditionalEntries
253 /** contains the conditional formatting settings for this cell,
254 using localized formulas.
256 <p>After a conditional format has been changed it has to be
257 reinserted into the property set.</p>
259 @see com::sun::star::sheet::TableConditionalFormat
261 [optional, property
] com
::sun
::star
::sheet
::XSheetConditionalEntries
262 ConditionalFormatLocal
;
265 /** contains the data validation settings for this cell.
267 <p>After the data validation settings have been changed the
268 validation has to be reinserted into the property set.</p>
270 @see com::sun::star::sheet::TableValidation
272 [property
] com
::sun
::star
::beans
::XPropertySet Validation
;
275 /** contains the data validation settings for this cell,
276 using localized formulas.
278 <p>After the data validation settings have been changed the
279 validation has to be reinserted into the property set.</p>
281 @see com::sun::star::sheet::TableValidation
283 [optional, property
] com
::sun
::star
::beans
::XPropertySet ValidationLocal
;
286 /** Returns the absolute address of the range as string, e.g. "$Sheet1.$B$2:$D$5".
288 [optional, readonly, property
] string AbsoluteName
;
296 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */