summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/TablePageStyle.idl
blob: 686fb113d62c117ff3b1dbb3a6eca2d890c186ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_TablePageStyle_idl__
#define __com_sun_star_sheet_TablePageStyle_idl__

#ifndef __com_sun_star_style_PageStyle_idl__
#include <com/sun/star/style/PageStyle.idl>
#endif

#ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__
#include <com/sun/star/sheet/XHeaderFooterContent.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module sheet {

//=============================================================================

/** represents a page style for a spreadsheet.

    <p>This service extends the service
    <type scope="com::sun::star::style">PageStyle</type> with spreadsheet
    specific properties.</p>
 */
published service TablePageStyle
{
    //-------------------------------------------------------------------------

    /** contains all common page style properties.
     */
    service com::sun::star::style::PageStyle;

    //=========================================================================

    /** determines whether the table is centered horizontally on the page.
     */
    [property] boolean CenterHorizontally;

    //-------------------------------------------------------------------------

    /** determines whether the table is centered vertically on the page.
     */
    [property] boolean CenterVertically;

    //-------------------------------------------------------------------------

    /** enables printing of cell annotations.
     */
    [property] boolean PrintAnnotations;

    //-------------------------------------------------------------------------

    /** enables printing of the cell grid.
     */
    [property] boolean PrintGrid;

    //-------------------------------------------------------------------------

    /** enables printing of column and row headers.
     */
    [property] boolean PrintHeaders;

    //-------------------------------------------------------------------------

    /** enables printing of charts.
     */
    [property] boolean PrintCharts;

    //-------------------------------------------------------------------------

    /** enables printing of embedded objects.
     */
    [property] boolean PrintObjects;

    //-------------------------------------------------------------------------

    /** enables printing of drawing objects.
     */
    [property] boolean PrintDrawing;

    //-------------------------------------------------------------------------

    /** enables printing of formulas instead of their results.
     */
    [property] boolean PrintFormulas;

    //-------------------------------------------------------------------------

    /** enables printing of zero-values.
     */
    [property] boolean PrintZeroValues;

    //-------------------------------------------------------------------------

    /** specifies the print order for the pages within each sheet.

        <p>If <TRUE/>, the order for printing pages begins with
        top-to-bottom, then continues with the next set of cell columns
        to the right. If <FALSE/>, the order for printing pages begins
        with left-to-right, then continues with the next set of cell
        rows to the bottom.</p>
     */
    [property] boolean PrintDownFirst;

    //-------------------------------------------------------------------------

    /** contains the content of the header for left pages.

        <p>After changing the header text contents, this property has to be
        reinserted into the property set.</p>

        @see com::sun::star::sheet::HeaderFooterContent
     */
    [property] com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent;

    //-------------------------------------------------------------------------

    /** contains the content of the footer for left pages.

        <p>After changing the footer text contents, this property has to be
        reinserted into the property set.</p>

        @see com::sun::star::sheet::HeaderFooterContent
     */
    [property] com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent;

    //-------------------------------------------------------------------------

    /** contains the content of the header for right pages.

        <p>After changing the header text contents, this property has to be
        reinserted into the property set.</p>

        @see com::sun::star::sheet::HeaderFooterContent
     */
    [property] com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent;

    //-------------------------------------------------------------------------

    /** contains the content of the footer for right pages.

        <p>After changing the footer text contents, this property has to be
        reinserted into the property set.</p>

        @see com::sun::star::sheet::HeaderFooterContent
     */
    [property] com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent;

    //-------------------------------------------------------------------------

    /** contains the page number applied to the first page for this sheet.

        <p>The value 0 indicates that the page numbers are continued from
        the previous sheet.</p>
     */
    [property] short FirstPageNumber;

    //-------------------------------------------------------------------------

    /** contains the scaling factor (in percent) for printing the sheet.
     */
    [property] short PageScale;

    //-------------------------------------------------------------------------

    /** contains the number of pages the sheet will printed.
     */
    [property] short ScaleToPages;

    //-------------------------------------------------------------------------

    /** contains the number of horizontal pages the sheet will printed on.

    @since OOo 2.0

     */
    [property, optional] short ScaleToPagesX;

    //-------------------------------------------------------------------------

    /** contains the number of vertical pages the sheet will printed on.

    @since OOo 2.0

     */
    [property, optional] short ScaleToPagesY;

};

//=============================================================================

}; }; }; };

#endif