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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** provides access to page breaks in a sheet.
  25
  26     @deprecated
  27  */
  28 published interface XSheetPageBreak: com::sun::star::uno::XInterface
  29 {
  30
  31     /** returns a sequence of descriptions of all horizontal page breaks
  32         on the sheet.
  33
  34         <P>This includes manual and automatic page breaks. To add or
  35         remove manual breaks, use the
  36         com::sun::star::table::TableColumn::IsStartOfNewPage
  37         property of the column.</P>
  38
  39         @returns
  40             a sequence of structs containing column page break data.
  41      */
  42     sequence< com::sun::star::sheet::TablePageBreakData > getColumnPageBreaks();
  43
  44
  45     /** returns a sequence of descriptions of all vertical page breaks
  46         on the sheet.
  47
  48         <P>This includes manual and automatic page breaks. To add or
  49         remove manual breaks, use the
  50         com::sun::star::table::TableRow::IsStartOfNewPage
  51         property of the row.</P>
  52
  53         @returns
  54             a sequence of structs containing row page break data.
  55      */
  56     sequence< com::sun::star::sheet::TablePageBreakData > getRowPageBreaks();
  57
  58
  59     /** removes all manual page breaks on the sheet.
  60      */
  61     void removeAllManualPageBreaks();
  62
  63 };
  64
  65
  66 }; }; }; };
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */