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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: TablePageStyle.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_TablePageStyle_idl__
  32 #define __com_sun_star_sheet_TablePageStyle_idl__
  33
  34 #ifndef __com_sun_star_style_PageStyle_idl__
  35 #include <com/sun/star/style/PageStyle.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__
  39 #include <com/sun/star/sheet/XHeaderFooterContent.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** represents a page style for a spreadsheet.
  49
  50     <p>This service extends the service
  51     <type scope="com::sun::star::style">PageStyle</type> with spreadsheet
  52     specific properties.</p>
  53  */
  54 published service TablePageStyle
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** contains all common page style properties.
  59      */
  60     service com::sun::star::style::PageStyle;
  61
  62     //=========================================================================
  63
  64     /** determines whether the table is centered horizontally on the page.
  65      */
  66     [property] boolean CenterHorizontally;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** determines whether the table is centered vertically on the page.
  71      */
  72     [property] boolean CenterVertically;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** enables printing of cell annotations.
  77      */
  78     [property] boolean PrintAnnotations;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** enables printing of the cell grid.
  83      */
  84     [property] boolean PrintGrid;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** enables printing of column and row headers.
  89      */
  90     [property] boolean PrintHeaders;
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** enables printing of charts.
  95      */
  96     [property] boolean PrintCharts;
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** enables printing of embedded objects.
 101      */
 102     [property] boolean PrintObjects;
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** enables printing of drawing objects.
 107      */
 108     [property] boolean PrintDrawing;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** enables printing of formulas instead of their results.
 113      */
 114     [property] boolean PrintFormulas;
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** enables printing of zero-values.
 119      */
 120     [property] boolean PrintZeroValues;
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** specifies the print order for the pages within each sheet.
 125
 126         <p>If <TRUE/>, the order for printing pages begins with
 127         top-to-bottom, then continues with the next set of cell columns
 128         to the right. If <FALSE/>, the order for printing pages begins
 129         with left-to-right, then continues with the next set of cell
 130         rows to the bottom.</p>
 131      */
 132     [property] boolean PrintDownFirst;
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** contains the content of the header for left pages.
 137
 138         <p>After changing the header text contents, this property has to be
 139         reinserted into the property set.</p>
 140
 141         @see com::sun::star::sheet::HeaderFooterContent
 142      */
 143     [property] com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent;
 144
 145     //-------------------------------------------------------------------------
 146
 147     /** contains the content of the footer for left pages.
 148
 149         <p>After changing the footer text contents, this property has to be
 150         reinserted into the property set.</p>
 151
 152         @see com::sun::star::sheet::HeaderFooterContent
 153      */
 154     [property] com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent;
 155
 156     //-------------------------------------------------------------------------
 157
 158     /** contains the content of the header for right pages.
 159
 160         <p>After changing the header text contents, this property has to be
 161         reinserted into the property set.</p>
 162
 163         @see com::sun::star::sheet::HeaderFooterContent
 164      */
 165     [property] com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent;
 166
 167     //-------------------------------------------------------------------------
 168
 169     /** contains the content of the footer for right pages.
 170
 171         <p>After changing the footer text contents, this property has to be
 172         reinserted into the property set.</p>
 173
 174         @see com::sun::star::sheet::HeaderFooterContent
 175      */
 176     [property] com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent;
 177
 178     //-------------------------------------------------------------------------
 179
 180     /** contains the page number applied to the first page for this sheet.
 181
 182         <p>The value 0 indicates that the page numbers are continued from
 183         the previous sheet.</p>
 184      */
 185     [property] short FirstPageNumber;
 186
 187     //-------------------------------------------------------------------------
 188
 189     /** contains the scaling factor (in percent) for printing the sheet.
 190      */
 191     [property] short PageScale;
 192
 193     //-------------------------------------------------------------------------
 194
 195     /** contains the number of pages the sheet will printed.
 196      */
 197     [property] short ScaleToPages;
 198
 199     //-------------------------------------------------------------------------
 200
 201     /** contains the number of horizontal pages the sheet will printed on.
 202
 203     @since OOo 2.0.0
 204
 205      */
 206     [property, optional] short ScaleToPagesX;
 207
 208     //-------------------------------------------------------------------------
 209
 210     /** contains the number of vertical pages the sheet will printed on.
 211
 212     @since OOo 2.0.0
 213
 214      */
 215     [property, optional] short ScaleToPagesY;
 216
 217 };
 218
 219 //=============================================================================
 220
 221 }; }; }; };
 222
 223 #endif
 224