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_SheetCellRanges_idl__
25#define __com_sun_star_sheet_SheetCellRanges_idl__
26
27
28#ifndef __com_sun_star_table_CellProperties_idl__
29#include <com/sun/star/table/CellProperties.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_XIndent_idl__
58#include <com/sun/star/util/XIndent.idl>
59#endif
60
61#ifndef __com_sun_star_sheet_XSheetOperation_idl__
62#include <com/sun/star/sheet/XSheetOperation.idl>
63#endif
64
65#ifndef __com_sun_star_chart_XChartDataArray_idl__
66#include <com/sun/star/chart/XChartDataArray.idl>
67#endif
68
69#ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__
70#include <com/sun/star/sheet/XSheetCellRangeContainer.idl>
71#endif
72
73#ifndef __com_sun_star_container_XEnumerationAccess_idl__
74#include <com/sun/star/container/XEnumerationAccess.idl>
75#endif
76
77#ifndef __com_sun_star_container_XNameContainer_idl__
78#include <com/sun/star/container/XNameContainer.idl>
79#endif
80
81
82#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
83#include <com/sun/star/sheet/XSheetConditionalEntries.idl>
84#endif
85
86#ifndef __com_sun_star_beans_XPropertySet_idl__
87#include <com/sun/star/beans/XPropertySet.idl>
88#endif
89
90//=============================================================================
91
92module com {  module sun {  module star {  module sheet {
93
94//=============================================================================
95
96/** represents a collection of cell ranges in a spreadsheet document.
97
98	@see com::sun::star::sheet::SheetCellRange
99 */
100published service SheetCellRanges
101{
102	//-------------------------------------------------------------------------
103
104	/** contributes common cell formatting properties.
105	 */
106	service com::sun::star::table::CellProperties;
107
108	//-------------------------------------------------------------------------
109
110	/** contributes properties for character formatting of Western text.
111	 */
112	service com::sun::star::style::CharacterProperties;
113
114	//-------------------------------------------------------------------------
115
116	/** contributes properties for character formatting of Asian text.
117	 */
118	service com::sun::star::style::CharacterPropertiesAsian;
119
120	//-------------------------------------------------------------------------
121
122	/** contributes properties for character formatting of Complex text.
123	 */
124	service com::sun::star::style::CharacterPropertiesComplex;
125
126	//-------------------------------------------------------------------------
127
128	/** contributes properties for paragraph formatting.
129	 */
130	service com::sun::star::style::ParagraphProperties;
131
132	//-------------------------------------------------------------------------
133
134	/** provides interfaces to find cells with specific properties.
135	 */
136	service com::sun::star::sheet::SheetRangesQuery;
137
138	//=========================================================================
139
140	/** provides "Find & Replace" functionality.
141
142		<p>The property
143		<member scope="com::sun::star::util">SearchDescriptor::SearchWords</member>
144		has a different meaning in spreadsheets: If set to <TRUE/>, the
145		spreadsheet searches for cells containing the serch text only.</p>
146	 */
147	interface com::sun::star::util::XReplaceable;
148
149	//-------------------------------------------------------------------------
150
151	/** provides modifying the cell indentation.
152	 */
153	interface com::sun::star::util::XIndent;
154
155	//-------------------------------------------------------------------------
156
157	/** provides computation of a value based on the contents of all
158		cells of this range and to clear specific cells.
159	 */
160	interface com::sun::star::sheet::XSheetOperation;
161
162	//-------------------------------------------------------------------------
163
164	/** provides modifying the source data cells of a chart and makes
165		it possible to learn about changes in the cell values.
166	 */
167	interface com::sun::star::chart::XChartDataArray;
168
169	//-------------------------------------------------------------------------
170
171	/** provides methods to access cell ranges via index and to add and
172		remove cell ranges.
173	 */
174	interface com::sun::star::sheet::XSheetCellRangeContainer;
175
176	//-------------------------------------------------------------------------
177
178	/** creates an enumeration of all cell ranges.
179
180		@see com::sun::star::sheet::SheetCellRangesEnumeration
181	 */
182	interface com::sun::star::container::XEnumerationAccess;
183
184	//-------------------------------------------------------------------------
185
186	/** provides access of the cell ranges via an user-defined name.
187
188		<p>Later the range can be found, replaced or removed using that
189		name.</p>
190	 */
191	interface com::sun::star::container::XNameContainer;
192
193	//=========================================================================
194
195	/** contains the conditional formatting settings for this cell.
196
197		<p>After a conditional format has been changed it has to be
198		reinserted into the property set.</p>
199
200		@see com::sun::star::sheet::TableConditionalFormat
201	 */
202	[property] com::sun::star::sheet::XSheetConditionalEntries
203		ConditionalFormat;
204
205	//-------------------------------------------------------------------------
206
207	/** contains the conditional formatting settings for this cell,
208		using localized formulas.
209
210		<p>After a conditional format has been changed it has to be
211		reinserted into the property set.</p>
212
213		@see com::sun::star::sheet::TableConditionalFormat
214	 */
215	[optional, property] com::sun::star::sheet::XSheetConditionalEntries
216		ConditionalFormatLocal;
217
218	//-------------------------------------------------------------------------
219
220	/** contains the data validation settings for this cell.
221
222		<p>After the data validation settings have been changed the
223		validation has to be reinserted into the property set.</p>
224
225		@see com::sun::star::sheet::TableValidation
226	 */
227	[property] com::sun::star::beans::XPropertySet Validation;
228
229	//-------------------------------------------------------------------------
230
231	/** contains the data validation settings for this cell,
232		using localized formulas.
233
234		<p>After the data validation settings have been changed the
235		validation has to be reinserted into the property set.</p>
236
237		@see com::sun::star::sheet::TableValidation
238	 */
239	[optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
240
241	//-------------------------------------------------------------------------
242
243	/** Returns the absolute adress of the ranges as string, e.g. "$Sheet1.$B$2:$D$5".
244	 */
245	[optional, readonly, property] string AbsoluteName;
246};
247
248//=============================================================================
249
250}; }; }; };
251
252#endif
253
254