offapi/com/sun/star/sheet/TablePageStyle.idl

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