summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/SheetCellRange.idl
blob: b87d52b7f0c4290d5800c42101a18ec656d30c12 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_SheetCellRange_idl__
#define __com_sun_star_sheet_SheetCellRange_idl__


#ifndef __com_sun_star_table_CellRange_idl__
#include <com/sun/star/table/CellRange.idl>
#endif

#ifndef __com_sun_star_style_CharacterProperties_idl__
#include <com/sun/star/style/CharacterProperties.idl>
#endif

#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
#include <com/sun/star/style/CharacterPropertiesAsian.idl>
#endif

#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
#include <com/sun/star/style/CharacterPropertiesComplex.idl>
#endif

#ifndef __com_sun_star_style_ParagraphProperties_idl__
#include <com/sun/star/style/ParagraphProperties.idl>
#endif

#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__
#include <com/sun/star/sheet/SheetRangesQuery.idl>
#endif


#ifndef __com_sun_star_util_XReplaceable_idl__
#include <com/sun/star/util/XReplaceable.idl>
#endif

#ifndef __com_sun_star_util_XMergeable_idl__
#include <com/sun/star/util/XMergeable.idl>
#endif

#ifndef __com_sun_star_util_XIndent_idl__
#include <com/sun/star/util/XIndent.idl>
#endif

#ifndef __com_sun_star_table_XColumnRowRange_idl__
#include <com/sun/star/table/XColumnRowRange.idl>
#endif

#ifndef __com_sun_star_table_XAutoFormattable_idl__
#include <com/sun/star/table/XAutoFormattable.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetCellRange_idl__
#include <com/sun/star/sheet/XSheetCellRange.idl>
#endif

#ifndef __com_sun_star_sheet_XCellRangeData_idl__
#include <com/sun/star/sheet/XCellRangeData.idl>
#endif

#ifndef __com_sun_star_sheet_XCellRangeFormula_idl__
#include <com/sun/star/sheet/XCellRangeFormula.idl>
#endif

#ifndef __com_sun_star_sheet_XCellRangeAddressable_idl__
#include <com/sun/star/sheet/XCellRangeAddressable.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetOperation_idl__
#include <com/sun/star/sheet/XSheetOperation.idl>
#endif

#ifndef __com_sun_star_sheet_XCellSeries_idl__
#include <com/sun/star/sheet/XCellSeries.idl>
#endif

#ifndef __com_sun_star_sheet_XArrayFormulaRange_idl__
#include <com/sun/star/sheet/XArrayFormulaRange.idl>
#endif

#ifndef __com_sun_star_sheet_XMultipleOperation_idl__
#include <com/sun/star/sheet/XMultipleOperation.idl>
#endif

#ifndef __com_sun_star_util_XSortable_idl__
#include <com/sun/star/util/XSortable.idl>
#endif

#ifndef __com_sun_star_util_XImportable_idl__
#include <com/sun/star/util/XImportable.idl>
#endif

#ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__
#include <com/sun/star/sheet/XSubTotalCalculatable.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetFilterableEx_idl__
#include <com/sun/star/sheet/XSheetFilterableEx.idl>
#endif

#ifndef __com_sun_star_sheet_XCellFormatRangesSupplier_idl__
#include <com/sun/star/sheet/XCellFormatRangesSupplier.idl>
#endif

#ifndef __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__
#include <com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl>
#endif

#ifndef __com_sun_star_chart_XChartDataArray_idl__
#include <com/sun/star/chart/XChartDataArray.idl>
#endif


#ifndef __com_sun_star_awt_Point_idl__
#include <com/sun/star/awt/Point.idl>
#endif

#ifndef __com_sun_star_awt_Size_idl__
#include <com/sun/star/awt/Size.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
#include <com/sun/star/sheet/XSheetConditionalEntries.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
#include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
#endif

#ifndef __com_sun_star_util_XModifyBroadcaster_idl__
#include <com/sun/star/util/XModifyBroadcaster.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** represents a rectangular range of cells in a spreadsheet document.

    <p>This service is an extension of the CellRange service for use
    in spreadsheet documents.</p>
 */
published service SheetCellRange
{
    //-------------------------------------------------------------------------

    /** provides basic handling of cell ranges and contributes common cell
        formatting properties.
     */
    service com::sun::star::table::CellRange;

    //-------------------------------------------------------------------------

    /** contributes properties for character formatting of Western text.
     */
    service com::sun::star::style::CharacterProperties;

    //-------------------------------------------------------------------------

    /** contributes properties for character formatting of Asian text.
     */
    service com::sun::star::style::CharacterPropertiesAsian;

    //-------------------------------------------------------------------------

    /** contributes properties for character formatting of Complex text.
     */
    service com::sun::star::style::CharacterPropertiesComplex;

    //-------------------------------------------------------------------------

    /** contributes properties for paragraph formatting.
     */
    service com::sun::star::style::ParagraphProperties;

    //-------------------------------------------------------------------------

    /** provides interfaces to find cells with specific properties.
     */
    service com::sun::star::sheet::SheetRangesQuery;

    //=========================================================================

    /** provides "Find & Replace" functionality.

        <p>The property
        <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member>
        has a different meaning in spreadsheets: If set to <TRUE/>, the
        spreadsheet searches for cells containing the serch text only.</p>
     */
    interface com::sun::star::util::XReplaceable;

    //-------------------------------------------------------------------------

    /** provides merging and unmerging the cells of this cell range.
     */
    interface com::sun::star::util::XMergeable;

    //-------------------------------------------------------------------------

    /** provides modifying the cell indentation.
     */
    interface com::sun::star::util::XIndent;

    //-------------------------------------------------------------------------

    /** provides access to the collections of columns and rows.
     */
    interface com::sun::star::table::XColumnRowRange;

    //-------------------------------------------------------------------------

    /** provides applying an AutoFormat to the cell range.
     */
    interface com::sun::star::table::XAutoFormattable;

    //-------------------------------------------------------------------------

    /** provides access to the spreadsheet that contains this cell range.
     */
    interface com::sun::star::sheet::XSheetCellRange;

    //-------------------------------------------------------------------------

    /** provides simultaneous access to the contents of all cells.
     */
    interface com::sun::star::sheet::XCellRangeData;

    //-------------------------------------------------------------------------

    /** provides simultaneous access to the formula contents of all cells.

        @since OOo 1.1.2
     */
    [optional] interface com::sun::star::sheet::XCellRangeFormula;

    //-------------------------------------------------------------------------

    /** provides access to the cell range address of this range.
     */
    interface com::sun::star::sheet::XCellRangeAddressable;

    //-------------------------------------------------------------------------

    /** provides computation of a value based on the contents of all
        cells of this range and to clear specific cells.
     */
    interface com::sun::star::sheet::XSheetOperation;

    //-------------------------------------------------------------------------

    /** provides filling out the cell range automatically with values based
        on a start value, step count and fill mode.
     */
    interface com::sun::star::sheet::XCellSeries;

    //-------------------------------------------------------------------------

    /** provides handling of array formulas.
     */
    interface com::sun::star::sheet::XArrayFormulaRange;

    //-------------------------------------------------------------------------

    /** provides access to the Multiple Operations feature.
     */
    interface com::sun::star::sheet::XMultipleOperation;

    //-------------------------------------------------------------------------

    /** provides sorting functionality.
     */
    interface com::sun::star::util::XSortable;

    //-------------------------------------------------------------------------

    /** provides functionality to import data from external data sources.

        @see com::sun::star::sheet::DatabaseImportDescriptor

     */
    interface com::sun::star::util::XImportable;

    //-------------------------------------------------------------------------

    /** provides calculating SubTotal values in this range.
     */
    interface com::sun::star::sheet::XSubTotalCalculatable;

    //-------------------------------------------------------------------------

    /** provides filtering the contents of this range.
     */
    interface com::sun::star::sheet::XSheetFilterableEx;

    //-------------------------------------------------------------------------

    /** provide access to a collection of equal-formatted cell ranges.
     */
    interface com::sun::star::sheet::XCellFormatRangesSupplier;

    //-------------------------------------------------------------------------

    /** provide access to a collection of equal-formatted cell ranges.
     */
    interface com::sun::star::sheet::XUniqueCellFormatRangesSupplier;

    //-------------------------------------------------------------------------

    /** provides modifying the source data cells of a chart and makes
        it possible to learn about changes in the cell values.
     */
    interface com::sun::star::chart::XChartDataArray;

    //-------------------------------------------------------------------------

    [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;

    //-------------------------------------------------------------------------

    /**

    @since OOo 2.0.0

    */
    [optional] interface com::sun::star::util::XModifyBroadcaster;

    //=========================================================================

    /** contains the position of the top left cell of this range in
        the sheet (in 1/100 mm).

        <p>This property contains the absolute position in the whole
        sheet, not the position in the visible area.</p>
     */
    [readonly, property] com::sun::star::awt::Point Position;

    //-------------------------------------------------------------------------

    /** contains the size of this range (in 1/100 mm).
     */
    [readonly, property] com::sun::star::awt::Size Size;

    //-------------------------------------------------------------------------

    /** contains the conditional formatting settings for this cell.

        <p>After a conditional format has been changed it has to be
        reinserted into the property set.</p>

        @see com::sun::star::sheet::TableConditionalFormat
     */
    [property] com::sun::star::sheet::XSheetConditionalEntries
        ConditionalFormat;

    //-------------------------------------------------------------------------

    /** contains the conditional formatting settings for this cell,
        using localized formulas.

        <p>After a conditional format has been changed it has to be
        reinserted into the property set.</p>

        @see com::sun::star::sheet::TableConditionalFormat
     */
    [optional, property] com::sun::star::sheet::XSheetConditionalEntries
        ConditionalFormatLocal;

    //-------------------------------------------------------------------------

    /** contains the data validation settings for this cell.

        <p>After the data validation settings have been changed the
        validation has to be reinserted into the property set.</p>

        @see com::sun::star::sheet::TableValidation
     */
    [property] com::sun::star::beans::XPropertySet Validation;

    //-------------------------------------------------------------------------

    /** contains the data validation settings for this cell,
        using localized formulas.

        <p>After the data validation settings have been changed the
        validation has to be reinserted into the property set.</p>

        @see com::sun::star::sheet::TableValidation
     */
    [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;

    //-------------------------------------------------------------------------

    /** Returns the absolute adress of the range as string, e.g. "$Sheet1.$B$2:$D$5".
     */
    [optional, readonly, property] string AbsoluteName;
};

//=============================================================================

}; }; }; };

#endif