offapi/com/sun/star/sheet/XPrintAreas.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: XPrintAreas.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_XPrintAreas_idl__
  32 #define __com_sun_star_sheet_XPrintAreas_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  39 #include <com/sun/star/table/CellRangeAddress.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** represents a sheet which has print areas.
  49  */
  50 published interface XPrintAreas: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** returns a sequence containing all print areas of the sheet.
  55      */
  56     sequence< com::sun::star::table::CellRangeAddress > getPrintAreas();
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** sets the print areas of the sheet.
  61
  62         <p>If none of the sheets in a document have print areas,
  63         the whole sheets are printed. If any sheet contains print areas,
  64         other sheets without print areas are not printed.</p>
  65
  66         @param aPrintAreas
  67             a sequence containing all print areas for this sheet.
  68      */
  69     void setPrintAreas( [in] sequence< com::sun::star::table::CellRangeAddress > aPrintAreas );
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** returns, whether the title columns are repeated on all subsequent
  74         print pages to the right.
  75      */
  76     boolean getPrintTitleColumns();
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies whether the title columns are repeated on all subsequent
  81         print pages to the right.
  82
  83         @param bPrintTitleColumns
  84             if <TRUE/>, title columns are repeated on each page.
  85      */
  86     void setPrintTitleColumns( [in] boolean bPrintTitleColumns );
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** returns the range that is specified as title columns range.
  91
  92         <p>Title columns can be automatically repeated on all subsequent
  93         print pages to the right, using
  94         <member>XPrintAreas::setPrintTitleColumns</member>.</p>
  95
  96         @returns
  97             the range of columns that is specified as title columns range.
  98      */
  99     com::sun::star::table::CellRangeAddress getTitleColumns();
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** specifies a range of columns as title columns range.
 104
 105         <p>The rows of the passed range are ignored.</p>
 106
 107         <p>Title columns can be automatically repeated on all subsequent
 108         print pages to the right, using
 109         <member>XPrintAreas::setPrintTitleColumns</member>.</p>
 110
 111         @param aTitleColumns
 112             the title columns range.
 113      */
 114     void setTitleColumns( [in] com::sun::star::table::CellRangeAddress aTitleColumns );
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** returns, whether the title rows are repeated on all subsequent
 119         print pages to the bottom.
 120      */
 121     boolean getPrintTitleRows();
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** specifies whether the title rows are repeated on all subsequent
 126         print pages to the bottom.
 127
 128         @param bPrintTitleRows
 129             if <TRUE/>, title rows are repeated on each page.
 130      */
 131     void setPrintTitleRows( [in] boolean bPrintTitleRows );
 132
 133     //-------------------------------------------------------------------------
 134
 135     /** returns the range that is specified as title rows range.
 136
 137         <p>Title rows can be automatically repeated on all subsequent
 138         print pages to the bootom, using
 139         <member>XPrintAreas::setPrintTitleRows</member>.</p>
 140
 141         @returns
 142             the range of rows that is specified as title rows range.
 143      */
 144     com::sun::star::table::CellRangeAddress getTitleRows();
 145
 146     //-------------------------------------------------------------------------
 147
 148     /** specifies a range of rows as title rows range.
 149
 150         <p>The columns of the passed range are ignored.</p>
 151
 152         <p>Title rows can be automatically repeated on all subsequent
 153         print pages to the bottom, using
 154         <member>XPrintAreas::setPrintTitleRows</member>.</p>
 155
 156         @param aTitleRows
 157             the title rows range.
 158      */
 159     void setTitleRows( [in] com::sun::star::table::CellRangeAddress aTitleRows );
 160
 161 };
 162
 163 //=============================================================================
 164
 165 }; }; }; };
 166
 167 #endif
 168