LibreOffice LibreOffice 6.2 SDK API Reference

Spreadsheet.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef __com_sun_star_sheet_Spreadsheet_idl__
21 #define __com_sun_star_sheet_Spreadsheet_idl__
22
23 #include <com/sun/star/sheet/SheetCellRange.idl>
24 #include <com/sun/star/sheet/XSpreadsheet.idl>
25 #include <com/sun/star/container/XNamed.idl>
26 #include <com/sun/star/util/XProtectable.idl>
27 #include <com/sun/star/sheet/XDataPilotTablesSupplier.idl>
28 #include <com/sun/star/sheet/XScenariosSupplier.idl>
29 #include <com/sun/star/sheet/XSheetAnnotationsSupplier.idl>
30 #include <com/sun/star/drawing/XDrawPageSupplier.idl>
31 #include <com/sun/star/table/XTableChartsSupplier.idl>
32 #include <com/sun/star/sheet/XCellRangeMovement.idl>
33 #include <com/sun/star/sheet/XPrintAreas.idl>
34 #include <com/sun/star/sheet/XSheetPageBreak.idl>
35 #include <com/sun/star/sheet/XSheetOutline.idl>
36 #include <com/sun/star/sheet/XSheetAuditing.idl>
37 #include <com/sun/star/sheet/XSheetLinkable.idl>
38 #include <com/sun/star/sheet/Scenario.idl>
39 #include <com/sun/star/sheet/XExternalSheetName.idl>
40 #include <com/sun/star/sheet/XConditionalFormats.idl>
41 #include <com/sun/star/util/Color.idl>
42
43
44 module com { module sun { module star { module sheet {
45
46
54 service Spreadsheet
55 {
56
59 service com::sun::star::sheet::SheetCellRange;
60
61
62 service com::sun::star::sheet::Scenario;
63
64
67 interface com::sun::star::sheet::XSpreadsheet;
68
69
72 interface com::sun::star::container::XNamed;
73
74
77 interface com::sun::star::util::XProtectable;
78
79
82 interface com::sun::star::sheet::XDataPilotTablesSupplier;
83
84
87 interface com::sun::star::sheet::XScenariosSupplier;
88
89
92 interface com::sun::star::sheet::XSheetAnnotationsSupplier;
93
94
97 interface com::sun::star::drawing::XDrawPageSupplier;
98
99
102 interface com::sun::star::table::XTableChartsSupplier;
103
104
108 interface com::sun::star::sheet::XCellRangeMovement;
109
110
113 interface com::sun::star::sheet::XPrintAreas;
114
115
118 interface com::sun::star::sheet::XSheetPageBreak;
119
120
123 interface com::sun::star::sheet::XSheetOutline;
124
125
128 interface com::sun::star::sheet::XSheetAuditing;
129
130
133 interface com::sun::star::sheet::XSheetLinkable;
134
135
140 [optional] interface com::sun::star::sheet::XExternalSheetName;
141
142
145 [property] boolean IsVisible;
146
147
150 [property] string PageStyle;
151
152
162 [optional, property] short TableLayout;
163
164
186 [optional, property] boolean AutomaticPrintArea;
187
190 [optional, property] com::sun::star::util::Color TabColor;
191
194 [optional, property] com::sun::star::sheet::XConditionalFormats ConditionalFormats;
195 };
196
197
198 }; }; }; };
199
200 #endif
201
202 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sheet::XDataPilotTablesSupplier
grants access to a collection of data pilot tables.
Definition: XDataPilotTablesSupplier.idl:34
com::sun::star::sheet::XExternalSheetName
provides a method to set an external name at the sheet.
Definition: XExternalSheetName.idl:39
com::sun::star::container::XNamed
specifies the name of the object.
Definition: XNamed.idl:32
XDrawPageSupplier.idl
com::sun::star::sheet::Spreadsheet
represents a complete spreadsheet in a spreadsheet document.
Definition: Spreadsheet.idl:54
com::sun::star::sheet::XSheetAuditing
provides methods to access auditing (detective) features in a spreadsheet.
Definition: XSheetAuditing.idl:33
com::sun::star::sheet::XScenariosSupplier
provides access to a collection of scenarios.
Definition: XScenariosSupplier.idl:32
com::sun::star::sheet::XPrintAreas
represents a sheet which has print areas.
Definition: XPrintAreas.idl:32
XSheetPageBreak.idl
com::sun::star::sheet::XConditionalFormats
Definition: XConditionalFormats.idl:19
com
Definition: Ambiguous.idl:22
SheetCellRange.idl
XSheetAnnotationsSupplier.idl
com::sun::star::drawing::XDrawPageSupplier
represents something that provides a DrawPage.
Definition: XDrawPageSupplier.idl:39
XTableChartsSupplier.idl
Scenario.idl
com::sun::star::util::XProtectable
makes it possible to protect objects from modifications.
Definition: XProtectable.idl:33
com::sun::star::sheet::Spreadsheet::IsVisible
boolean IsVisible
specifies if the sheet is visible.
Definition: Spreadsheet.idl:140
XSheetAuditing.idl
XProtectable.idl
com::sun::star::sheet::Scenario
represents a scenario in a spreadsheet document.
Definition: Scenario.idl:35
XNamed.idl
com::sun::star::sheet::XSpreadsheet
provides methods to create a cell range cursor.
Definition: XSpreadsheet.idl:34
com::sun::star::sheet::XSheetAnnotationsSupplier
provides access to a collection of cell annotations.
Definition: XSheetAnnotationsSupplier.idl:32
XCellRangeMovement.idl
XExternalSheetName.idl
XSpreadsheet.idl
XScenariosSupplier.idl
com::sun::star::sheet::XCellRangeMovement
provides methods for moving ranges of cells in a sheet.
Definition: XCellRangeMovement.idl:35
com::sun::star::sheet::Spreadsheet::PageStyle
string PageStyle
specifies the page style of the sheet.
Definition: Spreadsheet.idl:150
XConditionalFormats.idl
XSheetLinkable.idl
XDataPilotTablesSupplier.idl
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
XSheetOutline.idl
Color.idl
com::sun::star::sheet::XSheetPageBreak
provides access to page breaks in a sheet.
Definition: XSheetPageBreak.idl:34
XPrintAreas.idl
com::sun::star::sheet::XSheetLinkable
enables a sheet to refer to another sheet in a different document.
Definition: XSheetLinkable.idl:42
com::sun::star::sheet::SheetCellRange
represents a rectangular range of cells in a spreadsheet document.
Definition: SheetCellRange.idl:70
com::sun::star::sheet::Spreadsheet::AutomaticPrintArea
boolean AutomaticPrintArea
specifies whether the sheet has an automatic print area.
Definition: Spreadsheet.idl:186
com::sun::star::sheet::XSheetOutline
provides methods to access the outlines of a sheet.
Definition: XSheetOutline.idl:33
com::sun::star::table::XTableChartsSupplier
provides a method to access a collection of charts in a table or spreadsheet.
Definition: XTableChartsSupplier.idl:33
com::sun::star::sheet::Spreadsheet::ConditionalFormats
com::sun::star::sheet::XConditionalFormats ConditionalFormats
specifies all conditional formats of that sheet
Definition: Spreadsheet.idl:194
com::sun::star::sheet::Spreadsheet::TabColor
com::sun::star::util::Color TabColor
specifies the color of the sheet tab, if any.
Definition: Spreadsheet.idl:190
com::sun::star::sheet::Spreadsheet::TableLayout
short TableLayout
specifies the direction of the columns in the spreadsheet.
Definition: Spreadsheet.idl:162