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

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