xref: /aoo41x/main/offapi/com/sun/star/sheet/XSheetPageBreak.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_XSheetPageBreak_idl__
#define __com_sun_star_sheet_XSheetPageBreak_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sheet_TablePageBreakData_idl__
#include <com/sun/star/sheet/TablePageBreakData.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides access to page breaks in a sheet.

	@deprecated
 */
published interface XSheetPageBreak: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** returns a sequence of descriptions of all horizontal page breaks
		on the sheet.

		<P>This includes manual and automatic page breaks. To add or
		remove manual breaks, use the
		<member scope="com::sun::star::table">TableColumn::IsStartOfNewPage</member>
		property of the column.</P>

		@returns
			a sequence of structs containing column page break data.
	 */
	sequence< com::sun::star::sheet::TablePageBreakData > getColumnPageBreaks();

	//-------------------------------------------------------------------------

	/** returns a sequence of descriptions of all vertical page breaks
		on the sheet.

		<P>This includes manual and automatic page breaks. To add or
		remove manual breaks, use the
		<member scope="com::sun::star::table">TableRow::IsStartOfNewPage</member>
		property of the row.</P>

		@returns
			a sequence of structs containing row page break data.
	 */
	sequence< com::sun::star::sheet::TablePageBreakData > getRowPageBreaks();

	//-------------------------------------------------------------------------

	/** removes all manual page breaks on the sheet.
	 */
	void removeAllManualPageBreaks();

};

//=============================================================================

}; }; }; };

#endif