blob: c6e58bdcaaf2f0a688b3ee8652291ec9f5e7a4ac (
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XSheetCellRangeContainer.idl,v $
* $Revision: 1.6 $
*
* 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_XSheetCellRangeContainer_idl__
#define __com_sun_star_sheet_XSheetCellRangeContainer_idl__
#ifndef __com_sun_star_sheet_XSheetCellRanges_idl__
#include <com/sun/star/sheet/XSheetCellRanges.idl>
#endif
#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif
#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** provides methods to access cell ranges in a collection via index and
to add and remove cell ranges.
@see com::sun::star::sheet::SheetCellRanges
*/
published interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges
{
//-------------------------------------------------------------------------
/** adds the given range to the collection of cell ranges.
@param aCellRangeAddress
contains the address of the new range.
@param bMergeRanges
defines how the range should be added. To merge the ranges
takes more time, but the memory usage is lower.
*/
void addRangeAddress(
[in] com::sun::star::table::CellRangeAddress aCellRangeAddress,
[in] boolean bMergeRanges );
//-------------------------------------------------------------------------
/** removes the given range from the collection of cell ranges.
@param aCellRangeAddress
contains the address of the range to be removed.
<p>The specified range must fit exactly to an element of the
collection. The method does not try to shorten a range.</p>
@throws <type scope="com::sun::star::container">NoSuchElementException</type>
if the collection does not contain the specified range.
*/
void removeRangeAddress(
[in] com::sun::star::table::CellRangeAddress aCellRangeAddress )
raises( com::sun::star::container::NoSuchElementException );
//-------------------------------------------------------------------------
/** adds the given ranges to the collection of cell ranges.
@param aCellRangeAddresses
contains a sequence of addresses of all new ranges.
@param bMergeRanges
defines how the ranges should be added. To merge the ranges
takes more time, but the memory usage is lower.
*/
void addRangeAddresses(
[in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses,
[in] boolean bMergeRanges );
//-------------------------------------------------------------------------
/** removes the given ranges from the collection of cell ranges.
@param aCellRangeAddresses
contains a sequence of addresses of all ranges to be removed.
<p>All specified ranges must fit exactly to elements of the
collection. The method does not try to shorten ranges.</p>
@throws <type scope="com::sun::star::container">NoSuchElementException</type>
if the collection does not contain any of the specified ranges.
*/
void removeRangeAddresses(
[in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses )
raises( com::sun::star::container::NoSuchElementException);
};
//=============================================================================
}; }; }; };
#endif
|
