xref: /aoo41x/main/offapi/com/sun/star/sheet/XPrintAreas.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#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