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