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_SpreadsheetDocument_idl__
25#define __com_sun_star_sheet_SpreadsheetDocument_idl__
26
27#ifndef __com_sun_star_document_OfficeDocument_idl__
28#include <com/sun/star/document/OfficeDocument.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__
32#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl>
33#endif
34
35
36#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
37#include <com/sun/star/lang/XMultiServiceFactory.idl>
38#endif
39
40#ifndef __com_sun_star_frame_XModel_idl__
41#include <com/sun/star/frame/XModel.idl>
42#endif
43
44#ifndef __com_sun_star_document_XActionLockable_idl__
45#include <com/sun/star/document/XActionLockable.idl>
46#endif
47
48#ifndef __com_sun_star_document_XLinkTargetSupplier_idl__
49#include <com/sun/star/document/XLinkTargetSupplier.idl>
50#endif
51
52#ifndef __com_sun_star_util_XProtectable_idl__
53#include <com/sun/star/util/XProtectable.idl>
54#endif
55
56#ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__
57#include <com/sun/star/sheet/XSpreadsheetDocument.idl>
58#endif
59
60#ifndef __com_sun_star_sheet_XCalculatable_idl__
61#include <com/sun/star/sheet/XCalculatable.idl>
62#endif
63
64#ifndef __com_sun_star_sheet_XDocumentAuditing_idl__
65#include <com/sun/star/sheet/XDocumentAuditing.idl>
66#endif
67
68#ifndef __com_sun_star_sheet_XConsolidatable_idl__
69#include <com/sun/star/sheet/XConsolidatable.idl>
70#endif
71
72#ifndef __com_sun_star_sheet_XGoalSeek_idl__
73#include <com/sun/star/sheet/XGoalSeek.idl>
74#endif
75
76#ifndef __com_sun_star_drawing_XDrawPagesSupplier_idl__
77#include <com/sun/star/drawing/XDrawPagesSupplier.idl>
78#endif
79
80#ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__
81#include <com/sun/star/style/XStyleFamiliesSupplier.idl>
82#endif
83
84#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
85#include <com/sun/star/util/XNumberFormatsSupplier.idl>
86#endif
87
88
89#ifndef __com_sun_star_sheet_XNamedRanges_idl__
90#include <com/sun/star/sheet/XNamedRanges.idl>
91#endif
92
93#ifndef __com_sun_star_sheet_XDatabaseRanges_idl__
94#include <com/sun/star/sheet/XDatabaseRanges.idl>
95#endif
96
97#ifndef __com_sun_star_sheet_XLabelRanges_idl__
98#include <com/sun/star/sheet/XLabelRanges.idl>
99#endif
100
101#ifndef __com_sun_star_container_XNameAccess_idl__
102#include <com/sun/star/container/XNameAccess.idl>
103#endif
104
105#ifndef __com_sun_star_sheet_XAreaLinks_idl__
106#include <com/sun/star/sheet/XAreaLinks.idl>
107#endif
108
109#ifndef __com_sun_star_sheet_XExternalDocLinks_idl__
110#include <com/sun/star/sheet/XExternalDocLinks.idl>
111#endif
112
113//=============================================================================
114
115module com {  module sun {  module star {  module sheet {
116
117//=============================================================================
118
119/** represents a model component which consists of some settings and
120	one or more spreadsheets.
121 */
122published service SpreadsheetDocument
123{
124	//-------------------------------------------------------------------------
125
126	/** common service for all types of documents.
127	 */
128	service com::sun::star::document::OfficeDocument;
129
130	//-------------------------------------------------------------------------
131
132	/** contributes spreadsheet document specific properties.
133
134	@deprecated
135	 */
136	[optional] service com::sun::star::sheet::SpreadsheetDocumentSettings;
137
138	//=========================================================================
139
140	/** provides methods to create instances of several spreadsheet
141		services.
142	 */
143	interface com::sun::star::lang::XMultiServiceFactory;
144
145	//-------------------------------------------------------------------------
146
147	/** provides common methods for a document model.
148
149		<p>This interface is derived from
150		<type scope="com::sun::star::lang">XComponent</type>.</p>
151	 */
152	interface com::sun::star::frame::XModel;
153
154	//-------------------------------------------------------------------------
155
156	/** provides methods to control the automatic update of cell contents.
157	 */
158	interface com::sun::star::document::XActionLockable;
159
160	//-------------------------------------------------------------------------
161
162	/** provides access to the collection of link targets available in
163		the document.
164	 */
165	interface com::sun::star::document::XLinkTargetSupplier;
166
167	//-------------------------------------------------------------------------
168
169	/** provides methods to protect and unprotect the document.
170	 */
171	interface com::sun::star::util::XProtectable;
172
173	//-------------------------------------------------------------------------
174
175	/** provides access to the collection of spreadsheets.
176	 */
177	interface com::sun::star::sheet::XSpreadsheetDocument;
178
179	//-------------------------------------------------------------------------
180
181	/** controls the recalculation settings of the document.
182	 */
183	interface com::sun::star::sheet::XCalculatable;
184
185	//-------------------------------------------------------------------------
186
187	/** provides a method to refresh all auditing arrows.
188	 */
189	interface com::sun::star::sheet::XDocumentAuditing;
190
191	//-------------------------------------------------------------------------
192
193	/** provides methods to perform a data consolidation.
194	 */
195	interface com::sun::star::sheet::XConsolidatable;
196
197	//-------------------------------------------------------------------------
198
199	/** provides a method to perform a goal seek.
200	 */
201	interface com::sun::star::sheet::XGoalSeek;
202
203	//-------------------------------------------------------------------------
204
205	/** provides access to the collection of draw pages of this document.
206	 */
207	interface com::sun::star::drawing::XDrawPagesSupplier;
208
209	//-------------------------------------------------------------------------
210
211	/** provides access to the collection of style families.
212
213		<p>A spreadsheet document contains 2 families of styles:
214		"PageStyles" and "CellStyles".</p>
215	 */
216	interface com::sun::star::style::XStyleFamiliesSupplier;
217
218	//-------------------------------------------------------------------------
219
220	/** provides access to the collection of number formats contained in
221		the document.
222	 */
223	interface com::sun::star::util::XNumberFormatsSupplier;
224
225	//=========================================================================
226
227	/** contains the collection of named ranges in the document.
228	 */
229	[readonly, property] com::sun::star::sheet::XNamedRanges NamedRanges;
230
231	//-------------------------------------------------------------------------
232
233	/** contains the collection of database ranges in the document.
234	 */
235	[readonly, property] com::sun::star::sheet::XDatabaseRanges DatabaseRanges;
236
237	//-------------------------------------------------------------------------
238
239	/** contains the collection of column label ranges in the document.
240	 */
241	[readonly, property] com::sun::star::sheet::XLabelRanges ColumnLabelRanges;
242
243	//-------------------------------------------------------------------------
244
245	/** contains the collection of row label ranges in the document.
246	 */
247	[readonly, property] com::sun::star::sheet::XLabelRanges RowLabelRanges;
248
249	//-------------------------------------------------------------------------
250
251	/** contains the collection of sheet links in the document.
252	 */
253	[readonly, property] com::sun::star::container::XNameAccess SheetLinks;
254
255	//-------------------------------------------------------------------------
256
257	/** contains the collection of area links in the document.
258	 */
259	[readonly, property] com::sun::star::sheet::XAreaLinks AreaLinks;
260
261	//-------------------------------------------------------------------------
262
263	/** contains the collection of DDE links in the document.
264	 */
265	[readonly, property] com::sun::star::container::XNameAccess DDELinks;
266
267    //-------------------------------------------------------------------------
268
269#if 0
270    /** contains the collection of external document links in the document.
271
272        @since OOo 3.1
273     */
274    [optional, readonly, property] com::sun::star::sheet::XExternalDocLinks ExternalDocLinks;
275#endif
276
277};
278
279//=============================================================================
280
281}; }; }; };
282
283#endif
284
285