xref: /AOO41X/main/offapi/com/sun/star/sheet/TablePageStyle.idl (revision fbef625e460ef3feded438b39e36a4c8f360d8f1)
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_TablePageStyle_idl__
25#define __com_sun_star_sheet_TablePageStyle_idl__
26
27#ifndef __com_sun_star_style_PageStyle_idl__
28#include <com/sun/star/style/PageStyle.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__
32#include <com/sun/star/sheet/XHeaderFooterContent.idl>
33#endif
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** represents a page style for a spreadsheet.
42
43    <p>This service extends the service
44    <type scope="com::sun::star::style">PageStyle</type> with spreadsheet
45    specific properties.</p>
46 */
47published service TablePageStyle
48{
49    //-------------------------------------------------------------------------
50
51    /** contains all common page style properties.
52     */
53    service com::sun::star::style::PageStyle;
54
55    //=========================================================================
56
57    /** determines whether the table is centered horizontally on the page.
58     */
59    [property] boolean CenterHorizontally;
60
61    //-------------------------------------------------------------------------
62
63    /** determines whether the table is centered vertically on the page.
64     */
65    [property] boolean CenterVertically;
66
67    //-------------------------------------------------------------------------
68
69    /** enables printing of cell annotations.
70     */
71    [property] boolean PrintAnnotations;
72
73    //-------------------------------------------------------------------------
74
75    /** enables printing of the cell grid.
76     */
77    [property] boolean PrintGrid;
78
79    //-------------------------------------------------------------------------
80
81    /** enables printing of column and row headers.
82     */
83    [property] boolean PrintHeaders;
84
85    //-------------------------------------------------------------------------
86
87    /** enables printing of charts.
88     */
89    [property] boolean PrintCharts;
90
91    //-------------------------------------------------------------------------
92
93    /** enables printing of embedded objects.
94     */
95    [property] boolean PrintObjects;
96
97    //-------------------------------------------------------------------------
98
99    /** enables printing of drawing objects.
100     */
101    [property] boolean PrintDrawing;
102
103    //-------------------------------------------------------------------------
104
105    /** enables printing of formulas instead of their results.
106     */
107    [property] boolean PrintFormulas;
108
109    //-------------------------------------------------------------------------
110
111    /** enables printing of zero-values.
112     */
113    [property] boolean PrintZeroValues;
114
115    //-------------------------------------------------------------------------
116
117    /** specifies the print order for the pages within each sheet.
118
119        <p>If <TRUE/>, the order for printing pages begins with
120        top-to-bottom, then continues with the next set of cell columns
121        to the right. If <FALSE/>, the order for printing pages begins
122        with left-to-right, then continues with the next set of cell
123        rows to the bottom.</p>
124     */
125    [property] boolean PrintDownFirst;
126
127    //-------------------------------------------------------------------------
128
129    /** contains the content of the header for left pages.
130
131        <p>After changing the header text contents, this property has to be
132        reinserted into the property set.</p>
133
134        @see com::sun::star::sheet::HeaderFooterContent
135     */
136    [property] com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent;
137
138    //-------------------------------------------------------------------------
139
140    /** contains the content of the footer for left pages.
141
142        <p>After changing the footer text contents, this property has to be
143        reinserted into the property set.</p>
144
145        @see com::sun::star::sheet::HeaderFooterContent
146     */
147    [property] com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent;
148
149    //-------------------------------------------------------------------------
150
151    /** contains the content of the header for right pages.
152
153        <p>After changing the header text contents, this property has to be
154        reinserted into the property set.</p>
155
156        @see com::sun::star::sheet::HeaderFooterContent
157     */
158    [property] com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent;
159
160    //-------------------------------------------------------------------------
161
162    /** contains the content of the footer for right pages.
163
164        <p>After changing the footer text contents, this property has to be
165        reinserted into the property set.</p>
166
167        @see com::sun::star::sheet::HeaderFooterContent
168     */
169    [property] com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent;
170
171    //-------------------------------------------------------------------------
172
173    /** contains the page number applied to the first page for this sheet.
174
175        <p>The value 0 indicates that the page numbers are continued from
176        the previous sheet.</p>
177     */
178    [property] short FirstPageNumber;
179
180    //-------------------------------------------------------------------------
181
182    /** contains the scaling factor (in percent) for printing the sheet.
183     */
184    [property] short PageScale;
185
186    //-------------------------------------------------------------------------
187
188    /** contains the number of pages the sheet will printed.
189     */
190    [property] short ScaleToPages;
191
192    //-------------------------------------------------------------------------
193
194    /** contains the number of horizontal pages the sheet will printed on.
195
196    @since OpenOffice 2.0
197
198     */
199    [property, optional] short ScaleToPagesX;
200
201    //-------------------------------------------------------------------------
202
203    /** contains the number of vertical pages the sheet will printed on.
204
205    @since OpenOffice 2.0
206
207     */
208    [property, optional] short ScaleToPagesY;
209
210};
211
212//=============================================================================
213
214}; }; }; };
215
216#endif
217
218