offapi/com/sun/star/sheet/XSheetPageBreak.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSheetPageBreak.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XSheetPageBreak_idl__
  32 #define __com_sun_star_sheet_XSheetPageBreak_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_TablePageBreakData_idl__
  39 #include <com/sun/star/sheet/TablePageBreakData.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides access to page breaks in a sheet.
  49
  50     @deprecated
  51  */
  52 published interface XSheetPageBreak: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** returns a sequence of descriptions of all horizontal page breaks
  57         on the sheet.
  58
  59         <P>This includes manual and automatic page breaks. To add or
  60         remove manual breaks, use the
  61         <member scope="com::sun::star::table">TableColumn::IsStartOfNewPage</member>
  62         property of the column.</P>
  63
  64         @returns
  65             a sequence of structs containing column page break data.
  66      */
  67     sequence< com::sun::star::sheet::TablePageBreakData > getColumnPageBreaks();
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** returns a sequence of descriptions of all vertical page breaks
  72         on the sheet.
  73
  74         <P>This includes manual and automatic page breaks. To add or
  75         remove manual breaks, use the
  76         <member scope="com::sun::star::table">TableRow::IsStartOfNewPage</member>
  77         property of the row.</P>
  78
  79         @returns
  80             a sequence of structs containing row page break data.
  81      */
  82     sequence< com::sun::star::sheet::TablePageBreakData > getRowPageBreaks();
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** removes all manual page breaks on the sheet.
  87      */
  88     void removeAllManualPageBreaks();
  89
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif
  97