/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSheetPageBreak.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:21:23 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/

#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

