office-gobmx/offapi/com/sun/star/sheet/XPrintAreas.idl
Oliver Bolte 6d76ea1fb3 INTEGRATION: CWS sb18 (1.7.160); FILE MERGED
2004/05/21 15:03:26 sb 1.7.160.1: #i21150# Added published flag.
2004-06-03 22:10:04 +00:00

199 lines
7 KiB
Text

/*************************************************************************
*
* $RCSfile: XPrintAreas.idl,v $
*
* $Revision: 1.8 $
*
* last change: $Author: obo $ $Date: 2004-06-03 23:10:04 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_sheet_XPrintAreas_idl__
#define __com_sun_star_sheet_XPrintAreas_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** represents a sheet which has print areas.
*/
published interface XPrintAreas: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** returns a sequence containing all print areas of the sheet.
*/
sequence< com::sun::star::table::CellRangeAddress > getPrintAreas();
//-------------------------------------------------------------------------
/** sets the print areas of the sheet.
<p>If none of the sheets in a document have print areas,
the whole sheets are printed. If any sheet contains print areas,
other sheets without print areas are not printed.</p>
@param aPrintAreas
a sequence containing all print areas for this sheet.
*/
void setPrintAreas( [in] sequence< com::sun::star::table::CellRangeAddress > aPrintAreas );
//-------------------------------------------------------------------------
/** returns, whether the title columns are repeated on all subsequent
print pages to the right.
*/
boolean getPrintTitleColumns();
//-------------------------------------------------------------------------
/** specifies whether the title columns are repeated on all subsequent
print pages to the right.
@param bPrintTitleColumns
if <TRUE/>, title columns are repeated on each page.
*/
void setPrintTitleColumns( [in] boolean bPrintTitleColumns );
//-------------------------------------------------------------------------
/** returns the range that is specified as title columns range.
<p>Title columns can be automatically repeated on all subsequent
print pages to the right, using
<member>XPrintAreas::setPrintTitleColumns</member>.</p>
@returns
the range of columns that is specified as title columns range.
*/
com::sun::star::table::CellRangeAddress getTitleColumns();
//-------------------------------------------------------------------------
/** specifies a range of columns as title columns range.
<p>The rows of the passed range are ignored.</p>
<p>Title columns can be automatically repeated on all subsequent
print pages to the right, using
<member>XPrintAreas::setPrintTitleColumns</member>.</p>
@param aTitleColumns
the title columns range.
*/
void setTitleColumns( [in] com::sun::star::table::CellRangeAddress aTitleColumns );
//-------------------------------------------------------------------------
/** returns, whether the title rows are repeated on all subsequent
print pages to the bottom.
*/
boolean getPrintTitleRows();
//-------------------------------------------------------------------------
/** specifies whether the title rows are repeated on all subsequent
print pages to the bottom.
@param bPrintTitleRows
if <TRUE/>, title rows are repeated on each page.
*/
void setPrintTitleRows( [in] boolean bPrintTitleRows );
//-------------------------------------------------------------------------
/** returns the range that is specified as title rows range.
<p>Title rows can be automatically repeated on all subsequent
print pages to the bootom, using
<member>XPrintAreas::setPrintTitleRows</member>.</p>
@returns
the range of rows that is specified as title rows range.
*/
com::sun::star::table::CellRangeAddress getTitleRows();
//-------------------------------------------------------------------------
/** specifies a range of rows as title rows range.
<p>The columns of the passed range are ignored.</p>
<p>Title rows can be automatically repeated on all subsequent
print pages to the bottom, using
<member>XPrintAreas::setPrintTitleRows</member>.</p>
@param aTitleRows
the title rows range.
*/
void setTitleRows( [in] com::sun::star::table::CellRangeAddress aTitleRows );
};
//=============================================================================
}; }; }; };
#endif