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_Spreadsheet_idl__
25#define __com_sun_star_sheet_Spreadsheet_idl__
26
27#ifndef __com_sun_star_sheet_SheetCellRange_idl__
28#include <com/sun/star/sheet/SheetCellRange.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XSpreadsheet_idl__
32#include <com/sun/star/sheet/XSpreadsheet.idl>
33#endif
34
35#ifndef __com_sun_star_container_XNamed_idl__
36#include <com/sun/star/container/XNamed.idl>
37#endif
38
39#ifndef __com_sun_star_util_XProtectable_idl__
40#include <com/sun/star/util/XProtectable.idl>
41#endif
42
43#ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__
44#include <com/sun/star/sheet/XDataPilotTablesSupplier.idl>
45#endif
46
47#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__
48#include <com/sun/star/sheet/XScenariosSupplier.idl>
49#endif
50
51#ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__
52#include <com/sun/star/sheet/XSheetAnnotationsSupplier.idl>
53#endif
54
55#ifndef __com_sun_star_drawing_XDrawPageSupplier_idl__
56#include <com/sun/star/drawing/XDrawPageSupplier.idl>
57#endif
58
59#ifndef __com_sun_star_table_XTableChartsSupplier_idl__
60#include <com/sun/star/table/XTableChartsSupplier.idl>
61#endif
62
63#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__
64#include <com/sun/star/sheet/XCellRangeMovement.idl>
65#endif
66
67#ifndef __com_sun_star_sheet_XPrintAreas_idl__
68#include <com/sun/star/sheet/XPrintAreas.idl>
69#endif
70
71#ifndef __com_sun_star_sheet_XSheetPageBreak_idl__
72#include <com/sun/star/sheet/XSheetPageBreak.idl>
73#endif
74
75#ifndef __com_sun_star_sheet_XSheetOutline_idl__
76#include <com/sun/star/sheet/XSheetOutline.idl>
77#endif
78
79#ifndef __com_sun_star_sheet_XSheetAuditing_idl__
80#include <com/sun/star/sheet/XSheetAuditing.idl>
81#endif
82
83#ifndef __com_sun_star_sheet_XSheetLinkable_idl__
84#include <com/sun/star/sheet/XSheetLinkable.idl>
85#endif
86
87#ifndef __com_sun_star_sheet_Scenario_idl__
88#include <com/sun/star/sheet/Scenario.idl>
89#endif
90
91#ifndef __com_sun_star_sheet_XExternalSheetName_idl__
92#include <com/sun/star/sheet/XExternalSheetName.idl>
93#endif
94
95#include <com/sun/star/util/Color.idl>
96
97//=============================================================================
98
99module com {  module sun {  module star {  module sheet {
100
101//=============================================================================
102
103/** represents a complete spreadsheet in a spreadsheet document.
104
105	<p>This service extents the service SheetCellRange. A spreadsheet is
106	nothing else than a cell range with extended functionality.</p>
107
108	@see com::sun::star::sheet::SpreadsheetDocument
109 */
110service Spreadsheet
111{
112	//-------------------------------------------------------------------------
113
114	/** provides functionality for cell range handling.
115	 */
116	service com::sun::star::sheet::SheetCellRange;
117
118	//=========================================================================
119
120    service com::sun::star::sheet::Scenario;
121
122	//=========================================================================
123
124	/** provides methods to create a cell cursor.
125	 */
126	interface com::sun::star::sheet::XSpreadsheet;
127
128	//-------------------------------------------------------------------------
129
130	/** provides accessing the spreadsheet name.
131	 */
132	interface com::sun::star::container::XNamed;
133
134	//-------------------------------------------------------------------------
135
136	/** provides methods to protect and unprotect the sheet contents.
137	 */
138	interface com::sun::star::util::XProtectable;
139
140	//-------------------------------------------------------------------------
141
142	/** provides access to the collection of DataPilot tables.
143	 */
144	interface com::sun::star::sheet::XDataPilotTablesSupplier;
145
146	//-------------------------------------------------------------------------
147
148	/** provides access to the collection of scenarios.
149	 */
150	interface com::sun::star::sheet::XScenariosSupplier;
151
152    	//-------------------------------------------------------------------------
153
154	/** provides access to the collection of annotations.
155	 */
156	interface com::sun::star::sheet::XSheetAnnotationsSupplier;
157
158	//-------------------------------------------------------------------------
159
160	/** provides access to the draw page of this spreadsheet.
161	 */
162	interface com::sun::star::drawing::XDrawPageSupplier;
163
164	//-------------------------------------------------------------------------
165
166	/** provides access to the collection of chart objects.
167	 */
168	interface com::sun::star::table::XTableChartsSupplier;
169
170	//-------------------------------------------------------------------------
171
172	/** provides methods to move cell ranges inside the spreadsheet or to
173		other spreadsheets in this document.
174	 */
175	interface com::sun::star::sheet::XCellRangeMovement;
176
177	//-------------------------------------------------------------------------
178
179	/** provides access to the print area settings of this sheet.
180	 */
181	interface com::sun::star::sheet::XPrintAreas;
182
183	//-------------------------------------------------------------------------
184
185	/** provides access to the page breaks of this sheet.
186	 */
187	interface com::sun::star::sheet::XSheetPageBreak;
188
189	//-------------------------------------------------------------------------
190
191	/** provides access to row and column outline settings.
192	 */
193	interface com::sun::star::sheet::XSheetOutline;
194
195	//-------------------------------------------------------------------------
196
197	/** provides access to the auditing (detective) functionality.
198	 */
199	interface com::sun::star::sheet::XSheetAuditing;
200
201	//-------------------------------------------------------------------------
202
203	/** provides methods for a linked sheet.
204	 */
205	interface com::sun::star::sheet::XSheetLinkable;
206
207    //-------------------------------------------------------------------------
208
209    /** provides a method to set an external name at the sheet.
210
211        @since OpenOffice 3.0
212     */
213    [optional] interface com::sun::star::sheet::XExternalSheetName;
214
215    //=========================================================================
216
217	/** specifies if the sheet is visible.
218	 */
219	[property] boolean IsVisible;
220
221	//-------------------------------------------------------------------------
222
223	/** specifies the page style of the sheet.
224	 */
225	[property] string PageStyle;
226
227	//-------------------------------------------------------------------------
228
229	/** specifies the direction of the columns in the spreadsheet.
230
231	    <p>Possible values are com::sun::star::text::WritingMode2::LR_TB to
232	    order the columns from left to right, and
233            com::sun::star::text::WritingMode2::RL_TB to order the columns from
234	    right to left.</p>
235
236	    @see com::sun::star::text::WritingMode2
237	 */
238	[optional, property] short TableLayout;
239
240	//-------------------------------------------------------------------------
241
242	/** specifies whether the sheet has an automatic print area.
243
244    <p> The automatic print area is used to print a sheet without
245        explicit print areas, also if other sheets have print areas.</p>
246
247    <p> If the property is true, and there are print areas on other sheets,
248        the used area of this sheet is also printed.</p>
249
250    <p> If the property is false, and there are print areas on other sheets,
251        only these specified print areas are printed.</p>
252
253    <p> If there are no print areas on the other sheets it does not matter
254        whether property is true or false.</p>
255
256	<p> This property can only be true, if there are no print areas given
257        on this sheet. If the property is set to true the print areas of
258        this sheet will be removed.</p>
259
260        @see XPrintAreas
261
262	 */
263	[optional, property] boolean AutomaticPrintArea;
264
265    /** specifies the color of the sheet tab, if any.
266     */
267    [optional, property] com::sun::star::util::Color TabColor;
268};
269
270//=============================================================================
271
272}; }; }; };
273
274#endif
275
276