xref: /AOO41X/main/offapi/com/sun/star/sheet/XSheetPageBreak.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XSheetPageBreak_idl__
25#define __com_sun_star_sheet_XSheetPageBreak_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_TablePageBreakData_idl__
32#include <com/sun/star/sheet/TablePageBreakData.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides access to page breaks in a sheet.
42
43    @deprecated
44 */
45published interface XSheetPageBreak: com::sun::star::uno::XInterface
46{
47    //-------------------------------------------------------------------------
48
49    /** returns a sequence of descriptions of all horizontal page breaks
50        on the sheet.
51
52        <P>This includes manual and automatic page breaks. To add or
53        remove manual breaks, use the
54        <member scope="com::sun::star::table">TableColumn::IsStartOfNewPage</member>
55        property of the column.</P>
56
57        @returns
58            a sequence of structs containing column page break data.
59     */
60    sequence< com::sun::star::sheet::TablePageBreakData > getColumnPageBreaks();
61
62    //-------------------------------------------------------------------------
63
64    /** returns a sequence of descriptions of all vertical page breaks
65        on the sheet.
66
67        <P>This includes manual and automatic page breaks. To add or
68        remove manual breaks, use the
69        <member scope="com::sun::star::table">TableRow::IsStartOfNewPage</member>
70        property of the row.</P>
71
72        @returns
73            a sequence of structs containing row page break data.
74     */
75    sequence< com::sun::star::sheet::TablePageBreakData > getRowPageBreaks();
76
77    //-------------------------------------------------------------------------
78
79    /** removes all manual page breaks on the sheet.
80     */
81    void removeAllManualPageBreaks();
82
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90
91