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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XSheetPageBreak_idl__
  21 #define __com_sun_star_sheet_XSheetPageBreak_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/TablePageBreakData.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides access to page breaks in a sheet.
  31
  32     @deprecated
  33  */
  34 published interface XSheetPageBreak: com::sun::star::uno::XInterface
  35 {
  36
  37     /** returns a sequence of descriptions of all horizontal page breaks
  38         on the sheet.
  39
  40         <P>This includes manual and automatic page breaks. To add or
  41         remove manual breaks, use the
  42         com::sun::star::table::TableColumn::IsStartOfNewPage
  43         property of the column.</P>
  44
  45         @returns
  46             a sequence of structs containing column page break data.
  47      */
  48     sequence< com::sun::star::sheet::TablePageBreakData > getColumnPageBreaks();
  49
  50
  51     /** returns a sequence of descriptions of all vertical page breaks
  52         on the sheet.
  53
  54         <P>This includes manual and automatic page breaks. To add or
  55         remove manual breaks, use the
  56         com::sun::star::table::TableRow::IsStartOfNewPage
  57         property of the row.</P>
  58
  59         @returns
  60             a sequence of structs containing row page break data.
  61      */
  62     sequence< com::sun::star::sheet::TablePageBreakData > getRowPageBreaks();
  63
  64
  65     /** removes all manual page breaks on the sheet.
  66      */
  67     void removeAllManualPageBreaks();
  68
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */