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