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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XPrintAreas_idl__
  29 #define __com_sun_star_sheet_XPrintAreas_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  36 #include <com/sun/star/table/CellRangeAddress.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** represents a sheet which has print areas.
  46  */
  47 published interface XPrintAreas: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** returns a sequence containing all print areas of the sheet.
  52      */
  53     sequence< com::sun::star::table::CellRangeAddress > getPrintAreas();
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** sets the print areas of the sheet.
  58
  59         <p>If none of the sheets in a document have print areas,
  60         the whole sheets are printed. If any sheet contains print areas,
  61         other sheets without print areas are not printed.</p>
  62
  63         @param aPrintAreas
  64             a sequence containing all print areas for this sheet.
  65      */
  66     void setPrintAreas( [in] sequence< com::sun::star::table::CellRangeAddress > aPrintAreas );
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** returns, whether the title columns are repeated on all subsequent
  71         print pages to the right.
  72      */
  73     boolean getPrintTitleColumns();
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** specifies whether the title columns are repeated on all subsequent
  78         print pages to the right.
  79
  80         @param bPrintTitleColumns
  81             if <TRUE/>, title columns are repeated on each page.
  82      */
  83     void setPrintTitleColumns( [in] boolean bPrintTitleColumns );
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** returns the range that is specified as title columns range.
  88
  89         <p>Title columns can be automatically repeated on all subsequent
  90         print pages to the right, using
  91         <member>XPrintAreas::setPrintTitleColumns</member>.</p>
  92
  93         @returns
  94             the range of columns that is specified as title columns range.
  95      */
  96     com::sun::star::table::CellRangeAddress getTitleColumns();
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** specifies a range of columns as title columns range.
 101
 102         <p>The rows of the passed range are ignored.</p>
 103
 104         <p>Title columns can be automatically repeated on all subsequent
 105         print pages to the right, using
 106         <member>XPrintAreas::setPrintTitleColumns</member>.</p>
 107
 108         @param aTitleColumns
 109             the title columns range.
 110      */
 111     void setTitleColumns( [in] com::sun::star::table::CellRangeAddress aTitleColumns );
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** returns, whether the title rows are repeated on all subsequent
 116         print pages to the bottom.
 117      */
 118     boolean getPrintTitleRows();
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** specifies whether the title rows are repeated on all subsequent
 123         print pages to the bottom.
 124
 125         @param bPrintTitleRows
 126             if <TRUE/>, title rows are repeated on each page.
 127      */
 128     void setPrintTitleRows( [in] boolean bPrintTitleRows );
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** returns the range that is specified as title rows range.
 133
 134         <p>Title rows can be automatically repeated on all subsequent
 135         print pages to the bootom, using
 136         <member>XPrintAreas::setPrintTitleRows</member>.</p>
 137
 138         @returns
 139             the range of rows that is specified as title rows range.
 140      */
 141     com::sun::star::table::CellRangeAddress getTitleRows();
 142
 143     //-------------------------------------------------------------------------
 144
 145     /** specifies a range of rows as title rows range.
 146
 147         <p>The columns of the passed range are ignored.</p>
 148
 149         <p>Title rows can be automatically repeated on all subsequent
 150         print pages to the bottom, using
 151         <member>XPrintAreas::setPrintTitleRows</member>.</p>
 152
 153         @param aTitleRows
 154             the title rows range.
 155      */
 156     void setTitleRows( [in] com::sun::star::table::CellRangeAddress aTitleRows );
 157
 158 };
 159
 160 //=============================================================================
 161
 162 }; }; }; };
 163
 164 #endif
 165